6d1802b6b4097132eab3bf02ad29c7f33b197d1c
[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.75"
49 .set version "4.77"
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>06 May 2011</date>
174 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
175 <authorinitials>EM</authorinitials>
176 <revhistory><revision>
177   <revnumber>4.77</revnumber>
178   <date>10 Oct 2011</date>
179   <authorinitials>EM</authorinitials>
180 </revision></revhistory>
181 <copyright><year>2011</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 .new
1651 .section "PCRE library" "SECTpcre"
1652 .cindex "PCRE library"
1653 Exim no longer has an embedded PCRE library as the vast majority of
1654 modern systems include PCRE as a system library, although you may need
1655 to install the PCRE or PCRE development package for your operating
1656 system. If your system has a normal PCRE installation the Exim build
1657 process will need no further configuration. If the library or the
1658 headers are in an unusual location you will need to either set the PCRE_LIBS
1659 and INCLUDE directives appropriately,
1660 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1661 If your operating system has no
1662 PCRE support then you will need to obtain and build the current PCRE
1663 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1664 More information on PCRE is available at &url(http://www.pcre.org/).
1665 .wen
1666
1667 .section "DBM libraries" "SECTdb"
1668 .cindex "DBM libraries" "discussion of"
1669 .cindex "hints database" "DBM files used for"
1670 Even if you do not use any DBM files in your configuration, Exim still needs a
1671 DBM library in order to operate, because it uses indexed files for its hints
1672 databases. Unfortunately, there are a number of DBM libraries in existence, and
1673 different operating systems often have different ones installed.
1674
1675 .cindex "Solaris" "DBM library for"
1676 .cindex "IRIX, DBM library for"
1677 .cindex "BSD, DBM library for"
1678 .cindex "Linux, DBM library for"
1679 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1680 Linux distribution, the DBM configuration should happen automatically, and you
1681 may be able to ignore this section. Otherwise, you may have to learn more than
1682 you would like about DBM libraries from what follows.
1683
1684 .cindex "&'ndbm'& DBM library"
1685 Licensed versions of Unix normally contain a library of DBM functions operating
1686 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1687 versions of Unix seem to vary in what they contain as standard. In particular,
1688 some early versions of Linux have no default DBM library, and different
1689 distributors have chosen to bundle different libraries with their packaged
1690 versions. However, the more recent releases seem to have standardized on the
1691 Berkeley DB library.
1692
1693 Different DBM libraries have different conventions for naming the files they
1694 use. When a program opens a file called &_dbmfile_&, there are several
1695 possibilities:
1696
1697 .olist
1698 A traditional &'ndbm'& implementation, such as that supplied as part of
1699 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1700 .next
1701 .cindex "&'gdbm'& DBM library"
1702 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1703 compatibility interface it makes two different hard links to it with names
1704 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1705 file name is used unmodified.
1706 .next
1707 .cindex "Berkeley DB library"
1708 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1709 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1710 programmer exactly the same as the traditional &'ndbm'& implementation.
1711 .next
1712 If the Berkeley package is used in its native mode, it operates on a single
1713 file called &_dbmfile_&; the programmer's interface is somewhat different to
1714 the traditional &'ndbm'& interface.
1715 .next
1716 To complicate things further, there are several very different versions of the
1717 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1718 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1719 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1720 versions of Berkeley DB can be obtained from
1721 &url(http://www.sleepycat.com/).
1722 .next
1723 .cindex "&'tdb'& DBM library"
1724 Yet another DBM library, called &'tdb'&, is available from
1725 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1726 operates on a single file.
1727 .endlist
1728
1729 .cindex "USE_DB"
1730 .cindex "DBM libraries" "configuration for building"
1731 Exim and its utilities can be compiled to use any of these interfaces. In order
1732 to use any version of the Berkeley DB package in native mode, you must set
1733 USE_DB in an appropriate configuration file (typically
1734 &_Local/Makefile_&). For example:
1735 .code
1736 USE_DB=yes
1737 .endd
1738 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1739 error is diagnosed if you set more than one of these.
1740
1741 At the lowest level, the build-time configuration sets none of these options,
1742 thereby assuming an interface of type (1). However, some operating system
1743 configuration files (for example, those for the BSD operating systems and
1744 Linux) assume type (4) by setting USE_DB as their default, and the
1745 configuration files for Cygwin set USE_GDBM. Anything you set in
1746 &_Local/Makefile_&, however, overrides these system defaults.
1747
1748 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1749 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1750 in one of these lines:
1751 .code
1752 DBMLIB = -ldb
1753 DBMLIB = -ltdb
1754 .endd
1755 Settings like that will work if the DBM library is installed in the standard
1756 place. Sometimes it is not, and the library's header file may also not be in
1757 the default path. You may need to set INCLUDE to specify where the header
1758 file is, and to specify the path to the library more fully in DBMLIB, as in
1759 this example:
1760 .code
1761 INCLUDE=-I/usr/local/include/db-4.1
1762 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1763 .endd
1764 There is further detailed discussion about the various DBM libraries in the
1765 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1766
1767
1768
1769 .section "Pre-building configuration" "SECID25"
1770 .cindex "building Exim" "pre-building configuration"
1771 .cindex "configuration for building Exim"
1772 .cindex "&_Local/Makefile_&"
1773 .cindex "&_src/EDITME_&"
1774 Before building Exim, a local configuration file that specifies options
1775 independent of any operating system has to be created with the name
1776 &_Local/Makefile_&. A template for this file is supplied as the file
1777 &_src/EDITME_&, and it contains full descriptions of all the option settings
1778 therein. These descriptions are therefore not repeated here. If you are
1779 building Exim for the first time, the simplest thing to do is to copy
1780 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1781
1782 There are three settings that you must supply, because Exim will not build
1783 without them. They are the location of the run time configuration file
1784 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1785 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1786 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1787 a colon-separated list of file names; Exim uses the first of them that exists.
1788
1789 There are a few other parameters that can be specified either at build time or
1790 at run time, to enable the same binary to be used on a number of different
1791 machines. However, if the locations of Exim's spool directory and log file
1792 directory (if not within the spool directory) are fixed, it is recommended that
1793 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1794 detected early in Exim's execution (such as a malformed configuration file) can
1795 be logged.
1796
1797 .cindex "content scanning" "specifying at build time"
1798 Exim's interfaces for calling virus and spam scanning software directly from
1799 access control lists are not compiled by default. If you want to include these
1800 facilities, you need to set
1801 .code
1802 WITH_CONTENT_SCAN=yes
1803 .endd
1804 in your &_Local/Makefile_&. For details of the facilities themselves, see
1805 chapter &<<CHAPexiscan>>&.
1806
1807
1808 .cindex "&_Local/eximon.conf_&"
1809 .cindex "&_exim_monitor/EDITME_&"
1810 If you are going to build the Exim monitor, a similar configuration process is
1811 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1812 your installation and saved under the name &_Local/eximon.conf_&. If you are
1813 happy with the default settings described in &_exim_monitor/EDITME_&,
1814 &_Local/eximon.conf_& can be empty, but it must exist.
1815
1816 This is all the configuration that is needed in straightforward cases for known
1817 operating systems. However, the building process is set up so that it is easy
1818 to override options that are set by default or by operating-system-specific
1819 configuration files, for example to change the name of the C compiler, which
1820 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1821 do this.
1822
1823
1824
1825 .section "Support for iconv()" "SECID26"
1826 .cindex "&[iconv()]& support"
1827 .cindex "RFC 2047"
1828 The contents of header lines in messages may be encoded according to the rules
1829 described RFC 2047. This makes it possible to transmit characters that are not
1830 in the ASCII character set, and to label them as being in a particular
1831 character set. When Exim is inspecting header lines by means of the &%$h_%&
1832 mechanism, it decodes them, and translates them into a specified character set
1833 (default ISO-8859-1). The translation is possible only if the operating system
1834 supports the &[iconv()]& function.
1835
1836 However, some of the operating systems that supply &[iconv()]& do not support
1837 very many conversions. The GNU &%libiconv%& library (available from
1838 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1839 systems to remedy this deficiency, as well as on systems that do not supply
1840 &[iconv()]& at all. After installing &%libiconv%&, you should add
1841 .code
1842 HAVE_ICONV=yes
1843 .endd
1844 to your &_Local/Makefile_& and rebuild Exim.
1845
1846
1847
1848 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1849 .cindex "TLS" "including support for TLS"
1850 .cindex "encryption" "including support for"
1851 .cindex "SUPPORT_TLS"
1852 .cindex "OpenSSL" "building Exim with"
1853 .cindex "GnuTLS" "building Exim with"
1854 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1855 command as per RFC 2487. It can also support legacy clients that expect to
1856 start a TLS session immediately on connection to a non-standard port (see the
1857 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1858 line option).
1859
1860 If you want to build Exim with TLS support, you must first install either the
1861 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1862 implementing SSL.
1863
1864 If OpenSSL is installed, you should set
1865 .code
1866 SUPPORT_TLS=yes
1867 TLS_LIBS=-lssl -lcrypto
1868 .endd
1869 in &_Local/Makefile_&. You may also need to specify the locations of the
1870 OpenSSL library and include files. For example:
1871 .code
1872 SUPPORT_TLS=yes
1873 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1874 TLS_INCLUDE=-I/usr/local/openssl/include/
1875 .endd
1876 .new
1877 .cindex "pkg-config" "OpenSSL"
1878 If you have &'pkg-config'& available, then instead you can just use:
1879 .code
1880 SUPPORT_TLS=yes
1881 USE_OPENSSL_PC=openssl
1882 .endd
1883 .wen
1884 .cindex "USE_GNUTLS"
1885 If GnuTLS is installed, you should set
1886 .code
1887 SUPPORT_TLS=yes
1888 USE_GNUTLS=yes
1889 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1890 .endd
1891 in &_Local/Makefile_&, and again you may need to specify the locations of the
1892 library and include files. For example:
1893 .code
1894 SUPPORT_TLS=yes
1895 USE_GNUTLS=yes
1896 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1897 TLS_INCLUDE=-I/usr/gnu/include
1898 .endd
1899 .new
1900 .cindex "pkg-config" "GnuTLS"
1901 If you have &'pkg-config'& available, then instead you can just use:
1902 .code
1903 SUPPORT_TLS=yes
1904 USE_GNUTLS=yes
1905 USE_GNUTLS_PC=gnutls
1906 .endd
1907 .wen
1908
1909 You do not need to set TLS_INCLUDE if the relevant directory is already
1910 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1911 given in chapter &<<CHAPTLS>>&.
1912
1913
1914
1915
1916 .section "Use of tcpwrappers" "SECID27"
1917
1918 .cindex "tcpwrappers, building Exim to support"
1919 .cindex "USE_TCP_WRAPPERS"
1920 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1921 .cindex "tcp_wrappers_daemon_name"
1922 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1923 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1924 alternative to Exim's own checking facilities for installations that are
1925 already making use of &'tcpwrappers'& for other purposes. To do this, you
1926 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1927 &_tcpd.h_& to be available at compile time, and also ensure that the library
1928 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1929 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1930 you might have
1931 .code
1932 USE_TCP_WRAPPERS=yes
1933 CFLAGS=-O -I/usr/local/include
1934 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1935 .endd
1936 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1937 files is &"exim"&. For example, the line
1938 .code
1939 exim : LOCAL  192.168.1.  .friendly.domain.example
1940 .endd
1941 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1942 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1943 All other connections are denied. The daemon name used by &'tcpwrappers'&
1944 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1945 in &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1946 configure file. Consult the &'tcpwrappers'& documentation for
1947 further details.
1948
1949
1950 .section "Including support for IPv6" "SECID28"
1951 .cindex "IPv6" "including support for"
1952 Exim contains code for use on systems that have IPv6 support. Setting
1953 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1954 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1955 where the IPv6 support is not fully integrated into the normal include and
1956 library files.
1957
1958 Two different types of DNS record for handling IPv6 addresses have been
1959 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1960 currently seen as the mainstream. Another record type called A6 was proposed
1961 as better than AAAA because it had more flexibility. However, it was felt to be
1962 over-complex, and its status was reduced to &"experimental"&. It is not known
1963 if anyone is actually using A6 records. Exim has support for A6 records, but
1964 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1965 support has not been tested for some time.
1966
1967
1968
1969 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1970 .cindex "lookup modules"
1971 .cindex "dynamic modules"
1972 .cindex ".so building"
1973 On some platforms, Exim supports not compiling all lookup types directly into
1974 the main binary, instead putting some into external modules which can be loaded
1975 on demand.
1976 This permits packagers to build Exim with support for lookups with extensive
1977 library dependencies without requiring all users to install all of those
1978 dependencies.
1979 Most, but not all, lookup types can be built this way.
1980
1981 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
1982 installed; Exim will only load modules from that directory, as a security
1983 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
1984 for your OS; see &_OS/Makefile-Linux_& for an example.
1985 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
1986 see &_src/EDITME_& for details.
1987
1988 Then, for each module to be loaded dynamically, define the relevant
1989 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
1990 For example, this will build in lsearch but load sqlite and mysql support
1991 on demand:
1992 .code
1993 LOOKUP_LSEARCH=yes
1994 LOOKUP_SQLITE=2
1995 LOOKUP_MYSQL=2
1996 .endd
1997
1998
1999 .section "The building process" "SECID29"
2000 .cindex "build directory"
2001 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2002 created, run &'make'& at the top level. It determines the architecture and
2003 operating system types, and creates a build directory if one does not exist.
2004 For example, on a Sun system running Solaris 8, the directory
2005 &_build-SunOS5-5.8-sparc_& is created.
2006 .cindex "symbolic link" "to source files"
2007 Symbolic links to relevant source files are installed in the build directory.
2008
2009 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2010 building process fails if it is set.
2011
2012 If this is the first time &'make'& has been run, it calls a script that builds
2013 a make file inside the build directory, using the configuration files from the
2014 &_Local_& directory. The new make file is then passed to another instance of
2015 &'make'&. This does the real work, building a number of utility scripts, and
2016 then compiling and linking the binaries for the Exim monitor (if configured), a
2017 number of utility programs, and finally Exim itself. The command &`make
2018 makefile`& can be used to force a rebuild of the make file in the build
2019 directory, should this ever be necessary.
2020
2021 If you have problems building Exim, check for any comments there may be in the
2022 &_README_& file concerning your operating system, and also take a look at the
2023 FAQ, where some common problems are covered.
2024
2025
2026
2027 .section 'Output from &"make"&' "SECID283"
2028 The output produced by the &'make'& process for compile lines is often very
2029 unreadable, because these lines can be very long. For this reason, the normal
2030 output is suppressed by default, and instead output similar to that which
2031 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2032 each module that is being compiled or linked. However, it is still possible to
2033 get the full output, by calling &'make'& like this:
2034 .code
2035 FULLECHO='' make -e
2036 .endd
2037 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2038 command reflection in &'make'&. When you ask for the full output, it is
2039 given in addition to the short output.
2040
2041
2042
2043 .section "Overriding build-time options for Exim" "SECToverride"
2044 .cindex "build-time options, overriding"
2045 The main make file that is created at the beginning of the building process
2046 consists of the concatenation of a number of files which set configuration
2047 values, followed by a fixed set of &'make'& instructions. If a value is set
2048 more than once, the last setting overrides any previous ones. This provides a
2049 convenient way of overriding defaults. The files that are concatenated are, in
2050 order:
2051 .display
2052 &_OS/Makefile-Default_&
2053 &_OS/Makefile-_&<&'ostype'&>
2054 &_Local/Makefile_&
2055 &_Local/Makefile-_&<&'ostype'&>
2056 &_Local/Makefile-_&<&'archtype'&>
2057 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2058 &_OS/Makefile-Base_&
2059 .endd
2060 .cindex "&_Local/Makefile_&"
2061 .cindex "building Exim" "operating system type"
2062 .cindex "building Exim" "architecture type"
2063 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2064 architecture type. &_Local/Makefile_& is required to exist, and the building
2065 process fails if it is absent. The other three &_Local_& files are optional,
2066 and are often not needed.
2067
2068 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2069 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2070 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2071 values are used, thereby providing a means of forcing particular settings.
2072 Otherwise, the scripts try to get values from the &%uname%& command. If this
2073 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2074 of &'ad hoc'& transformations are then applied, to produce the standard names
2075 that Exim expects. You can run these scripts directly from the shell in order
2076 to find out what values are being used on your system.
2077
2078
2079 &_OS/Makefile-Default_& contains comments about the variables that are set
2080 therein. Some (but not all) are mentioned below. If there is something that
2081 needs changing, review the contents of this file and the contents of the make
2082 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2083 default values are.
2084
2085
2086 .cindex "building Exim" "overriding default settings"
2087 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2088 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2089 need to change the original files. Instead, you should make the changes by
2090 putting the new values in an appropriate &_Local_& file. For example,
2091 .cindex "Tru64-Unix build-time settings"
2092 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2093 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2094 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2095 called with the option &%-std1%&, to make it recognize some of the features of
2096 Standard C that Exim uses. (Most other compilers recognize Standard C by
2097 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2098 containing the lines
2099 .code
2100 CC=cc
2101 CFLAGS=-std1
2102 .endd
2103 If you are compiling for just one operating system, it may be easier to put
2104 these lines directly into &_Local/Makefile_&.
2105
2106 Keeping all your local configuration settings separate from the distributed
2107 files makes it easy to transfer them to new versions of Exim simply by copying
2108 the contents of the &_Local_& directory.
2109
2110
2111 .cindex "NIS lookup type" "including support for"
2112 .cindex "NIS+ lookup type" "including support for"
2113 .cindex "LDAP" "including support for"
2114 .cindex "lookup" "inclusion in binary"
2115 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2116 lookup, but not all systems have these components installed, so the default is
2117 not to include the relevant code in the binary. All the different kinds of file
2118 and database lookup that Exim supports are implemented as separate code modules
2119 which are included only if the relevant compile-time options are set. In the
2120 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2121 .code
2122 LOOKUP_LDAP=yes
2123 LOOKUP_NIS=yes
2124 LOOKUP_NISPLUS=yes
2125 .endd
2126 and similar settings apply to the other lookup types. They are all listed in
2127 &_src/EDITME_&. In many cases the relevant include files and interface
2128 libraries need to be installed before compiling Exim.
2129 .cindex "cdb" "including support for"
2130 However, there are some optional lookup types (such as cdb) for which
2131 the code is entirely contained within Exim, and no external include
2132 files or libraries are required. When a lookup type is not included in the
2133 binary, attempts to configure Exim to use it cause run time configuration
2134 errors.
2135
2136 .new
2137 .cindex "pkg-config" "lookups"
2138 .cindex "pkg-config" "authenticators"
2139 Many systems now use a tool called &'pkg-config'& to encapsulate information
2140 about how to compile against a library; Exim has some initial support for
2141 being able to use pkg-config for lookups and authenticators.  For any given
2142 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2143 variable with the &`_PC`& suffix in the name and assign as the value the
2144 name of the package to be queried.  The results of querying via the
2145 &'pkg-config'& command will be added to the appropriate Makefile variables
2146 with &`+=`& directives, so your version of &'make'& will need to support that
2147 syntax.  For instance:
2148 .code
2149 LOOKUP_SQLITE=yes
2150 LOOKUP_SQLITE_PC=sqlite3
2151 AUTH_GSASL=yes
2152 AUTH_GSASL_PC=libgsasl
2153 AUTH_HEIMDAL_GSSAPI=yes
2154 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2155 .endd
2156 .wen
2157
2158 .cindex "Perl" "including support for"
2159 Exim can be linked with an embedded Perl interpreter, allowing Perl
2160 subroutines to be called during string expansion. To enable this facility,
2161 .code
2162 EXIM_PERL=perl.o
2163 .endd
2164 must be defined in &_Local/Makefile_&. Details of this facility are given in
2165 chapter &<<CHAPperl>>&.
2166
2167 .cindex "X11 libraries, location of"
2168 The location of the X11 libraries is something that varies a lot between
2169 operating systems, and there may be different versions of X11 to cope
2170 with. Exim itself makes no use of X11, but if you are compiling the Exim
2171 monitor, the X11 libraries must be available.
2172 The following three variables are set in &_OS/Makefile-Default_&:
2173 .code
2174 X11=/usr/X11R6
2175 XINCLUDE=-I$(X11)/include
2176 XLFLAGS=-L$(X11)/lib
2177 .endd
2178 These are overridden in some of the operating-system configuration files. For
2179 example, in &_OS/Makefile-SunOS5_& there is
2180 .code
2181 X11=/usr/openwin
2182 XINCLUDE=-I$(X11)/include
2183 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2184 .endd
2185 If you need to override the default setting for your operating system, place a
2186 definition of all three of these variables into your
2187 &_Local/Makefile-<ostype>_& file.
2188
2189 .cindex "EXTRALIBS"
2190 If you need to add any extra libraries to the link steps, these can be put in a
2191 variable called EXTRALIBS, which appears in all the link commands, but by
2192 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2193 command for linking the main Exim binary, and not for any associated utilities.
2194
2195 .cindex "DBM libraries" "configuration for building"
2196 There is also DBMLIB, which appears in the link commands for binaries that
2197 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2198 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2199 binary, and which can be used, for example, to include additional X11
2200 libraries.
2201
2202 .cindex "configuration file" "editing"
2203 The make file copes with rebuilding Exim correctly if any of the configuration
2204 files are edited. However, if an optional configuration file is deleted, it is
2205 necessary to touch the associated non-optional file (that is,
2206 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2207
2208
2209 .section "OS-specific header files" "SECID30"
2210 .cindex "&_os.h_&"
2211 .cindex "building Exim" "OS-specific C header files"
2212 The &_OS_& directory contains a number of files with names of the form
2213 &_os.h-<ostype>_&. These are system-specific C header files that should not
2214 normally need to be changed. There is a list of macro settings that are
2215 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2216 are porting Exim to a new operating system.
2217
2218
2219
2220 .section "Overriding build-time options for the monitor" "SECID31"
2221 .cindex "building Eximon"
2222 A similar process is used for overriding things when building the Exim monitor,
2223 where the files that are involved are
2224 .display
2225 &_OS/eximon.conf-Default_&
2226 &_OS/eximon.conf-_&<&'ostype'&>
2227 &_Local/eximon.conf_&
2228 &_Local/eximon.conf-_&<&'ostype'&>
2229 &_Local/eximon.conf-_&<&'archtype'&>
2230 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2231 .endd
2232 .cindex "&_Local/eximon.conf_&"
2233 As with Exim itself, the final three files need not exist, and in this case the
2234 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2235 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2236 variables of the same name, preceded by EXIMON_. For example, setting
2237 EXIMON_LOG_DEPTH in the environment overrides the value of
2238 LOG_DEPTH at run time.
2239 .ecindex IIDbuex
2240
2241
2242 .section "Installing Exim binaries and scripts" "SECID32"
2243 .cindex "installing Exim"
2244 .cindex "BIN_DIRECTORY"
2245 The command &`make install`& runs the &(exim_install)& script with no
2246 arguments. The script copies binaries and utility scripts into the directory
2247 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2248 .cindex "setuid" "installing Exim with"
2249 The install script copies files only if they are newer than the files they are
2250 going to replace. The Exim binary is required to be owned by root and have the
2251 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2252 install`& as root so that it can set up the Exim binary in this way. However, in
2253 some special situations (for example, if a host is doing no local deliveries)
2254 it may be possible to run Exim without making the binary setuid root (see
2255 chapter &<<CHAPsecurity>>& for details).
2256
2257 .cindex "CONFIGURE_FILE"
2258 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2259 in &_Local/Makefile_&. If this names a single file, and the file does not
2260 exist, the default configuration file &_src/configure.default_& is copied there
2261 by the installation script. If a run time configuration file already exists, it
2262 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2263 alternative files, no default is installed.
2264
2265 .cindex "system aliases file"
2266 .cindex "&_/etc/aliases_&"
2267 One change is made to the default configuration file when it is installed: the
2268 default configuration contains a router that references a system aliases file.
2269 The path to this file is set to the value specified by
2270 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2271 If the system aliases file does not exist, the installation script creates it,
2272 and outputs a comment to the user.
2273
2274 The created file contains no aliases, but it does contain comments about the
2275 aliases a site should normally have. Mail aliases have traditionally been
2276 kept in &_/etc/aliases_&. However, some operating systems are now using
2277 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2278 Exim's configuration if necessary.
2279
2280 The default configuration uses the local host's name as the only local domain,
2281 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2282 running as the local user. System aliases and &_.forward_& files in users' home
2283 directories are supported, but no NIS or NIS+ support is configured. Domains
2284 other than the name of the local host are routed using the DNS, with delivery
2285 over SMTP.
2286
2287 It is possible to install Exim for special purposes (such as building a binary
2288 distribution) in a private part of the file system. You can do this by a
2289 command such as
2290 .code
2291 make DESTDIR=/some/directory/ install
2292 .endd
2293 This has the effect of pre-pending the specified directory to all the file
2294 paths, except the name of the system aliases file that appears in the default
2295 configuration. (If a default alias file is created, its name &'is'& modified.)
2296 For backwards compatibility, ROOT is used if DESTDIR is not set,
2297 but this usage is deprecated.
2298
2299 .cindex "installing Exim" "what is not installed"
2300 Running &'make install'& does not copy the Exim 4 conversion script
2301 &'convert4r4'&. You will probably run this only once if you are
2302 upgrading from Exim 3. None of the documentation files in the &_doc_&
2303 directory are copied, except for the info files when you have set
2304 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2305
2306 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2307 to their names. The Exim binary itself, however, is handled differently. It is
2308 installed under a name that includes the version number and the compile number,
2309 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2310 called &_exim_& to point to the binary. If you are updating a previous version
2311 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2312 from the directory (as seen by other processes).
2313
2314 .cindex "installing Exim" "testing the script"
2315 If you want to see what the &'make install'& will do before running it for
2316 real, you can pass the &%-n%& option to the installation script by this
2317 command:
2318 .code
2319 make INSTALL_ARG=-n install
2320 .endd
2321 The contents of the variable INSTALL_ARG are passed to the installation
2322 script. You do not need to be root to run this test. Alternatively, you can run
2323 the installation script directly, but this must be from within the build
2324 directory. For example, from the top-level Exim directory you could use this
2325 command:
2326 .code
2327 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2328 .endd
2329 .cindex "installing Exim" "install script options"
2330 There are two other options that can be supplied to the installation script.
2331
2332 .ilist
2333 &%-no_chown%& bypasses the call to change the owner of the installed binary
2334 to root, and the call to make it a setuid binary.
2335 .next
2336 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2337 installed binary.
2338 .endlist
2339
2340 INSTALL_ARG can be used to pass these options to the script. For example:
2341 .code
2342 make INSTALL_ARG=-no_symlink install
2343 .endd
2344 The installation script can also be given arguments specifying which files are
2345 to be copied. For example, to install just the Exim binary, and nothing else,
2346 without creating the symbolic link, you could use:
2347 .code
2348 make INSTALL_ARG='-no_symlink exim' install
2349 .endd
2350
2351
2352
2353 .section "Installing info documentation" "SECTinsinfdoc"
2354 .cindex "installing Exim" "&'info'& documentation"
2355 Not all systems use the GNU &'info'& system for documentation, and for this
2356 reason, the Texinfo source of Exim's documentation is not included in the main
2357 distribution. Instead it is available separately from the ftp site (see section
2358 &<<SECTavail>>&).
2359
2360 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2361 source of the documentation is found in the source tree, running &`make
2362 install`& automatically builds the info files and installs them.
2363
2364
2365
2366 .section "Setting up the spool directory" "SECID33"
2367 .cindex "spool directory" "creating"
2368 When it starts up, Exim tries to create its spool directory if it does not
2369 exist. The Exim uid and gid are used for the owner and group of the spool
2370 directory. Sub-directories are automatically created in the spool directory as
2371 necessary.
2372
2373
2374
2375
2376 .section "Testing" "SECID34"
2377 .cindex "testing" "installation"
2378 Having installed Exim, you can check that the run time configuration file is
2379 syntactically valid by running the following command, which assumes that the
2380 Exim binary directory is within your PATH environment variable:
2381 .code
2382 exim -bV
2383 .endd
2384 If there are any errors in the configuration file, Exim outputs error messages.
2385 Otherwise it outputs the version number and build date,
2386 the DBM library that is being used, and information about which drivers and
2387 other optional code modules are included in the binary.
2388 Some simple routing tests can be done by using the address testing option. For
2389 example,
2390 .display
2391 &`exim -bt`& <&'local username'&>
2392 .endd
2393 should verify that it recognizes a local mailbox, and
2394 .display
2395 &`exim -bt`& <&'remote address'&>
2396 .endd
2397 a remote one. Then try getting it to deliver mail, both locally and remotely.
2398 This can be done by passing messages directly to Exim, without going through a
2399 user agent. For example:
2400 .code
2401 exim -v postmaster@your.domain.example
2402 From: user@your.domain.example
2403 To: postmaster@your.domain.example
2404 Subject: Testing Exim
2405
2406 This is a test message.
2407 ^D
2408 .endd
2409 The &%-v%& option causes Exim to output some verification of what it is doing.
2410 In this case you should see copies of three log lines, one for the message's
2411 arrival, one for its delivery, and one containing &"Completed"&.
2412
2413 .cindex "delivery" "problems with"
2414 If you encounter problems, look at Exim's log files (&'mainlog'& and
2415 &'paniclog'&) to see if there is any relevant information there. Another source
2416 of information is running Exim with debugging turned on, by specifying the
2417 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2418 with debugging turned on by a command of the form
2419 .display
2420 &`exim -d -M`& <&'exim-message-id'&>
2421 .endd
2422 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2423 produces rather a lot of output, but you can cut this down to specific areas.
2424 For example, if you use &%-d-all+route%& only the debugging information
2425 relevant to routing is included. (See the &%-d%& option in chapter
2426 &<<CHAPcommandline>>& for more details.)
2427
2428 .cindex '&"sticky"& bit'
2429 .cindex "lock files"
2430 One specific problem that has shown up on some sites is the inability to do
2431 local deliveries into a shared mailbox directory, because it does not have the
2432 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2433 writing to a mailbox file, and if it cannot create the lock file, the delivery
2434 is deferred. You can get round this either by setting the &"sticky bit"& on the
2435 directory, or by setting a specific group for local deliveries and allowing
2436 that group to create files in the directory (see the comments above the
2437 &(local_delivery)& transport in the default configuration file). Another
2438 approach is to configure Exim not to use lock files, but just to rely on
2439 &[fcntl()]& locking instead. However, you should do this only if all user
2440 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2441 see chapter &<<CHAPappendfile>>&.
2442
2443 One thing that cannot be tested on a system that is already running an MTA is
2444 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2445 &%-oX%& option can be used to run an Exim daemon that listens on some other
2446 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2447 &'exim_checkaccess'& utility can be used to check out policy controls on
2448 incoming SMTP mail.
2449
2450 Testing a new version on a system that is already running Exim can most easily
2451 be done by building a binary with a different CONFIGURE_FILE setting. From
2452 within the run time configuration, all other file and directory names
2453 that Exim uses can be altered, in order to keep it entirely clear of the
2454 production version.
2455
2456
2457 .section "Replacing another MTA with Exim" "SECID35"
2458 .cindex "replacing another MTA"
2459 Building and installing Exim for the first time does not of itself put it in
2460 general use. The name by which the system's MTA is called by mail user agents
2461 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2462 operating system), and it is necessary to make this name point to the &'exim'&
2463 binary in order to get the user agents to pass messages to Exim. This is
2464 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2465 or &_/usr/lib/sendmail_&
2466 .cindex "symbolic link" "to &'exim'& binary"
2467 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2468 privilege and executable status from the old MTA. It is then necessary to stop
2469 and restart the mailer daemon, if one is running.
2470
2471 .cindex "FreeBSD, MTA indirection"
2472 .cindex "&_/etc/mail/mailer.conf_&"
2473 Some operating systems have introduced alternative ways of switching MTAs. For
2474 example, if you are running FreeBSD, you need to edit the file
2475 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2476 described. A typical example of the contents of this file for running Exim is
2477 as follows:
2478 .code
2479 sendmail            /usr/exim/bin/exim
2480 send-mail           /usr/exim/bin/exim
2481 mailq               /usr/exim/bin/exim -bp
2482 newaliases          /usr/bin/true
2483 .endd
2484 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2485 your Exim installation is &"live"&. Check it by sending a message from your
2486 favourite user agent.
2487
2488 You should consider what to tell your users about the change of MTA. Exim may
2489 have different capabilities to what was previously running, and there are
2490 various operational differences such as the text of messages produced by
2491 command line options and in bounce messages. If you allow your users to make
2492 use of Exim's filtering capabilities, you should make the document entitled
2493 &'Exim's interface to mail filtering'& available to them.
2494
2495
2496
2497 .section "Upgrading Exim" "SECID36"
2498 .cindex "upgrading Exim"
2499 If you are already running Exim on your host, building and installing a new
2500 version automatically makes it available to MUAs, or any other programs that
2501 call the MTA directly. However, if you are running an Exim daemon, you do need
2502 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2503 new binary. You do not need to stop processing mail in order to install a new
2504 version of Exim. The install script does not modify an existing runtime
2505 configuration file.
2506
2507
2508
2509
2510 .section "Stopping the Exim daemon on Solaris" "SECID37"
2511 .cindex "Solaris" "stopping Exim on"
2512 The standard command for stopping the mailer daemon on Solaris is
2513 .code
2514 /etc/init.d/sendmail stop
2515 .endd
2516 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2517 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2518 for the text &"sendmail"&; this is not present because the actual program name
2519 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2520 solution is to replace the line that finds the process id with something like
2521 .code
2522 pid=`cat /var/spool/exim/exim-daemon.pid`
2523 .endd
2524 to obtain the daemon's pid directly from the file that Exim saves it in.
2525
2526 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2527 still be received from local processes, and if automatic delivery is configured
2528 (the normal case), deliveries will still occur.
2529
2530
2531
2532
2533 . ////////////////////////////////////////////////////////////////////////////
2534 . ////////////////////////////////////////////////////////////////////////////
2535
2536 .chapter "The Exim command line" "CHAPcommandline"
2537 .scindex IIDclo1 "command line" "options"
2538 .scindex IIDclo2 "options" "command line"
2539 Exim's command line takes the standard Unix form of a sequence of options,
2540 each starting with a hyphen character, followed by a number of arguments. The
2541 options are compatible with the main options of Sendmail, and there are also
2542 some additional options, some of which are compatible with Smail 3. Certain
2543 combinations of options do not make sense, and provoke an error if used.
2544 The form of the arguments depends on which options are set.
2545
2546
2547 .section "Setting options by program name" "SECID38"
2548 .cindex "&'mailq'&"
2549 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2550 were present before any other options.
2551 The &%-bp%& option requests a listing of the contents of the mail queue on the
2552 standard output.
2553 This feature is for compatibility with some systems that contain a command of
2554 that name in one of the standard libraries, symbolically linked to
2555 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2556
2557 .cindex "&'rsmtp'&"
2558 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2559 were present before any other options, for compatibility with Smail. The
2560 &%-bS%& option is used for reading in a number of messages in batched SMTP
2561 format.
2562
2563 .cindex "&'rmail'&"
2564 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2565 &%-oee%& options were present before any other options, for compatibility with
2566 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2567
2568 .cindex "&'runq'&"
2569 .cindex "queue runner"
2570 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2571 were present before any other options, for compatibility with Smail. The &%-q%&
2572 option causes a single queue runner process to be started.
2573
2574 .cindex "&'newaliases'&"
2575 .cindex "alias file" "building"
2576 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2577 If Exim is called under the name &'newaliases'& it behaves as if the option
2578 &%-bi%& were present before any other options, for compatibility with Sendmail.
2579 This option is used for rebuilding Sendmail's alias file. Exim does not have
2580 the concept of a single alias file, but can be configured to run a given
2581 command if called with the &%-bi%& option.
2582
2583
2584 .section "Trusted and admin users" "SECTtrustedadmin"
2585 Some Exim options are available only to &'trusted users'& and others are
2586 available only to &'admin users'&. In the description below, the phrases &"Exim
2587 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2588 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2589 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2590
2591 .ilist
2592 .cindex "trusted users" "definition of"
2593 .cindex "user" "trusted definition of"
2594 The trusted users are root, the Exim user, any user listed in the
2595 &%trusted_users%& configuration option, and any user whose current group or any
2596 supplementary group is one of those listed in the &%trusted_groups%&
2597 configuration option. Note that the Exim group is not automatically trusted.
2598
2599 .cindex '&"From"& line'
2600 .cindex "envelope sender"
2601 Trusted users are always permitted to use the &%-f%& option or a leading
2602 &"From&~"& line to specify the envelope sender of a message that is passed to
2603 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2604 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2605 users to set envelope senders.
2606
2607 .cindex "&'From:'& header line"
2608 .cindex "&'Sender:'& header line"
2609 For a trusted user, there is never any check on the contents of the &'From:'&
2610 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2611 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2612
2613 Trusted users may also specify a host name, host address, interface address,
2614 protocol name, ident value, and authentication data when submitting a message
2615 locally. Thus, they are able to insert messages into Exim's queue locally that
2616 have the characteristics of messages received from a remote host. Untrusted
2617 users may in some circumstances use &%-f%&, but can never set the other values
2618 that are available to trusted users.
2619 .next
2620 .cindex "user" "admin definition of"
2621 .cindex "admin user" "definition of"
2622 The admin users are root, the Exim user, and any user that is a member of the
2623 Exim group or of any group listed in the &%admin_groups%& configuration option.
2624 The current group does not have to be one of these groups.
2625
2626 Admin users are permitted to list the queue, and to carry out certain
2627 operations on messages, for example, to force delivery failures. It is also
2628 necessary to be an admin user in order to see the full information provided by
2629 the Exim monitor, and full debugging output.
2630
2631 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2632 Exim to attempt delivery of messages on its queue is restricted to admin users.
2633 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2634 option false (that is, specifying &%no_prod_requires_admin%&).
2635
2636 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2637 is restricted to admin users unless &%queue_list_requires_admin%& is set
2638 false.
2639 .endlist
2640
2641
2642 &*Warning*&: If you configure your system so that admin users are able to
2643 edit Exim's configuration file, you are giving those users an easy way of
2644 getting root. There is further discussion of this issue at the start of chapter
2645 &<<CHAPconf>>&.
2646
2647
2648
2649
2650 .section "Command line options" "SECID39"
2651 Exim's command line options are described in alphabetical order below. If none
2652 of the options that specifies a specific action (such as starting the daemon or
2653 a queue runner, or testing an address, or receiving a message in a specific
2654 format, or listing the queue) are present, and there is at least one argument
2655 on the command line, &%-bm%& (accept a local message on the standard input,
2656 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2657 outputs a brief message about itself and exits.
2658
2659 . ////////////////////////////////////////////////////////////////////////////
2660 . Insert a stylized XML comment here, to identify the start of the command line
2661 . options. This is for the benefit of the Perl script that automatically
2662 . creates a man page for the options.
2663 . ////////////////////////////////////////////////////////////////////////////
2664
2665 .literal xml
2666 <!-- === Start of command line options === -->
2667 .literal off
2668
2669
2670 .vlist
2671 .vitem &%--%&
2672 .oindex "--"
2673 .cindex "options" "command line; terminating"
2674 This is a pseudo-option whose only purpose is to terminate the options and
2675 therefore to cause subsequent command line items to be treated as arguments
2676 rather than options, even if they begin with hyphens.
2677
2678 .vitem &%--help%&
2679 .oindex "&%--help%&"
2680 This option causes Exim to output a few sentences stating what it is.
2681 The same output is generated if the Exim binary is called with no options and
2682 no arguments.
2683
2684 .vitem &%--version%&
2685 .oindex "&%--version%&"
2686 This option is an alias for &%-bV%& and causes version information to be
2687 displayed.
2688
2689 .vitem &%-B%&<&'type'&>
2690 .oindex "&%-B%&"
2691 .cindex "8-bit characters"
2692 .cindex "Sendmail compatibility" "8-bit characters"
2693 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2694 clean; it ignores this option.
2695
2696 .vitem &%-bd%&
2697 .oindex "&%-bd%&"
2698 .cindex "daemon"
2699 .cindex "SMTP" "listener"
2700 .cindex "queue runner"
2701 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2702 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2703 that the daemon should also initiate periodic queue runs.
2704
2705 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2706 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2707 disconnect from the controlling terminal. When running this way, it can be
2708 stopped by pressing ctrl-C.
2709
2710 By default, Exim listens for incoming connections to the standard SMTP port on
2711 all the host's running interfaces. However, it is possible to listen on other
2712 ports, on multiple ports, and only on specific interfaces. Chapter
2713 &<<CHAPinterfaces>>& contains a description of the options that control this.
2714
2715 When a listening daemon
2716 .cindex "daemon" "process id (pid)"
2717 .cindex "pid (process id)" "of daemon"
2718 is started without the use of &%-oX%& (that is, without overriding the normal
2719 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2720 in Exim's spool directory. This location can be overridden by setting
2721 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2722 running as root.
2723
2724 When &%-oX%& is used on the command line to start a listening daemon, the
2725 process id is not written to the normal pid file path. However, &%-oP%& can be
2726 used to specify a path on the command line if a pid file is required.
2727
2728 The SIGHUP signal
2729 .cindex "SIGHUP"
2730 .cindex "daemon" "restarting"
2731 can be used to cause the daemon to re-execute itself. This should be done
2732 whenever Exim's configuration file, or any file that is incorporated into it by
2733 means of the &%.include%& facility, is changed, and also whenever a new version
2734 of Exim is installed. It is not necessary to do this when other files that are
2735 referenced from the configuration (for example, alias files) are changed,
2736 because these are reread each time they are used.
2737
2738 .vitem &%-bdf%&
2739 .oindex "&%-bdf%&"
2740 This option has the same effect as &%-bd%& except that it never disconnects
2741 from the controlling terminal, even when no debugging is specified.
2742
2743 .vitem &%-be%&
2744 .oindex "&%-be%&"
2745 .cindex "testing" "string expansion"
2746 .cindex "expansion" "testing"
2747 Run Exim in expansion testing mode. Exim discards its root privilege, to
2748 prevent ordinary users from using this mode to read otherwise inaccessible
2749 files. If no arguments are given, Exim runs interactively, prompting for lines
2750 of data. Otherwise, it processes each argument in turn.
2751
2752 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2753 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2754 used without command line arguments. If successful, it uses the &[readline()]&
2755 function, which provides extensive line-editing facilities, for reading the
2756 test data. A line history is supported.
2757
2758 Long expansion expressions can be split over several lines by using backslash
2759 continuations. As in Exim's run time configuration, white space at the start of
2760 continuation lines is ignored. Each argument or data line is passed through the
2761 string expansion mechanism, and the result is output. Variable values from the
2762 configuration file (for example, &$qualify_domain$&) are available, but no
2763 message-specific values (such as &$sender_domain$&) are set, because no message
2764 is being processed (but see &%-bem%& and &%-Mset%&).
2765
2766 &*Note*&: If you use this mechanism to test lookups, and you change the data
2767 files or databases you are using, you must exit and restart Exim before trying
2768 the same lookup again. Otherwise, because each Exim process caches the results
2769 of lookups, you will just get the same result as before.
2770
2771 .vitem &%-bem%&&~<&'filename'&>
2772 .oindex "&%-bem%&"
2773 .cindex "testing" "string expansion"
2774 .cindex "expansion" "testing"
2775 This option operates like &%-be%& except that it must be followed by the name
2776 of a file. For example:
2777 .code
2778 exim -bem /tmp/testmessage
2779 .endd
2780 The file is read as a message (as if receiving a locally-submitted non-SMTP
2781 message) before any of the test expansions are done. Thus, message-specific
2782 variables such as &$message_size$& and &$header_from:$& are available. However,
2783 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2784 recipients are read from the headers in the normal way, and are shown in the
2785 &$recipients$& variable. Note that recipients cannot be given on the command
2786 line, because further arguments are taken as strings to expand (just like
2787 &%-be%&).
2788
2789 .vitem &%-bF%&&~<&'filename'&>
2790 .oindex "&%-bF%&"
2791 .cindex "system filter" "testing"
2792 .cindex "testing" "system filter"
2793 This option is the same as &%-bf%& except that it assumes that the filter being
2794 tested is a system filter. The additional commands that are available only in
2795 system filters are recognized.
2796
2797 .vitem &%-bf%&&~<&'filename'&>
2798 .oindex "&%-bf%&"
2799 .cindex "filter" "testing"
2800 .cindex "testing" "filter file"
2801 .cindex "forward file" "testing"
2802 .cindex "testing" "forward file"
2803 .cindex "Sieve filter" "testing"
2804 This option runs Exim in user filter testing mode; the file is the filter file
2805 to be tested, and a test message must be supplied on the standard input. If
2806 there are no message-dependent tests in the filter, an empty file can be
2807 supplied.
2808
2809 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2810 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2811 filter and a user filter in the same run. For example:
2812 .code
2813 exim -bF /system/filter -bf /user/filter </test/message
2814 .endd
2815 This is helpful when the system filter adds header lines or sets filter
2816 variables that are used by the user filter.
2817
2818 If the test filter file does not begin with one of the special lines
2819 .code
2820 # Exim filter
2821 # Sieve filter
2822 .endd
2823 it is taken to be a normal &_.forward_& file, and is tested for validity under
2824 that interpretation. See sections &<<SECTitenonfilred>>& to
2825 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2826 redirection lists.
2827
2828 The result of an Exim command that uses &%-bf%&, provided no errors are
2829 detected, is a list of the actions that Exim would try to take if presented
2830 with the message for real. More details of filter testing are given in the
2831 separate document entitled &'Exim's interfaces to mail filtering'&.
2832
2833 When testing a filter file,
2834 .cindex "&""From""& line"
2835 .cindex "envelope sender"
2836 .oindex "&%-f%&" "for filter testing"
2837 the envelope sender can be set by the &%-f%& option,
2838 or by a &"From&~"& line at the start of the test message. Various parameters
2839 that would normally be taken from the envelope recipient address of the message
2840 can be set by means of additional command line options (see the next four
2841 options).
2842
2843 .vitem &%-bfd%&&~<&'domain'&>
2844 .oindex "&%-bfd%&"
2845 .vindex "&$qualify_domain$&"
2846 This sets the domain of the recipient address when a filter file is being
2847 tested by means of the &%-bf%& option. The default is the value of
2848 &$qualify_domain$&.
2849
2850 .vitem &%-bfl%&&~<&'local&~part'&>
2851 .oindex "&%-bfl%&"
2852 This sets the local part of the recipient address when a filter file is being
2853 tested by means of the &%-bf%& option. The default is the username of the
2854 process that calls Exim. A local part should be specified with any prefix or
2855 suffix stripped, because that is how it appears to the filter when a message is
2856 actually being delivered.
2857
2858 .vitem &%-bfp%&&~<&'prefix'&>
2859 .oindex "&%-bfp%&"
2860 This sets the prefix of the local part of the recipient address when a filter
2861 file is being tested by means of the &%-bf%& option. The default is an empty
2862 prefix.
2863
2864 .vitem &%-bfs%&&~<&'suffix'&>
2865 .oindex "&%-bfs%&"
2866 This sets the suffix of the local part of the recipient address when a filter
2867 file is being tested by means of the &%-bf%& option. The default is an empty
2868 suffix.
2869
2870 .vitem &%-bh%&&~<&'IP&~address'&>
2871 .oindex "&%-bh%&"
2872 .cindex "testing" "incoming SMTP"
2873 .cindex "SMTP" "testing incoming"
2874 .cindex "testing" "relay control"
2875 .cindex "relaying" "testing configuration"
2876 .cindex "policy control" "testing"
2877 .cindex "debugging" "&%-bh%& option"
2878 This option runs a fake SMTP session as if from the given IP address, using the
2879 standard input and output. The IP address may include a port number at the end,
2880 after a full stop. For example:
2881 .code
2882 exim -bh 10.9.8.7.1234
2883 exim -bh fe80::a00:20ff:fe86:a061.5678
2884 .endd
2885 When an IPv6 address is given, it is converted into canonical form. In the case
2886 of the second example above, the value of &$sender_host_address$& after
2887 conversion to the canonical form is
2888 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2889
2890 Comments as to what is going on are written to the standard error file. These
2891 include lines beginning with &"LOG"& for anything that would have been logged.
2892 This facility is provided for testing configuration options for incoming
2893 messages, to make sure they implement the required policy. For example, you can
2894 test your relay controls using &%-bh%&.
2895
2896 &*Warning 1*&:
2897 .cindex "RFC 1413"
2898 You can test features of the configuration that rely on ident (RFC 1413)
2899 information by using the &%-oMt%& option. However, Exim cannot actually perform
2900 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2901 connection.
2902
2903 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2904 are also skipped when testing using &%-bh%&. If you want these callouts to
2905 occur, use &%-bhc%& instead.
2906
2907 Messages supplied during the testing session are discarded, and nothing is
2908 written to any of the real log files. There may be pauses when DNS (and other)
2909 lookups are taking place, and of course these may time out. The &%-oMi%& option
2910 can be used to specify a specific IP interface and port if this is important,
2911 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2912 session were authenticated.
2913
2914 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2915 output just states whether a given recipient address from a given host is
2916 acceptable or not. See section &<<SECTcheckaccess>>&.
2917
2918 Features such as authentication and encryption, where the client input is not
2919 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2920 specialized SMTP test program such as
2921 &url(http://jetmore.org/john/code/#swaks,swaks).
2922
2923 .vitem &%-bhc%&&~<&'IP&~address'&>
2924 .oindex "&%-bhc%&"
2925 This option operates in the same way as &%-bh%&, except that address
2926 verification callouts are performed if required. This includes consulting and
2927 updating the callout cache database.
2928
2929 .vitem &%-bi%&
2930 .oindex "&%-bi%&"
2931 .cindex "alias file" "building"
2932 .cindex "building alias file"
2933 .cindex "Sendmail compatibility" "&%-bi%& option"
2934 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2935 Exim does not have the concept of a single alias file, and so it cannot mimic
2936 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2937 tend to appear in various scripts such as NIS make files, so the option must be
2938 recognized.
2939
2940 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2941 configuration option is run, under the uid and gid of the caller of Exim. If
2942 the &%-oA%& option is used, its value is passed to the command as an argument.
2943 The command set by &%bi_command%& may not contain arguments. The command can
2944 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2945 if this is required. If the &%bi_command%& option is not set, calling Exim with
2946 &%-bi%& is a no-op.
2947
2948 .vitem &%-bm%&
2949 .oindex "&%-bm%&"
2950 .cindex "local message reception"
2951 This option runs an Exim receiving process that accepts an incoming,
2952 locally-generated message on the current input. The recipients are given as the
2953 command arguments (except when &%-t%& is also present &-- see below). Each
2954 argument can be a comma-separated list of RFC 2822 addresses. This is the
2955 default option for selecting the overall action of an Exim call; it is assumed
2956 if no other conflicting option is present.
2957
2958 If any addresses in the message are unqualified (have no domain), they are
2959 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2960 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2961 suppressing this for special cases.
2962
2963 Policy checks on the contents of local messages can be enforced by means of
2964 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2965
2966 .cindex "return code" "for &%-bm%&"
2967 The return code is zero if the message is successfully accepted. Otherwise, the
2968 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2969
2970 The format
2971 .cindex "message" "format"
2972 .cindex "format" "message"
2973 .cindex "&""From""& line"
2974 .cindex "UUCP" "&""From""& line"
2975 .cindex "Sendmail compatibility" "&""From""& line"
2976 of the message must be as defined in RFC 2822, except that, for
2977 compatibility with Sendmail and Smail, a line in one of the forms
2978 .code
2979 From sender Fri Jan  5 12:55 GMT 1997
2980 From sender Fri, 5 Jan 97 12:55:01
2981 .endd
2982 (with the weekday optional, and possibly with additional text after the date)
2983 is permitted to appear at the start of the message. There appears to be no
2984 authoritative specification of the format of this line. Exim recognizes it by
2985 matching against the regular expression defined by the &%uucp_from_pattern%&
2986 option, which can be changed if necessary.
2987
2988 .oindex "&%-f%&" "overriding &""From""& line"
2989 The specified sender is treated as if it were given as the argument to the
2990 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
2991 preference to the address taken from the message. The caller of Exim must be a
2992 trusted user for the sender of a message to be set in this way.
2993
2994 .vitem &%-bnq%&
2995 .oindex "&%-bnq%&"
2996 .cindex "address qualification, suppressing"
2997 By default, Exim automatically qualifies unqualified addresses (those
2998 without domains) that appear in messages that are submitted locally (that
2999 is, not over TCP/IP). This qualification applies both to addresses in
3000 envelopes, and addresses in header lines. Sender addresses are qualified using
3001 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3002 defaults to the value of &%qualify_domain%&).
3003
3004 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3005 being used to re-submit messages that originally came from remote hosts after
3006 content scanning, you probably do not want to qualify unqualified addresses in
3007 header lines. (Such lines will be present only if you have not enabled a header
3008 syntax check in the appropriate ACL.)
3009
3010 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3011 messages that originate on the local host. When this is used, unqualified
3012 addresses in the envelope provoke errors (causing message rejection) and
3013 unqualified addresses in header lines are left alone.
3014
3015
3016 .vitem &%-bP%&
3017 .oindex "&%-bP%&"
3018 .cindex "configuration options" "extracting"
3019 .cindex "options" "configuration &-- extracting"
3020 If this option is given with no arguments, it causes the values of all Exim's
3021 main configuration options to be written to the standard output. The values
3022 of one or more specific options can be requested by giving their names as
3023 arguments, for example:
3024 .code
3025 exim -bP qualify_domain hold_domains
3026 .endd
3027 .cindex "hiding configuration option values"
3028 .cindex "configuration options" "hiding value of"
3029 .cindex "options" "hiding value of"
3030 However, any option setting that is preceded by the word &"hide"& in the
3031 configuration file is not shown in full, except to an admin user. For other
3032 users, the output is as in this example:
3033 .code
3034 mysql_servers = <value not displayable>
3035 .endd
3036 If &%configure_file%& is given as an argument, the name of the run time
3037 configuration file is output.
3038 If a list of configuration files was supplied, the value that is output here
3039 is the name of the file that was actually used.
3040
3041 .cindex "daemon" "process id (pid)"
3042 .cindex "pid (process id)" "of daemon"
3043 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3044 directories where log files and daemon pid files are written are output,
3045 respectively. If these values are unset, log files are written in a
3046 sub-directory of the spool directory called &%log%&, and the pid file is
3047 written directly into the spool directory.
3048
3049 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3050 .code
3051 exim -bP +local_domains
3052 .endd
3053 it searches for a matching named list of any type (domain, host, address, or
3054 local part) and outputs what it finds.
3055
3056 .cindex "options" "router &-- extracting"
3057 .cindex "options" "transport &-- extracting"
3058 .cindex "options" "authenticator &-- extracting"
3059 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3060 followed by the name of an appropriate driver instance, the option settings for
3061 that driver are output. For example:
3062 .code
3063 exim -bP transport local_delivery
3064 .endd
3065 The generic driver options are output first, followed by the driver's private
3066 options. A list of the names of drivers of a particular type can be obtained by
3067 using one of the words &%router_list%&, &%transport_list%&, or
3068 &%authenticator_list%&, and a complete list of all drivers with their option
3069 settings can be obtained by using &%routers%&, &%transports%&, or
3070 &%authenticators%&.
3071
3072 .cindex "options" "macro &-- extracting"
3073 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3074 are available, similarly to the drivers.  Because macros are sometimes used
3075 for storing passwords, this option is restricted.
3076 The output format is one item per line.
3077
3078 .vitem &%-bp%&
3079 .oindex "&%-bp%&"
3080 .cindex "queue" "listing messages on"
3081 .cindex "listing" "messages on the queue"
3082 This option requests a listing of the contents of the mail queue on the
3083 standard output. If the &%-bp%& option is followed by a list of message ids,
3084 just those messages are listed. By default, this option can be used only by an
3085 admin user. However, the &%queue_list_requires_admin%& option can be set false
3086 to allow any user to see the queue.
3087
3088 Each message on the queue is displayed as in the following example:
3089 .code
3090 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3091           red.king@looking-glass.fict.example
3092           <other addresses>
3093 .endd
3094 .cindex "message" "size in queue listing"
3095 .cindex "size" "of message"
3096 The first line contains the length of time the message has been on the queue
3097 (in this case 25 minutes), the size of the message (2.9K), the unique local
3098 identifier for the message, and the message sender, as contained in the
3099 envelope. For bounce messages, the sender address is empty, and appears as
3100 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3101 the default sender address, the user's login name is shown in parentheses
3102 before the sender address.
3103
3104 .cindex "frozen messages" "in queue listing"
3105 If the message is frozen (attempts to deliver it are suspended) then the text
3106 &"*** frozen ***"& is displayed at the end of this line.
3107
3108 The recipients of the message (taken from the envelope, not the headers) are
3109 displayed on subsequent lines. Those addresses to which the message has already
3110 been delivered are marked with the letter D. If an original address gets
3111 expanded into several addresses via an alias or forward file, the original is
3112 displayed with a D only when deliveries for all of its child addresses are
3113 complete.
3114
3115
3116 .vitem &%-bpa%&
3117 .oindex "&%-bpa%&"
3118 This option operates like &%-bp%&, but in addition it shows delivered addresses
3119 that were generated from the original top level address(es) in each message by
3120 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3121 of just &"D"&.
3122
3123
3124 .vitem &%-bpc%&
3125 .oindex "&%-bpc%&"
3126 .cindex "queue" "count of messages on"
3127 This option counts the number of messages on the queue, and writes the total
3128 to the standard output. It is restricted to admin users, unless
3129 &%queue_list_requires_admin%& is set false.
3130
3131
3132 .vitem &%-bpr%&
3133 .oindex "&%-bpr%&"
3134 This option operates like &%-bp%&, but the output is not sorted into
3135 chronological order of message arrival. This can speed it up when there are
3136 lots of messages on the queue, and is particularly useful if the output is
3137 going to be post-processed in a way that doesn't need the sorting.
3138
3139 .vitem &%-bpra%&
3140 .oindex "&%-bpra%&"
3141 This option is a combination of &%-bpr%& and &%-bpa%&.
3142
3143 .vitem &%-bpru%&
3144 .oindex "&%-bpru%&"
3145 This option is a combination of &%-bpr%& and &%-bpu%&.
3146
3147
3148 .vitem &%-bpu%&
3149 .oindex "&%-bpu%&"
3150 This option operates like &%-bp%& but shows only undelivered top-level
3151 addresses for each message displayed. Addresses generated by aliasing or
3152 forwarding are not shown, unless the message was deferred after processing by a
3153 router with the &%one_time%& option set.
3154
3155
3156 .vitem &%-brt%&
3157 .oindex "&%-brt%&"
3158 .cindex "testing" "retry configuration"
3159 .cindex "retry" "configuration testing"
3160 This option is for testing retry rules, and it must be followed by up to three
3161 arguments. It causes Exim to look for a retry rule that matches the values
3162 and to write it to the standard output. For example:
3163 .code
3164 exim -brt bach.comp.mus.example
3165 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3166 .endd
3167 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3168 argument, which is required, can be a complete address in the form
3169 &'local_part@domain'&, or it can be just a domain name. If the second argument
3170 contains a dot, it is interpreted as an optional second domain name; if no
3171 retry rule is found for the first argument, the second is tried. This ties in
3172 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3173 rule is found that matches the host, one that matches the mail domain is
3174 sought. Finally, an argument that is the name of a specific delivery error, as
3175 used in setting up retry rules, can be given. For example:
3176 .code
3177 exim -brt haydn.comp.mus.example quota_3d
3178 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3179 .endd
3180
3181 .vitem &%-brw%&
3182 .oindex "&%-brw%&"
3183 .cindex "testing" "rewriting"
3184 .cindex "rewriting" "testing"
3185 This option is for testing address rewriting rules, and it must be followed by
3186 a single argument, consisting of either a local part without a domain, or a
3187 complete address with a fully qualified domain. Exim outputs how this address
3188 would be rewritten for each possible place it might appear. See chapter
3189 &<<CHAPrewrite>>& for further details.
3190
3191 .vitem &%-bS%&
3192 .oindex "&%-bS%&"
3193 .cindex "SMTP" "batched incoming"
3194 .cindex "batched SMTP input"
3195 This option is used for batched SMTP input, which is an alternative interface
3196 for non-interactive local message submission. A number of messages can be
3197 submitted in a single run. However, despite its name, this is not really SMTP
3198 input. Exim reads each message's envelope from SMTP commands on the standard
3199 input, but generates no responses. If the caller is trusted, or
3200 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3201 believed; otherwise the sender is always the caller of Exim.
3202
3203 The message itself is read from the standard input, in SMTP format (leading
3204 dots doubled), terminated by a line containing just a single dot. An error is
3205 provoked if the terminating dot is missing. A further message may then follow.
3206
3207 As for other local message submissions, the contents of incoming batch SMTP
3208 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3209 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3210 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3211
3212 Some other SMTP commands are recognized in the input. HELO and EHLO act
3213 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3214 QUIT quits, ignoring the rest of the standard input.
3215
3216 .cindex "return code" "for &%-bS%&"
3217 If any error is encountered, reports are written to the standard output and
3218 error streams, and Exim gives up immediately. The return code is 0 if no error
3219 was detected; it is 1 if one or more messages were accepted before the error
3220 was detected; otherwise it is 2.
3221
3222 More details of input using batched SMTP are given in section
3223 &<<SECTincomingbatchedSMTP>>&.
3224
3225 .vitem &%-bs%&
3226 .oindex "&%-bs%&"
3227 .cindex "SMTP" "local input"
3228 .cindex "local SMTP input"
3229 This option causes Exim to accept one or more messages by reading SMTP commands
3230 on the standard input, and producing SMTP replies on the standard output. SMTP
3231 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3232 Some user agents use this interface as a way of passing locally-generated
3233 messages to the MTA.
3234
3235 In
3236 .cindex "sender" "source of"
3237 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3238 set, the senders of messages are taken from the SMTP MAIL commands.
3239 Otherwise the content of these commands is ignored and the sender is set up as
3240 the calling user. Unqualified addresses are automatically qualified using
3241 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3242 &%-bnq%& option is used.
3243
3244 .cindex "inetd"
3245 The
3246 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3247 using a listening daemon. Exim can distinguish the two cases by checking
3248 whether the standard input is a TCP/IP socket. When Exim is called from
3249 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3250 above concerning senders and qualification do not apply. In this situation,
3251 Exim behaves in exactly the same way as it does when receiving a message via
3252 the listening daemon.
3253
3254 .vitem &%-bmalware%&&~<&'filename'&>
3255 .oindex "&%-bmalware%&"
3256 .cindex "testing", "malware"
3257 .cindex "malware scan test"
3258 This debugging option causes Exim to scan the given file,
3259 using the malware scanning framework.  The option of &%av_scanner%& influences
3260 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3261 the expansion should have defaults which apply to this invocation.  ACLs are
3262 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3263 will never be populated and &%-bmalware%& will fail.
3264
3265 Exim will have changed working directory before resolving the filename, so
3266 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3267 user when it tries to open the file, rather than as the invoking user.
3268 This option requires admin privileges.
3269
3270 The &%-bmalware%& option will not be extended to be more generally useful,
3271 there are better tools for file-scanning.  This option exists to help
3272 administrators verify their Exim and AV scanner configuration.
3273
3274 .vitem &%-bt%&
3275 .oindex "&%-bt%&"
3276 .cindex "testing" "addresses"
3277 .cindex "address" "testing"
3278 This option runs Exim in address testing mode, in which each argument is taken
3279 as a recipient address to be tested for deliverability. The results are
3280 written to the standard output. If a test fails, and the caller is not an admin
3281 user, no details of the failure are output, because these might contain
3282 sensitive information such as usernames and passwords for database lookups.
3283
3284 If no arguments are given, Exim runs in an interactive manner, prompting with a
3285 right angle bracket for addresses to be tested.
3286
3287 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3288 &[readline()]& function, because it is running as &'root'& and there are
3289 security issues.
3290
3291 Each address is handled as if it were the recipient address of a message
3292 (compare the &%-bv%& option). It is passed to the routers and the result is
3293 written to the standard output. However, any router that has
3294 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3295 genuine routing tests if your first router passes everything to a scanner
3296 program.
3297
3298 .cindex "return code" "for &%-bt%&"
3299 The return code is 2 if any address failed outright; it is 1 if no address
3300 failed outright but at least one could not be resolved for some reason. Return
3301 code 0 is given only when all addresses succeed.
3302
3303 .cindex "duplicate addresses"
3304 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3305 addresses after routing is complete, so that only one delivery takes place.
3306 This does not happen when testing with &%-bt%&; the full results of routing are
3307 always shown.
3308
3309 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3310 routers in the configuration makes any tests on the sender address of a
3311 message,
3312 .oindex "&%-f%&" "for address testing"
3313 you can use the &%-f%& option to set an appropriate sender when running
3314 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3315 default qualifying domain. However, if you have set up (for example) routers
3316 whose behaviour depends on the contents of an incoming message, you cannot test
3317 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3318 doing such tests.
3319
3320 .vitem &%-bV%&
3321 .oindex "&%-bV%&"
3322 .cindex "version number of Exim"
3323 This option causes Exim to write the current version number, compilation
3324 number, and compilation date of the &'exim'& binary to the standard output.
3325 It also lists the DBM library that is being used, the optional modules (such as
3326 specific lookup types), the drivers that are included in the binary, and the
3327 name of the run time configuration file that is in use.
3328
3329 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3330 configuration file. However, this is a static check only. It cannot check
3331 values that are to be expanded. For example, although a misspelt ACL verb is
3332 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3333 alone to discover (for example) all the typos in the configuration; some
3334 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3335 dynamic testing facilities.
3336
3337 .vitem &%-bv%&
3338 .oindex "&%-bv%&"
3339 .cindex "verifying address" "using &%-bv%&"
3340 .cindex "address" "verification"
3341 This option runs Exim in address verification mode, in which each argument is
3342 taken as a recipient address to be verified by the routers. (This does
3343 not involve any verification callouts). During normal operation, verification
3344 happens mostly as a consequence processing a &%verify%& condition in an ACL
3345 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3346 including callouts, see the &%-bh%& and &%-bhc%& options.
3347
3348 If verification fails, and the caller is not an admin user, no details of the
3349 failure are output, because these might contain sensitive information such as
3350 usernames and passwords for database lookups.
3351
3352 If no arguments are given, Exim runs in an interactive manner, prompting with a
3353 right angle bracket for addresses to be verified.
3354
3355 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3356 &[readline()]& function, because it is running as &'exim'& and there are
3357 security issues.
3358
3359 Verification differs from address testing (the &%-bt%& option) in that routers
3360 that have &%no_verify%& set are skipped, and if the address is accepted by a
3361 router that has &%fail_verify%& set, verification fails. The address is
3362 verified as a recipient if &%-bv%& is used; to test verification for a sender
3363 address, &%-bvs%& should be used.
3364
3365 If the &%-v%& option is not set, the output consists of a single line for each
3366 address, stating whether it was verified or not, and giving a reason in the
3367 latter case. Without &%-v%&, generating more than one address by redirection
3368 causes verification to end successfully, without considering the generated
3369 addresses. However, if just one address is generated, processing continues,
3370 and the generated address must verify successfully for the overall verification
3371 to succeed.
3372
3373 When &%-v%& is set, more details are given of how the address has been handled,
3374 and in the case of address redirection, all the generated addresses are also
3375 considered. Verification may succeed for some and fail for others.
3376
3377 The
3378 .cindex "return code" "for &%-bv%&"
3379 return code is 2 if any address failed outright; it is 1 if no address
3380 failed outright but at least one could not be resolved for some reason. Return
3381 code 0 is given only when all addresses succeed.
3382
3383 If any of the routers in the configuration makes any tests on the sender
3384 address of a message, you should use the &%-f%& option to set an appropriate
3385 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3386 calling user at the default qualifying domain.
3387
3388 .vitem &%-bvs%&
3389 .oindex "&%-bvs%&"
3390 This option acts like &%-bv%&, but verifies the address as a sender rather
3391 than a recipient address. This affects any rewriting and qualification that
3392 might happen.
3393
3394 .vitem &%-bw%&
3395 .oindex "&%-bw%&"
3396 .cindex "daemon"
3397 .cindex "inetd"
3398 .cindex "inetd" "wait mode"
3399 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3400 similarly to the &%-bd%& option.  All port specifications on the command-line
3401 and in the configuration file are ignored.  Queue-running may not be specified.
3402
3403 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3404 listening for connections.  This permits the system to start up and have
3405 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3406 each port only when the first connection is received.
3407
3408 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3409 which the daemon will exit, which should cause inetd to listen once more.
3410
3411 .vitem &%-C%&&~<&'filelist'&>
3412 .oindex "&%-C%&"
3413 .cindex "configuration file" "alternate"
3414 .cindex "CONFIGURE_FILE"
3415 .cindex "alternate configuration file"
3416 This option causes Exim to find the run time configuration file from the given
3417 list instead of from the list specified by the CONFIGURE_FILE
3418 compile-time setting. Usually, the list will consist of just a single file
3419 name, but it can be a colon-separated list of names. In this case, the first
3420 file that exists is used. Failure to open an existing file stops Exim from
3421 proceeding any further along the list, and an error is generated.
3422
3423 When this option is used by a caller other than root, and the list is different
3424 from the compiled-in list, Exim gives up its root privilege immediately, and
3425 runs with the real and effective uid and gid set to those of the caller.
3426 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3427 file contains a list of full pathnames, one per line, for configuration files
3428 which are trusted. Root privilege is retained for any configuration file so
3429 listed, as long as the caller is the Exim user (or the user specified in the
3430 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3431 not writeable by inappropriate users or groups.
3432
3433 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3434 configuration using &%-C%& right through message reception and delivery,
3435 even if the caller is root. The reception works, but by that time, Exim is
3436 running as the Exim user, so when it re-executes to regain privilege for the
3437 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3438 test reception and delivery using two separate commands (one to put a message
3439 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3440
3441 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3442 prefix string with which any file named in a &%-C%& command line option
3443 must start. In addition, the file name must not contain the sequence &`/../`&.
3444 However, if the value of the &%-C%& option is identical to the value of
3445 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3446 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3447 unset, any file name can be used with &%-C%&.
3448
3449 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3450 to a directory to which only root has access. This prevents someone who has
3451 broken into the Exim account from running a privileged Exim with an arbitrary
3452 configuration file.
3453
3454 The &%-C%& facility is useful for ensuring that configuration files are
3455 syntactically correct, but cannot be used for test deliveries, unless the
3456 caller is privileged, or unless it is an exotic configuration that does not
3457 require privilege. No check is made on the owner or group of the files
3458 specified by this option.
3459
3460
3461 .vitem &%-D%&<&'macro'&>=<&'value'&>
3462 .oindex "&%-D%&"
3463 .cindex "macro" "setting on command line"
3464 This option can be used to override macro definitions in the configuration file
3465 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3466 unprivileged caller, it causes Exim to give up its root privilege.
3467 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3468 completely disabled, and its use causes an immediate error exit.
3469
3470 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3471 colon-separated list of macros which are considered safe and, if &%-D%& only
3472 supplies macros from this list, and the values are acceptable, then Exim will
3473 not give up root privilege if the caller is root, the Exim run-time user, or
3474 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3475 to be removed in the future.  Acceptable values for the macros satisfy the
3476 regexp: &`^[A-Za-z0-9_/.-]*$`&
3477
3478 The entire option (including equals sign if present) must all be within one
3479 command line item. &%-D%& can be used to set the value of a macro to the empty
3480 string, in which case the equals sign is optional. These two commands are
3481 synonymous:
3482 .code
3483 exim -DABC  ...
3484 exim -DABC= ...
3485 .endd
3486 To include spaces in a macro definition item, quotes must be used. If you use
3487 quotes, spaces are permitted around the macro name and the equals sign. For
3488 example:
3489 .code
3490 exim '-D ABC = something' ...
3491 .endd
3492 &%-D%& may be repeated up to 10 times on a command line.
3493
3494
3495 .vitem &%-d%&<&'debug&~options'&>
3496 .oindex "&%-d%&"
3497 .cindex "debugging" "list of selectors"
3498 .cindex "debugging" "&%-d%& option"
3499 This option causes debugging information to be written to the standard
3500 error stream. It is restricted to admin users because debugging output may show
3501 database queries that contain password information. Also, the details of users'
3502 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3503 writes an error message to the standard error stream and exits with a non-zero
3504 return code.
3505
3506 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3507 standard debugging data is output. This can be reduced, or increased to include
3508 some more rarely needed information, by directly following &%-d%& with a string
3509 made up of names preceded by plus or minus characters. These add or remove sets
3510 of debugging data, respectively. For example, &%-d+filter%& adds filter
3511 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3512 no spaces are allowed in the debug setting. The available debugging categories
3513 are:
3514 .display
3515 &`acl            `& ACL interpretation
3516 &`auth           `& authenticators
3517 &`deliver        `& general delivery logic
3518 &`dns            `& DNS lookups (see also resolver)
3519 &`dnsbl          `& DNS black list (aka RBL) code
3520 &`exec           `& arguments for &[execv()]& calls
3521 &`expand         `& detailed debugging for string expansions
3522 &`filter         `& filter handling
3523 &`hints_lookup   `& hints data lookups
3524 &`host_lookup    `& all types of name-to-IP address handling
3525 &`ident          `& ident lookup
3526 &`interface      `& lists of local interfaces
3527 &`lists          `& matching things in lists
3528 &`load           `& system load checks
3529 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3530                     &<<CHAPlocalscan>>&)
3531 &`lookup         `& general lookup code and all lookups
3532 &`memory         `& memory handling
3533 &`pid            `& add pid to debug output lines
3534 &`process_info   `& setting info for the process log
3535 &`queue_run      `& queue runs
3536 &`receive        `& general message reception logic
3537 &`resolver       `& turn on the DNS resolver's debugging output
3538 &`retry          `& retry handling
3539 &`rewrite        `& address rewriting
3540 &`route          `& address routing
3541 &`timestamp      `& add timestamp to debug output lines
3542 &`tls            `& TLS logic
3543 &`transport      `& transports
3544 &`uid            `& changes of uid/gid and looking up uid/gid
3545 &`verify         `& address verification logic
3546 &`all            `& almost all of the above (see below), and also &%-v%&
3547 .endd
3548 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3549 for &`-all`&. The reason for this is that &`+all`& is something that people
3550 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3551 is included, an awful lot of output that is very rarely of interest is
3552 generated, so it now has to be explicitly requested. However, &`-all`& does
3553 turn everything off.
3554
3555 .cindex "resolver, debugging output"
3556 .cindex "DNS resolver, debugging output"
3557 The &`resolver`& option produces output only if the DNS resolver was compiled
3558 with DEBUG enabled. This is not the case in some operating systems. Also,
3559 unfortunately, debugging output from the DNS resolver is written to stdout
3560 rather than stderr.
3561
3562 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3563 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3564 However, the &`pid`& selector is forced when debugging is turned on for a
3565 daemon, which then passes it on to any re-executed Exims. Exim also
3566 automatically adds the pid to debug lines when several remote deliveries are
3567 run in parallel.
3568
3569 The &`timestamp`& selector causes the current time to be inserted at the start
3570 of all debug output lines. This can be useful when trying to track down delays
3571 in processing.
3572
3573 If the &%debug_print%& option is set in any driver, it produces output whenever
3574 any debugging is selected, or if &%-v%& is used.
3575
3576 .vitem &%-dd%&<&'debug&~options'&>
3577 .oindex "&%-dd%&"
3578 This option behaves exactly like &%-d%& except when used on a command that
3579 starts a daemon process. In that case, debugging is turned off for the
3580 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3581 behaviour of the daemon without creating as much output as full debugging does.
3582
3583 .vitem &%-dropcr%&
3584 .oindex "&%-dropcr%&"
3585 This is an obsolete option that is now a no-op. It used to affect the way Exim
3586 handled CR and LF characters in incoming messages. What happens now is
3587 described in section &<<SECTlineendings>>&.
3588
3589 .vitem &%-E%&
3590 .oindex "&%-E%&"
3591 .cindex "bounce message" "generating"
3592 This option specifies that an incoming message is a locally-generated delivery
3593 failure report. It is used internally by Exim when handling delivery failures
3594 and is not intended for external use. Its only effect is to stop Exim
3595 generating certain messages to the postmaster, as otherwise message cascades
3596 could occur in some situations. As part of the same option, a message id may
3597 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3598 new message contains the id, following &"R="&, as a cross-reference.
3599
3600 .vitem &%-e%&&'x'&
3601 .oindex "&%-e%&&'x'&"
3602 There are a number of Sendmail options starting with &%-oe%& which seem to be
3603 called by various programs without the leading &%o%& in the option. For
3604 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3605 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3606
3607 .vitem &%-F%&&~<&'string'&>
3608 .oindex "&%-F%&"
3609 .cindex "sender" "name"
3610 .cindex "name" "of sender"
3611 This option sets the sender's full name for use when a locally-generated
3612 message is being accepted. In the absence of this option, the user's &'gecos'&
3613 entry from the password data is used. As users are generally permitted to alter
3614 their &'gecos'& entries, no security considerations are involved. White space
3615 between &%-F%& and the <&'string'&> is optional.
3616
3617 .vitem &%-f%&&~<&'address'&>
3618 .oindex "&%-f%&"
3619 .cindex "sender" "address"
3620 .cindex "address" "sender"
3621 .cindex "trusted users"
3622 .cindex "envelope sender"
3623 .cindex "user" "trusted"
3624 This option sets the address of the envelope sender of a locally-generated
3625 message (also known as the return path). The option can normally be used only
3626 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3627 users to use it.
3628
3629 Processes running as root or the Exim user are always trusted. Other
3630 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3631 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3632 of a local message is set to the caller's login name at the default qualify
3633 domain.
3634
3635 There is one exception to the restriction on the use of &%-f%&: an empty sender
3636 can be specified by any user, trusted or not, to create a message that can
3637 never provoke a bounce. An empty sender can be specified either as an empty
3638 string, or as a pair of angle brackets with nothing between them, as in these
3639 examples of shell commands:
3640 .code
3641 exim -f '<>' user@domain
3642 exim -f "" user@domain
3643 .endd
3644 In addition, the use of &%-f%& is not restricted when testing a filter file
3645 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3646 &%-bv%& options.
3647
3648 Allowing untrusted users to change the sender address does not of itself make
3649 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3650 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3651 though this can be overridden by setting &%no_local_from_check%&.
3652
3653 White
3654 .cindex "&""From""& line"
3655 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3656 given as two arguments or one combined argument). The sender of a
3657 locally-generated message can also be set (when permitted) by an initial
3658 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3659 if &%-f%& is also present, it overrides &"From&~"&.
3660
3661 .vitem &%-G%&
3662 .oindex "&%-G%&"
3663 .cindex "Sendmail compatibility" "&%-G%& option ignored"
3664 This is a Sendmail option which is ignored by Exim.
3665
3666 .vitem &%-h%&&~<&'number'&>
3667 .oindex "&%-h%&"
3668 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3669 This option is accepted for compatibility with Sendmail, but has no effect. (In
3670 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3671 headers.)
3672
3673 .vitem &%-i%&
3674 .oindex "&%-i%&"
3675 .cindex "Solaris" "&'mail'& command"
3676 .cindex "dot" "in incoming non-SMTP message"
3677 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3678 line by itself should not terminate an incoming, non-SMTP message. I can find
3679 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3680 command in Solaris 2.4 uses it. See also &%-ti%&.
3681
3682 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3683 .oindex "&%-M%&"
3684 .cindex "forcing delivery"
3685 .cindex "delivery" "forcing attempt"
3686 .cindex "frozen messages" "forcing delivery"
3687 This option requests Exim to run a delivery attempt on each message in turn. If
3688 any of the messages are frozen, they are automatically thawed before the
3689 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3690 and &%hold_domains%& are ignored.
3691
3692 Retry
3693 .cindex "hints database" "overriding retry hints"
3694 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3695 the normal retry time has not yet been reached. This option requires the caller
3696 to be an admin user. However, there is an option called &%prod_requires_admin%&
3697 which can be set false to relax this restriction (and also the same requirement
3698 for the &%-q%&, &%-R%&, and &%-S%& options).
3699
3700 The deliveries happen synchronously, that is, the original Exim process does
3701 not terminate until all the delivery attempts have finished. No output is
3702 produced unless there is a serious error. If you want to see what is happening,
3703 use the &%-v%& option as well, or inspect Exim's main log.
3704
3705 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3706 .oindex "&%-Mar%&"
3707 .cindex "message" "adding recipients"
3708 .cindex "recipient" "adding"
3709 This option requests Exim to add the addresses to the list of recipients of the
3710 message (&"ar"& for &"add recipients"&). The first argument must be a message
3711 id, and the remaining ones must be email addresses. However, if the message is
3712 active (in the middle of a delivery attempt), it is not altered. This option
3713 can be used only by an admin user.
3714
3715 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3716         &~<&'message&~id'&>"
3717 .oindex "&%-MC%&"
3718 .cindex "SMTP" "passed connection"
3719 .cindex "SMTP" "multiple deliveries"
3720 .cindex "multiple SMTP deliveries"
3721 This option is not intended for use by external callers. It is used internally
3722 by Exim to invoke another instance of itself to deliver a waiting message using
3723 an existing SMTP connection, which is passed as the standard input. Details are
3724 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3725 must be root or the Exim user in order to use it.
3726
3727 .vitem &%-MCA%&
3728 .oindex "&%-MCA%&"
3729 This option is not intended for use by external callers. It is used internally
3730 by Exim in conjunction with the &%-MC%& option. It signifies that the
3731 connection to the remote host has been authenticated.
3732
3733 .vitem &%-MCP%&
3734 .oindex "&%-MCP%&"
3735 This option is not intended for use by external callers. It is used internally
3736 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3737 which Exim is connected supports pipelining.
3738
3739 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3740 .oindex "&%-MCQ%&"
3741 This option is not intended for use by external callers. It is used internally
3742 by Exim in conjunction with the &%-MC%& option when the original delivery was
3743 started by a queue runner. It passes on the process id of the queue runner,
3744 together with the file descriptor number of an open pipe. Closure of the pipe
3745 signals the final completion of the sequence of processes that are passing
3746 messages through the same SMTP connection.
3747
3748 .vitem &%-MCS%&
3749 .oindex "&%-MCS%&"
3750 This option is not intended for use by external callers. It is used internally
3751 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3752 SMTP SIZE option should be used on messages delivered down the existing
3753 connection.
3754
3755 .vitem &%-MCT%&
3756 .oindex "&%-MCT%&"
3757 This option is not intended for use by external callers. It is used internally
3758 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3759 host to which Exim is connected supports TLS encryption.
3760
3761 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3762 .oindex "&%-Mc%&"
3763 .cindex "hints database" "not overridden by &%-Mc%&"
3764 .cindex "delivery" "manually started &-- not forced"
3765 This option requests Exim to run a delivery attempt on each message in turn,
3766 but unlike the &%-M%& option, it does check for retry hints, and respects any
3767 that are found. This option is not very useful to external callers. It is
3768 provided mainly for internal use by Exim when it needs to re-invoke itself in
3769 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3770 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3771 respects retry times and other options such as &%hold_domains%& that are
3772 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3773 If you want to run a specific delivery as if in a queue run, you should use
3774 &%-q%& with a message id argument. A distinction between queue run deliveries
3775 and other deliveries is made in one or two places.
3776
3777 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3778 .oindex "&%-Mes%&"
3779 .cindex "message" "changing sender"
3780 .cindex "sender" "changing"
3781 This option requests Exim to change the sender address in the message to the
3782 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3783 &"edit sender"&). There must be exactly two arguments. The first argument must
3784 be a message id, and the second one an email address. However, if the message
3785 is active (in the middle of a delivery attempt), its status is not altered.
3786 This option can be used only by an admin user.
3787
3788 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3789 .oindex "&%-Mf%&"
3790 .cindex "freezing messages"
3791 .cindex "message" "manually freezing"
3792 This option requests Exim to mark each listed message as &"frozen"&. This
3793 prevents any delivery attempts taking place until the message is &"thawed"&,
3794 either manually or as a result of the &%auto_thaw%& configuration option.
3795 However, if any of the messages are active (in the middle of a delivery
3796 attempt), their status is not altered. This option can be used only by an admin
3797 user.
3798
3799 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3800 .oindex "&%-Mg%&"
3801 .cindex "giving up on messages"
3802 .cindex "message" "abandoning delivery attempts"
3803 .cindex "delivery" "abandoning further attempts"
3804 This option requests Exim to give up trying to deliver the listed messages,
3805 including any that are frozen. However, if any of the messages are active,
3806 their status is not altered. For non-bounce messages, a delivery error message
3807 is sent to the sender, containing the text &"cancelled by administrator"&.
3808 Bounce messages are just discarded. This option can be used only by an admin
3809 user.
3810
3811 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3812 .oindex "&%-Mmad%&"
3813 .cindex "delivery" "cancelling all"
3814 This option requests Exim to mark all the recipient addresses in the messages
3815 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3816 message is active (in the middle of a delivery attempt), its status is not
3817 altered. This option can be used only by an admin user.
3818
3819 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3820 .oindex "&%-Mmd%&"
3821 .cindex "delivery" "cancelling by address"
3822 .cindex "recipient" "removing"
3823 .cindex "removing recipients"
3824 This option requests Exim to mark the given addresses as already delivered
3825 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3826 the remaining ones must be email addresses. These are matched to recipient
3827 addresses in the message in a case-sensitive manner. If the message is active
3828 (in the middle of a delivery attempt), its status is not altered. This option
3829 can be used only by an admin user.
3830
3831 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3832 .oindex "&%-Mrm%&"
3833 .cindex "removing messages"
3834 .cindex "abandoning mail"
3835 .cindex "message" "manually discarding"
3836 This option requests Exim to remove the given messages from the queue. No
3837 bounce messages are sent; each message is simply forgotten. However, if any of
3838 the messages are active, their status is not altered. This option can be used
3839 only by an admin user or by the user who originally caused the message to be
3840 placed on the queue.
3841
3842 .vitem &%-Mset%&&~<&'message&~id'&>
3843 .oindex "&%-Mset%&
3844 .cindex "testing" "string expansion"
3845 .cindex "expansion" "testing"
3846 This option is useful only in conjunction with &%-be%& (that is, when testing
3847 string expansions). Exim loads the given message from its spool before doing
3848 the test expansions, thus setting message-specific variables such as
3849 &$message_size$& and the header variables. The &$recipients$& variable is made
3850 available. This feature is provided to make it easier to test expansions that
3851 make use of these variables. However, this option can be used only by an admin
3852 user. See also &%-bem%&.
3853
3854 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3855 .oindex "&%-Mt%&"
3856 .cindex "thawing messages"
3857 .cindex "unfreezing messages"
3858 .cindex "frozen messages" "thawing"
3859 .cindex "message" "thawing frozen"
3860 This option requests Exim to &"thaw"& any of the listed messages that are
3861 &"frozen"&, so that delivery attempts can resume. However, if any of the
3862 messages are active, their status is not altered. This option can be used only
3863 by an admin user.
3864
3865 .vitem &%-Mvb%&&~<&'message&~id'&>
3866 .oindex "&%-Mvb%&"
3867 .cindex "listing" "message body"
3868 .cindex "message" "listing body of"
3869 This option causes the contents of the message body (-D) spool file to be
3870 written to the standard output. This option can be used only by an admin user.
3871
3872 .vitem &%-Mvc%&&~<&'message&~id'&>
3873 .oindex "&%-Mvc%&"
3874 .cindex "message" "listing in RFC 2822 format"
3875 .cindex "listing" "message in RFC 2822 format"
3876 This option causes a copy of the complete message (header lines plus body) to
3877 be written to the standard output in RFC 2822 format. This option can be used
3878 only by an admin user.
3879
3880 .vitem &%-Mvh%&&~<&'message&~id'&>
3881 .oindex "&%-Mvh%&"
3882 .cindex "listing" "message headers"
3883 .cindex "header lines" "listing"
3884 .cindex "message" "listing header lines"
3885 This option causes the contents of the message headers (-H) spool file to be
3886 written to the standard output. This option can be used only by an admin user.
3887
3888 .vitem &%-Mvl%&&~<&'message&~id'&>
3889 .oindex "&%-Mvl%&"
3890 .cindex "listing" "message log"
3891 .cindex "message" "listing message log"
3892 This option causes the contents of the message log spool file to be written to
3893 the standard output. This option can be used only by an admin user.
3894
3895 .vitem &%-m%&
3896 .oindex "&%-m%&"
3897 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3898 treats it that way too.
3899
3900 .vitem &%-N%&
3901 .oindex "&%-N%&"
3902 .cindex "debugging" "&%-N%& option"
3903 .cindex "debugging" "suppressing delivery"
3904 This is a debugging option that inhibits delivery of a message at the transport
3905 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3906 it just doesn't actually transport the message, but instead behaves as if it
3907 had successfully done so. However, it does not make any updates to the retry
3908 database, and the log entries for deliveries are flagged with &"*>"& rather
3909 than &"=>"&.
3910
3911 Because &%-N%& discards any message to which it applies, only root or the Exim
3912 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3913 words, an ordinary user can use it only when supplying an incoming message to
3914 which it will apply. Although transportation never fails when &%-N%& is set, an
3915 address may be deferred because of a configuration problem on a transport, or a
3916 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3917 the message, and applies to any subsequent delivery attempts that may happen
3918 for that message.
3919
3920 .vitem &%-n%&
3921 .oindex "&%-n%&"
3922 .cindex "Sendmail compatibility" "&%-n%& option ignored"
3923 This option is interpreted by Sendmail to mean &"no aliasing"&. It is ignored
3924 by Exim.
3925
3926 .vitem &%-O%&&~<&'data'&>
3927 .oindex "&%-O%&"
3928 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3929 Exim.
3930
3931 .vitem &%-oA%&&~<&'file&~name'&>
3932 .oindex "&%-oA%&"
3933 .cindex "Sendmail compatibility" "&%-oA%& option"
3934 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3935 alternative alias file name. Exim handles &%-bi%& differently; see the
3936 description above.
3937
3938 .vitem &%-oB%&&~<&'n'&>
3939 .oindex "&%-oB%&"
3940 .cindex "SMTP" "passed connection"
3941 .cindex "SMTP" "multiple deliveries"
3942 .cindex "multiple SMTP deliveries"
3943 This is a debugging option which limits the maximum number of messages that can
3944 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
3945 transport. If <&'n'&> is omitted, the limit is set to 1.
3946
3947 .vitem &%-odb%&
3948 .oindex "&%-odb%&"
3949 .cindex "background delivery"
3950 .cindex "delivery" "in the background"
3951 This option applies to all modes in which Exim accepts incoming messages,
3952 including the listening daemon. It requests &"background"& delivery of such
3953 messages, which means that the accepting process automatically starts a
3954 delivery process for each message received, but does not wait for the delivery
3955 processes to finish.
3956
3957 When all the messages have been received, the reception process exits,
3958 leaving the delivery processes to finish in their own time. The standard output
3959 and error streams are closed at the start of each delivery process.
3960 This is the default action if none of the &%-od%& options are present.
3961
3962 If one of the queueing options in the configuration file
3963 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
3964 overrides it if &%queue_only_override%& is set true, which is the default
3965 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
3966
3967 .vitem &%-odf%&
3968 .oindex "&%-odf%&"
3969 .cindex "foreground delivery"
3970 .cindex "delivery" "in the foreground"
3971 This option requests &"foreground"& (synchronous) delivery when Exim has
3972 accepted a locally-generated message. (For the daemon it is exactly the same as
3973 &%-odb%&.) A delivery process is automatically started to deliver the message,
3974 and Exim waits for it to complete before proceeding.
3975
3976 The original Exim reception process does not finish until the delivery
3977 process for the final message has ended. The standard error stream is left open
3978 during deliveries.
3979
3980 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
3981 false and one of the queueing options in the configuration file is in effect.
3982
3983 If there is a temporary delivery error during foreground delivery, the
3984 message is left on the queue for later delivery, and the original reception
3985 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
3986 restricted configuration that never queues messages.
3987
3988
3989 .vitem &%-odi%&
3990 .oindex "&%-odi%&"
3991 This option is synonymous with &%-odf%&. It is provided for compatibility with
3992 Sendmail.
3993
3994 .vitem &%-odq%&
3995 .oindex "&%-odq%&"
3996 .cindex "non-immediate delivery"
3997 .cindex "delivery" "suppressing immediate"
3998 .cindex "queueing incoming messages"
3999 This option applies to all modes in which Exim accepts incoming messages,
4000 including the listening daemon. It specifies that the accepting process should
4001 not automatically start a delivery process for each message received. Messages
4002 are placed on the queue, and remain there until a subsequent queue runner
4003 process encounters them. There are several configuration options (such as
4004 &%queue_only%&) that can be used to queue incoming messages under certain
4005 conditions. This option overrides all of them and also &%-odqs%&. It always
4006 forces queueing.
4007
4008 .vitem &%-odqs%&
4009 .oindex "&%-odqs%&"
4010 .cindex "SMTP" "delaying delivery"
4011 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4012 However, like &%-odb%& and &%-odi%&, this option has no effect if
4013 &%queue_only_override%& is false and one of the queueing options in the
4014 configuration file is in effect.
4015
4016 When &%-odqs%& does operate, a delivery process is started for each incoming
4017 message, in the background by default, but in the foreground if &%-odi%& is
4018 also present. The recipient addresses are routed, and local deliveries are done
4019 in the normal way. However, if any SMTP deliveries are required, they are not
4020 done at this time, so the message remains on the queue until a subsequent queue
4021 runner process encounters it. Because routing was done, Exim knows which
4022 messages are waiting for which hosts, and so a number of messages for the same
4023 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4024 configuration option has the same effect for specific domains. See also the
4025 &%-qq%& option.
4026
4027 .vitem &%-oee%&
4028 .oindex "&%-oee%&"
4029 .cindex "error" "reporting"
4030 If an error is detected while a non-SMTP message is being received (for
4031 example, a malformed address), the error is reported to the sender in a mail
4032 message.
4033
4034 .cindex "return code" "for &%-oee%&"
4035 Provided
4036 this error message is successfully sent, the Exim receiving process
4037 exits with a return code of zero. If not, the return code is 2 if the problem
4038 is that the original message has no recipients, or 1 any other error. This is
4039 the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4040
4041 .vitem &%-oem%&
4042 .oindex "&%-oem%&"
4043 .cindex "error" "reporting"
4044 .cindex "return code" "for &%-oem%&"
4045 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4046 return code, whether or not the error message was successfully sent.
4047 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4048
4049 .vitem &%-oep%&
4050 .oindex "&%-oep%&"
4051 .cindex "error" "reporting"
4052 If an error is detected while a non-SMTP message is being received, the
4053 error is reported by writing a message to the standard error file (stderr).
4054 .cindex "return code" "for &%-oep%&"
4055 The return code is 1 for all errors.
4056
4057 .vitem &%-oeq%&
4058 .oindex "&%-oeq%&"
4059 .cindex "error" "reporting"
4060 This option is supported for compatibility with Sendmail, but has the same
4061 effect as &%-oep%&.
4062
4063 .vitem &%-oew%&
4064 .oindex "&%-oew%&"
4065 .cindex "error" "reporting"
4066 This option is supported for compatibility with Sendmail, but has the same
4067 effect as &%-oem%&.
4068
4069 .vitem &%-oi%&
4070 .oindex "&%-oi%&"
4071 .cindex "dot" "in incoming non-SMTP message"
4072 This option, which has the same effect as &%-i%&, specifies that a dot on a
4073 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4074 single dot does terminate, though Exim does no special processing for other
4075 lines that start with a dot. This option is set by default if Exim is called as
4076 &'rmail'&. See also &%-ti%&.
4077
4078 .vitem &%-oitrue%&
4079 .oindex "&%-oitrue%&"
4080 This option is treated as synonymous with &%-oi%&.
4081
4082 .vitem &%-oMa%&&~<&'host&~address'&>
4083 .oindex "&%-oMa%&"
4084 .cindex "sender" "host address, specifying for local message"
4085 A number of options starting with &%-oM%& can be used to set values associated
4086 with remote hosts on locally-submitted messages (that is, messages not received
4087 over TCP/IP). These options can be used by any caller in conjunction with the
4088 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4089 other circumstances, they are ignored unless the caller is trusted.
4090
4091 The &%-oMa%& option sets the sender host address. This may include a port
4092 number at the end, after a full stop (period). For example:
4093 .code
4094 exim -bs -oMa 10.9.8.7.1234
4095 .endd
4096 An alternative syntax is to enclose the IP address in square brackets,
4097 followed by a colon and the port number:
4098 .code
4099 exim -bs -oMa [10.9.8.7]:1234
4100 .endd
4101 The IP address is placed in the &$sender_host_address$& variable, and the
4102 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4103 are present on the command line, the sender host IP address is taken from
4104 whichever one is last.
4105
4106 .vitem &%-oMaa%&&~<&'name'&>
4107 .oindex "&%-oMaa%&"
4108 .cindex "authentication" "name, specifying for local message"
4109 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4110 option sets the value of &$sender_host_authenticated$& (the authenticator
4111 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4112 This option can be used with &%-bh%& and &%-bs%& to set up an
4113 authenticated SMTP session without actually using the SMTP AUTH command.
4114
4115 .vitem &%-oMai%&&~<&'string'&>
4116 .oindex "&%-oMai%&"
4117 .cindex "authentication" "id, specifying for local message"
4118 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4119 option sets the value of &$authenticated_id$& (the id that was authenticated).
4120 This overrides the default value (the caller's login id, except with &%-bh%&,
4121 where there is no default) for messages from local sources. See chapter
4122 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4123
4124 .vitem &%-oMas%&&~<&'address'&>
4125 .oindex "&%-oMas%&"
4126 .cindex "authentication" "sender, specifying for local message"
4127 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4128 option sets the authenticated sender value in &$authenticated_sender$&. It
4129 overrides the sender address that is created from the caller's login id for
4130 messages from local sources, except when &%-bh%& is used, when there is no
4131 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4132 specified on a MAIL command overrides this value. See chapter
4133 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4134
4135 .vitem &%-oMi%&&~<&'interface&~address'&>
4136 .oindex "&%-oMi%&"
4137 .cindex "interface" "address, specifying for local message"
4138 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4139 option sets the IP interface address value. A port number may be included,
4140 using the same syntax as for &%-oMa%&. The interface address is placed in
4141 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4142
4143 .vitem &%-oMr%&&~<&'protocol&~name'&>
4144 .oindex "&%-oMr%&"
4145 .cindex "protocol, specifying for local message"
4146 .vindex "&$received_protocol$&"
4147 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4148 option sets the received protocol value that is stored in
4149 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4150 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4151 SMTP protocol names (see the description of &$received_protocol$& in section
4152 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4153 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4154 be set by &%-oMr%&.
4155
4156 .vitem &%-oMs%&&~<&'host&~name'&>
4157 .oindex "&%-oMs%&"
4158 .cindex "sender" "host name, specifying for local message"
4159 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4160 option sets the sender host name in &$sender_host_name$&. When this option is
4161 present, Exim does not attempt to look up a host name from an IP address; it
4162 uses the name it is given.
4163
4164 .vitem &%-oMt%&&~<&'ident&~string'&>
4165 .oindex "&%-oMt%&"
4166 .cindex "sender" "ident string, specifying for local message"
4167 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4168 option sets the sender ident value in &$sender_ident$&. The default setting for
4169 local callers is the login id of the calling process, except when &%-bh%& is
4170 used, when there is no default.
4171
4172 .vitem &%-om%&
4173 .oindex "&%-om%&"
4174 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4175 In Sendmail, this option means &"me too"&, indicating that the sender of a
4176 message should receive a copy of the message if the sender appears in an alias
4177 expansion. Exim always does this, so the option does nothing.
4178
4179 .vitem &%-oo%&
4180 .oindex "&%-oo%&"
4181 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4182 This option is ignored. In Sendmail it specifies &"old style headers"&,
4183 whatever that means.
4184
4185 .vitem &%-oP%&&~<&'path'&>
4186 .oindex "&%-oP%&"
4187 .cindex "pid (process id)" "of daemon"
4188 .cindex "daemon" "process id (pid)"
4189 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4190 value. The option specifies the file to which the process id of the daemon is
4191 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4192 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4193 because in those cases, the normal pid file is not used.
4194
4195 .vitem &%-or%&&~<&'time'&>
4196 .oindex "&%-or%&"
4197 .cindex "timeout" "for non-SMTP input"
4198 This option sets a timeout value for incoming non-SMTP messages. If it is not
4199 set, Exim will wait forever for the standard input. The value can also be set
4200 by the &%receive_timeout%& option. The format used for specifying times is
4201 described in section &<<SECTtimeformat>>&.
4202
4203 .vitem &%-os%&&~<&'time'&>
4204 .oindex "&%-os%&"
4205 .cindex "timeout" "for SMTP input"
4206 .cindex "SMTP" "input timeout"
4207 This option sets a timeout value for incoming SMTP messages. The timeout
4208 applies to each SMTP command and block of data. The value can also be set by
4209 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4210 for specifying times is described in section &<<SECTtimeformat>>&.
4211
4212 .vitem &%-ov%&
4213 .oindex "&%-ov%&"
4214 This option has exactly the same effect as &%-v%&.
4215
4216 .vitem &%-oX%&&~<&'number&~or&~string'&>
4217 .oindex "&%-oX%&"
4218 .cindex "TCP/IP" "setting listening ports"
4219 .cindex "TCP/IP" "setting listening interfaces"
4220 .cindex "port" "receiving TCP/IP"
4221 This option is relevant only when the &%-bd%& (start listening daemon) option
4222 is also given. It controls which ports and interfaces the daemon uses. Details
4223 of the syntax, and how it interacts with configuration file options, are given
4224 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4225 file is written unless &%-oP%& is also present to specify a pid file name.
4226
4227 .vitem &%-pd%&
4228 .oindex "&%-pd%&"
4229 .cindex "Perl" "starting the interpreter"
4230 This option applies when an embedded Perl interpreter is linked with Exim (see
4231 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4232 option, forcing the starting of the interpreter to be delayed until it is
4233 needed.
4234
4235 .vitem &%-ps%&
4236 .oindex "&%-ps%&"
4237 .cindex "Perl" "starting the interpreter"
4238 This option applies when an embedded Perl interpreter is linked with Exim (see
4239 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4240 option, forcing the starting of the interpreter to occur as soon as Exim is
4241 started.
4242
4243 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4244 .oindex "&%-p%&"
4245 For compatibility with Sendmail, this option is equivalent to
4246 .display
4247 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4248 .endd
4249 It sets the incoming protocol and host name (for trusted callers). The
4250 host name and its colon can be omitted when only the protocol is to be set.
4251 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4252 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4253 or &`s`& using this option (but that does not seem a real limitation).
4254
4255 .vitem &%-q%&
4256 .oindex "&%-q%&"
4257 .cindex "queue runner" "starting manually"
4258 This option is normally restricted to admin users. However, there is a
4259 configuration option called &%prod_requires_admin%& which can be set false to
4260 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4261 and &%-S%& options).
4262
4263 .cindex "queue runner" "description of operation"
4264 The &%-q%& option starts one queue runner process. This scans the queue of
4265 waiting messages, and runs a delivery process for each one in turn. It waits
4266 for each delivery process to finish before starting the next one. A delivery
4267 process may not actually do any deliveries if the retry times for the addresses
4268 have not been reached. Use &%-qf%& (see below) if you want to override this.
4269
4270 If
4271 .cindex "SMTP" "passed connection"
4272 .cindex "SMTP" "multiple deliveries"
4273 .cindex "multiple SMTP deliveries"
4274 the delivery process spawns other processes to deliver other messages down
4275 passed SMTP connections, the queue runner waits for these to finish before
4276 proceeding.
4277
4278 When all the queued messages have been considered, the original queue runner
4279 process terminates. In other words, a single pass is made over the waiting
4280 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4281 this to be repeated periodically.
4282
4283 Exim processes the waiting messages in an unpredictable order. It isn't very
4284 random, but it is likely to be different each time, which is all that matters.
4285 If one particular message screws up a remote MTA, other messages to the same
4286 MTA have a chance of getting through if they get tried first.
4287
4288 It is possible to cause the messages to be processed in lexical message id
4289 order, which is essentially the order in which they arrived, by setting the
4290 &%queue_run_in_order%& option, but this is not recommended for normal use.
4291
4292 .vitem &%-q%&<&'qflags'&>
4293 The &%-q%& option may be followed by one or more flag letters that change its
4294 behaviour. They are all optional, but if more than one is present, they must
4295 appear in the correct order. Each flag is described in a separate item below.
4296
4297 .vitem &%-qq...%&
4298 .oindex "&%-qq%&"
4299 .cindex "queue" "double scanning"
4300 .cindex "queue" "routing"
4301 .cindex "routing" "whole queue before delivery"
4302 An option starting with &%-qq%& requests a two-stage queue run. In the first
4303 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4304 every domain. Addresses are routed, local deliveries happen, but no remote
4305 transports are run.
4306
4307 .cindex "hints database" "remembering routing"
4308 The hints database that remembers which messages are waiting for specific hosts
4309 is updated, as if delivery to those hosts had been deferred. After this is
4310 complete, a second, normal queue scan happens, with routing and delivery taking
4311 place as normal. Messages that are routed to the same host should mostly be
4312 delivered down a single SMTP
4313 .cindex "SMTP" "passed connection"
4314 .cindex "SMTP" "multiple deliveries"
4315 .cindex "multiple SMTP deliveries"
4316 connection because of the hints that were set up during the first queue scan.
4317 This option may be useful for hosts that are connected to the Internet
4318 intermittently.
4319
4320 .vitem &%-q[q]i...%&
4321 .oindex "&%-qi%&"
4322 .cindex "queue" "initial delivery"
4323 If the &'i'& flag is present, the queue runner runs delivery processes only for
4324 those messages that haven't previously been tried. (&'i'& stands for &"initial
4325 delivery"&.) This can be helpful if you are putting messages on the queue using
4326 &%-odq%& and want a queue runner just to process the new messages.
4327
4328 .vitem &%-q[q][i]f...%&
4329 .oindex "&%-qf%&"
4330 .cindex "queue" "forcing delivery"
4331 .cindex "delivery" "forcing in queue run"
4332 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4333 message, whereas without &'f'& only those non-frozen addresses that have passed
4334 their retry times are tried.
4335
4336 .vitem &%-q[q][i]ff...%&
4337 .oindex "&%-qff%&"
4338 .cindex "frozen messages" "forcing delivery"
4339 If &'ff'& is present, a delivery attempt is forced for every message, whether
4340 frozen or not.
4341
4342 .vitem &%-q[q][i][f[f]]l%&
4343 .oindex "&%-ql%&"
4344 .cindex "queue" "local deliveries only"
4345 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4346 be done. If a message requires any remote deliveries, it remains on the queue
4347 for later delivery.
4348
4349 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4350 .cindex "queue" "delivering specific messages"
4351 When scanning the queue, Exim can be made to skip over messages whose ids are
4352 lexically less than a given value by following the &%-q%& option with a
4353 starting message id. For example:
4354 .code
4355 exim -q 0t5C6f-0000c8-00
4356 .endd
4357 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4358 second message id is given, messages whose ids are lexically greater than it
4359 are also skipped. If the same id is given twice, for example,
4360 .code
4361 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4362 .endd
4363 just one delivery process is started, for that message. This differs from
4364 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4365 that it counts as a delivery from a queue run. Note that the selection
4366 mechanism does not affect the order in which the messages are scanned. There
4367 are also other ways of selecting specific sets of messages for delivery in a
4368 queue run &-- see &%-R%& and &%-S%&.
4369
4370 .vitem &%-q%&<&'qflags'&><&'time'&>
4371 .cindex "queue runner" "starting periodically"
4372 .cindex "periodic queue running"
4373 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4374 starting a queue runner process at intervals specified by the given time value
4375 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4376 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4377 single daemon process handles both functions. A common way of starting up a
4378 combined daemon at system boot time is to use a command such as
4379 .code
4380 /usr/exim/bin/exim -bd -q30m
4381 .endd
4382 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4383 process every 30 minutes.
4384
4385 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4386 pid file is written unless one is explicitly requested by the &%-oP%& option.
4387
4388 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4389 .oindex "&%-qR%&"
4390 This option is synonymous with &%-R%&. It is provided for Sendmail
4391 compatibility.
4392
4393 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4394 .oindex "&%-qS%&"
4395 This option is synonymous with &%-S%&.
4396
4397 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4398 .oindex "&%-R%&"
4399 .cindex "queue runner" "for specific recipients"
4400 .cindex "delivery" "to given domain"
4401 .cindex "domain" "delivery to"
4402 The <&'rsflags'&> may be empty, in which case the white space before the string
4403 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4404 which are the possible values for <&'rsflags'&>. White space is required if
4405 <&'rsflags'&> is not empty.
4406
4407 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4408 perform a single queue run, except that, when scanning the messages on the
4409 queue, Exim processes only those that have at least one undelivered recipient
4410 address containing the given string, which is checked in a case-independent
4411 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4412 regular expression; otherwise it is a literal string.
4413
4414 If you want to do periodic queue runs for messages with specific recipients,
4415 you can combine &%-R%& with &%-q%& and a time value. For example:
4416 .code
4417 exim -q25m -R @special.domain.example
4418 .endd
4419 This example does a queue run for messages with recipients in the given domain
4420 every 25 minutes. Any additional flags that are specified with &%-q%& are
4421 applied to each queue run.
4422
4423 Once a message is selected for delivery by this mechanism, all its addresses
4424 are processed. For the first selected message, Exim overrides any retry
4425 information and forces a delivery attempt for each undelivered address. This
4426 means that if delivery of any address in the first message is successful, any
4427 existing retry information is deleted, and so delivery attempts for that
4428 address in subsequently selected messages (which are processed without forcing)
4429 will run. However, if delivery of any address does not succeed, the retry
4430 information is updated, and in subsequently selected messages, the failing
4431 address will be skipped.
4432
4433 .cindex "frozen messages" "forcing delivery"
4434 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4435 all selected messages, not just the first; frozen messages are included when
4436 &'ff'& is present.
4437
4438 The &%-R%& option makes it straightforward to initiate delivery of all messages
4439 to a given domain after a host has been down for some time. When the SMTP
4440 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4441 effect is to run Exim with the &%-R%& option, but it can be configured to run
4442 an arbitrary command instead.
4443
4444 .vitem &%-r%&
4445 .oindex "&%-r%&"
4446 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4447
4448 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4449 .oindex "&%-S%&"
4450 .cindex "delivery" "from given sender"
4451 .cindex "queue runner" "for specific senders"
4452 This option acts like &%-R%& except that it checks the string against each
4453 message's sender instead of against the recipients. If &%-R%& is also set, both
4454 conditions must be met for a message to be selected. If either of the options
4455 has &'f'& or &'ff'& in its flags, the associated action is taken.
4456
4457 .vitem &%-Tqt%&&~<&'times'&>
4458 .oindex "&%-Tqt%&"
4459 This an option that is exclusively for use by the Exim testing suite. It is not
4460 recognized when Exim is run normally. It allows for the setting up of explicit
4461 &"queue times"& so that various warning/retry features can be tested.
4462
4463 .vitem &%-t%&
4464 .oindex "&%-t%&"
4465 .cindex "recipient" "extracting from header lines"
4466 .cindex "&'Bcc:'& header line"
4467 .cindex "&'Cc:'& header line"
4468 .cindex "&'To:'& header line"
4469 When Exim is receiving a locally-generated, non-SMTP message on its standard
4470 input, the &%-t%& option causes the recipients of the message to be obtained
4471 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4472 from the command arguments. The addresses are extracted before any rewriting
4473 takes place and the &'Bcc:'& header line, if present, is then removed.
4474
4475 .cindex "Sendmail compatibility" "&%-t%& option"
4476 If the command has any arguments, they specify addresses to which the message
4477 is &'not'& to be delivered. That is, the argument addresses are removed from
4478 the recipients list obtained from the headers. This is compatible with Smail 3
4479 and in accordance with the documented behaviour of several versions of
4480 Sendmail, as described in man pages on a number of operating systems (e.g.
4481 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4482 argument addresses to those obtained from the headers, and the O'Reilly
4483 Sendmail book documents it that way. Exim can be made to add argument addresses
4484 instead of subtracting them by setting the option
4485 &%extract_addresses_remove_arguments%& false.
4486
4487 .cindex "&%Resent-%& header lines" "with &%-t%&"
4488 If there are any &%Resent-%& header lines in the message, Exim extracts
4489 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4490 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4491 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4492 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4493
4494 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4495 message is resent several times). The RFC also specifies that they should be
4496 added at the front of the message, and separated by &'Received:'& lines. It is
4497 not at all clear how &%-t%& should operate in the present of multiple sets,
4498 nor indeed exactly what constitutes a &"set"&.
4499 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4500 are often added at the end of the header, and if a message is resent more than
4501 once, it is common for the original set of &%Resent-%& headers to be renamed as
4502 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4503
4504 .vitem &%-ti%&
4505 .oindex "&%-ti%&"
4506 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4507 compatibility with Sendmail.
4508
4509 .vitem &%-tls-on-connect%&
4510 .oindex "&%-tls-on-connect%&"
4511 .cindex "TLS" "use without STARTTLS"
4512 .cindex "TLS" "automatic start"
4513 This option is available when Exim is compiled with TLS support. It forces all
4514 incoming SMTP connections to behave as if the incoming port is listed in the
4515 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4516 &<<CHAPTLS>>& for further details.
4517
4518
4519 .vitem &%-U%&
4520 .oindex "&%-U%&"
4521 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4522 Sendmail uses this option for &"initial message submission"&, and its
4523 documentation states that in future releases, it may complain about
4524 syntactically invalid messages rather than fixing them when this flag is not
4525 set. Exim ignores this option.
4526
4527 .vitem &%-v%&
4528 .oindex "&%-v%&"
4529 This option causes Exim to write information to the standard error stream,
4530 describing what it is doing. In particular, it shows the log lines for
4531 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4532 dialogue is shown. Some of the log lines shown may not actually be written to
4533 the log if the setting of &%log_selector%& discards them. Any relevant
4534 selectors are shown with each log line. If none are shown, the logging is
4535 unconditional.
4536
4537 .vitem &%-x%&
4538 .oindex "&%-x%&"
4539 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4540 National Language Support extended characters in the body of the mail item"&).
4541 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4542 this option.
4543 .endlist
4544
4545 .ecindex IIDclo1
4546 .ecindex IIDclo2
4547
4548
4549 . ////////////////////////////////////////////////////////////////////////////
4550 . Insert a stylized DocBook comment here, to identify the end of the command
4551 . line options. This is for the benefit of the Perl script that automatically
4552 . creates a man page for the options.
4553 . ////////////////////////////////////////////////////////////////////////////
4554
4555 .literal xml
4556 <!-- === End of command line options === -->
4557 .literal off
4558
4559
4560
4561
4562
4563 . ////////////////////////////////////////////////////////////////////////////
4564 . ////////////////////////////////////////////////////////////////////////////
4565
4566
4567 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4568          "The runtime configuration file"
4569
4570 .cindex "run time configuration"
4571 .cindex "configuration file" "general description"
4572 .cindex "CONFIGURE_FILE"
4573 .cindex "configuration file" "errors in"
4574 .cindex "error" "in configuration file"
4575 .cindex "return code" "for bad configuration"
4576 Exim uses a single run time configuration file that is read whenever an Exim
4577 binary is executed. Note that in normal operation, this happens frequently,
4578 because Exim is designed to operate in a distributed manner, without central
4579 control.
4580
4581 If a syntax error is detected while reading the configuration file, Exim
4582 writes a message on the standard error, and exits with a non-zero return code.
4583 The message is also written to the panic log. &*Note*&: Only simple syntax
4584 errors can be detected at this time. The values of any expanded options are
4585 not checked until the expansion happens, even when the expansion does not
4586 actually alter the string.
4587
4588 The name of the configuration file is compiled into the binary for security
4589 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4590 most configurations, this specifies a single file. However, it is permitted to
4591 give a colon-separated list of file names, in which case Exim uses the first
4592 existing file in the list.
4593
4594 .cindex "EXIM_USER"
4595 .cindex "EXIM_GROUP"
4596 .cindex "CONFIGURE_OWNER"
4597 .cindex "CONFIGURE_GROUP"
4598 .cindex "configuration file" "ownership"
4599 .cindex "ownership" "configuration file"
4600 The run time configuration file must be owned by root or by the user that is
4601 specified at compile time by the CONFIGURE_OWNER option (if set). The
4602 configuration file must not be world-writeable, or group-writeable unless its
4603 group is the root group or the one specified at compile time by the
4604 CONFIGURE_GROUP option.
4605
4606 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4607 to root, anybody who is able to edit the run time configuration file has an
4608 easy way to run commands as root. If you specify a user or group in the
4609 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4610 who are members of that group will trivially be able to obtain root privileges.
4611
4612 Up to Exim version 4.72, the run time configuration file was also permitted to
4613 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4614 since it offered a simple privilege escalation for any attacker who managed to
4615 compromise the Exim user account.
4616
4617 A default configuration file, which will work correctly in simple situations,
4618 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4619 defines just one file name, the installation process copies the default
4620 configuration to a new file of that name if it did not previously exist. If
4621 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4622 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4623 configuration.
4624
4625
4626
4627 .section "Using a different configuration file" "SECID40"
4628 .cindex "configuration file" "alternate"
4629 A one-off alternate configuration can be specified by the &%-C%& command line
4630 option, which may specify a single file or a list of files. However, when
4631 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4632 unless the argument for &%-C%& is identical to the built-in value from
4633 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4634 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4635 is useful mainly for checking the syntax of configuration files before
4636 installing them. No owner or group checks are done on a configuration file
4637 specified by &%-C%&, if root privilege has been dropped.
4638
4639 Even the Exim user is not trusted to specify an arbitrary configuration file
4640 with the &%-C%& option to be used with root privileges, unless that file is
4641 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4642 testing a configuration using &%-C%& right through message reception and
4643 delivery, even if the caller is root. The reception works, but by that time,
4644 Exim is running as the Exim user, so when it re-execs to regain privilege for
4645 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4646 can test reception and delivery using two separate commands (one to put a
4647 message on the queue, using &%-odq%&, and another to do the delivery, using
4648 &%-M%&).
4649
4650 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4651 prefix string with which any file named in a &%-C%& command line option must
4652 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4653 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4654 name can be used with &%-C%&.
4655
4656 One-off changes to a configuration can be specified by the &%-D%& command line
4657 option, which defines and overrides values for macros used inside the
4658 configuration file. However, like &%-C%&, the use of this option by a
4659 non-privileged user causes Exim to discard its root privilege.
4660 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4661 completely disabled, and its use causes an immediate error exit.
4662
4663 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4664 to declare certain macro names trusted, such that root privilege will not
4665 necessarily be discarded.
4666 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4667 considered safe and, if &%-D%& only supplies macros from this list, and the
4668 values are acceptable, then Exim will not give up root privilege if the caller
4669 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4670 transition mechanism and is expected to be removed in the future.  Acceptable
4671 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4672
4673 Some sites may wish to use the same Exim binary on different machines that
4674 share a file system, but to use different configuration files on each machine.
4675 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4676 looks for a file whose name is the configuration file name followed by a dot
4677 and the machine's node name, as obtained from the &[uname()]& function. If this
4678 file does not exist, the standard name is tried. This processing occurs for
4679 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4680
4681 In some esoteric situations different versions of Exim may be run under
4682 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4683 help with this. See the comments in &_src/EDITME_& for details.
4684
4685
4686
4687 .section "Configuration file format" "SECTconffilfor"
4688 .cindex "configuration file" "format of"
4689 .cindex "format" "configuration file"
4690 Exim's configuration file is divided into a number of different parts. General
4691 option settings must always appear at the start of the file. The other parts
4692 are all optional, and may appear in any order. Each part other than the first
4693 is introduced by the word &"begin"& followed by the name of the part. The
4694 optional parts are:
4695
4696 .ilist
4697 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4698 &<<CHAPACL>>&).
4699 .next
4700 .cindex "AUTH" "configuration"
4701 &'authenticators'&: Configuration settings for the authenticator drivers. These
4702 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4703 .next
4704 &'routers'&: Configuration settings for the router drivers. Routers process
4705 addresses and determine how the message is to be delivered (see chapters
4706 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4707 .next
4708 &'transports'&: Configuration settings for the transport drivers. Transports
4709 define mechanisms for copying messages to destinations (see chapters
4710 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4711 .next
4712 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4713 If there is no retry section, or if it is empty (that is, no retry rules are
4714 defined), Exim will not retry deliveries. In this situation, temporary errors
4715 are treated the same as permanent errors. Retry rules are discussed in chapter
4716 &<<CHAPretry>>&.
4717 .next
4718 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4719 when new addresses are generated during delivery. Rewriting is discussed in
4720 chapter &<<CHAPrewrite>>&.
4721 .next
4722 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4723 want to use this feature, you must set
4724 .code
4725 LOCAL_SCAN_HAS_OPTIONS=yes
4726 .endd
4727 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4728 facility are given in chapter &<<CHAPlocalscan>>&.
4729 .endlist
4730
4731 .cindex "configuration file" "leading white space in"
4732 .cindex "configuration file" "trailing white space in"
4733 .cindex "white space" "in configuration file"
4734 Leading and trailing white space in configuration lines is always ignored.
4735
4736 Blank lines in the file, and lines starting with a # character (ignoring
4737 leading white space) are treated as comments and are ignored. &*Note*&: A
4738 # character other than at the beginning of a line is not treated specially,
4739 and does not introduce a comment.
4740
4741 Any non-comment line can be continued by ending it with a backslash. Note that
4742 the general rule for white space means that trailing white space after the
4743 backslash and leading white space at the start of continuation
4744 lines is ignored. Comment lines beginning with # (but not empty lines) may
4745 appear in the middle of a sequence of continuation lines.
4746
4747 A convenient way to create a configuration file is to start from the
4748 default, which is supplied in &_src/configure.default_&, and add, delete, or
4749 change settings as required.
4750
4751 The ACLs, retry rules, and rewriting rules have their own syntax which is
4752 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4753 respectively. The other parts of the configuration file have some syntactic
4754 items in common, and these are described below, from section &<<SECTcos>>&
4755 onwards. Before that, the inclusion, macro, and conditional facilities are
4756 described.
4757
4758
4759
4760 .section "File inclusions in the configuration file" "SECID41"
4761 .cindex "inclusions in configuration file"
4762 .cindex "configuration file" "including other files"
4763 .cindex "&`.include`& in configuration file"
4764 .cindex "&`.include_if_exists`& in configuration file"
4765 You can include other files inside Exim's run time configuration file by
4766 using this syntax:
4767 .display
4768 &`.include`& <&'file name'&>
4769 &`.include_if_exists`& <&'file name'&>
4770 .endd
4771 on a line by itself. Double quotes round the file name are optional. If you use
4772 the first form, a configuration error occurs if the file does not exist; the
4773 second form does nothing for non-existent files. In all cases, an absolute file
4774 name is required.
4775
4776 Includes may be nested to any depth, but remember that Exim reads its
4777 configuration file often, so it is a good idea to keep them to a minimum.
4778 If you change the contents of an included file, you must HUP the daemon,
4779 because an included file is read only when the configuration itself is read.
4780
4781 The processing of inclusions happens early, at a physical line level, so, like
4782 comment lines, an inclusion can be used in the middle of an option setting,
4783 for example:
4784 .code
4785 hosts_lookup = a.b.c \
4786                .include /some/file
4787 .endd
4788 Include processing happens after macro processing (see below). Its effect is to
4789 process the lines of the included file as if they occurred inline where the
4790 inclusion appears.
4791
4792
4793
4794 .section "Macros in the configuration file" "SECTmacrodefs"
4795 .cindex "macro" "description of"
4796 .cindex "configuration file" "macros"
4797 If a line in the main part of the configuration (that is, before the first
4798 &"begin"& line) begins with an upper case letter, it is taken as a macro
4799 definition, and must be of the form
4800 .display
4801 <&'name'&> = <&'rest of line'&>
4802 .endd
4803 The name must consist of letters, digits, and underscores, and need not all be
4804 in upper case, though that is recommended. The rest of the line, including any
4805 continuations, is the replacement text, and has leading and trailing white
4806 space removed. Quotes are not removed. The replacement text can never end with
4807 a backslash character, but this doesn't seem to be a serious limitation.
4808
4809 Macros may also be defined between router, transport, authenticator, or ACL
4810 definitions. They may not, however, be defined within an individual driver or
4811 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4812
4813 .section "Macro substitution" "SECID42"
4814 Once a macro is defined, all subsequent lines in the file (and any included
4815 files) are scanned for the macro name; if there are several macros, the line is
4816 scanned for each in turn, in the order in which the macros are defined. The
4817 replacement text is not re-scanned for the current macro, though it is scanned
4818 for subsequently defined macros. For this reason, a macro name may not contain
4819 the name of a previously defined macro as a substring. You could, for example,
4820 define
4821 .display
4822 &`ABCD_XYZ = `&<&'something'&>
4823 &`ABCD = `&<&'something else'&>
4824 .endd
4825 but putting the definitions in the opposite order would provoke a configuration
4826 error. Macro expansion is applied to individual physical lines from the file,
4827 before checking for line continuation or file inclusion (see above). If a line
4828 consists solely of a macro name, and the expansion of the macro is empty, the
4829 line is ignored. A macro at the start of a line may turn the line into a
4830 comment line or a &`.include`& line.
4831
4832
4833 .section "Redefining macros" "SECID43"
4834 Once defined, the value of a macro can be redefined later in the configuration
4835 (or in an included file). Redefinition is specified by using &'=='& instead of
4836 &'='&. For example:
4837 .code
4838 MAC =  initial value
4839 ...
4840 MAC == updated value
4841 .endd
4842 Redefinition does not alter the order in which the macros are applied to the
4843 subsequent lines of the configuration file. It is still the same order in which
4844 the macros were originally defined. All that changes is the macro's value.
4845 Redefinition makes it possible to accumulate values. For example:
4846 .code
4847 MAC =  initial value
4848 ...
4849 MAC == MAC and something added
4850 .endd
4851 This can be helpful in situations where the configuration file is built
4852 from a number of other files.
4853
4854 .section "Overriding macro values" "SECID44"
4855 The values set for macros in the configuration file can be overridden by the
4856 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4857 used, unless called by root or the Exim user. A definition on the command line
4858 using the &%-D%& option causes all definitions and redefinitions within the
4859 file to be ignored.
4860
4861
4862
4863 .section "Example of macro usage" "SECID45"
4864 As an example of macro usage, consider a configuration where aliases are looked
4865 up in a MySQL database. It helps to keep the file less cluttered if long
4866 strings such as SQL statements are defined separately as macros, for example:
4867 .code
4868 ALIAS_QUERY = select mailbox from user where \
4869               login='${quote_mysql:$local_part}';
4870 .endd
4871 This can then be used in a &(redirect)& router setting like this:
4872 .code
4873 data = ${lookup mysql{ALIAS_QUERY}}
4874 .endd
4875 In earlier versions of Exim macros were sometimes used for domain, host, or
4876 address lists. In Exim 4 these are handled better by named lists &-- see
4877 section &<<SECTnamedlists>>&.
4878
4879
4880 .section "Conditional skips in the configuration file" "SECID46"
4881 .cindex "configuration file" "conditional skips"
4882 .cindex "&`.ifdef`&"
4883 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4884 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4885 portions of the configuration file. The processing happens whenever the file is
4886 read (that is, when an Exim binary starts to run).
4887
4888 The implementation is very simple. Instances of the first four directives must
4889 be followed by text that includes the names of one or macros. The condition
4890 that is tested is whether or not any macro substitution has taken place in the
4891 line. Thus:
4892 .code
4893 .ifdef AAA
4894 message_size_limit = 50M
4895 .else
4896 message_size_limit = 100M
4897 .endif
4898 .endd
4899 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4900 otherwise. If there is more than one macro named on the line, the condition
4901 is true if any of them are defined. That is, it is an &"or"& condition. To
4902 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4903
4904 Although you can use a macro expansion to generate one of these directives,
4905 it is not very useful, because the condition &"there was a macro substitution
4906 in this line"& will always be true.
4907
4908 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4909 to clarify complicated nestings.
4910
4911
4912
4913 .section "Common option syntax" "SECTcos"
4914 .cindex "common option syntax"
4915 .cindex "syntax of common options"
4916 .cindex "configuration file" "common option syntax"
4917 For the main set of options, driver options, and &[local_scan()]& options,
4918 each setting is on a line by itself, and starts with a name consisting of
4919 lower-case letters and underscores. Many options require a data value, and in
4920 these cases the name must be followed by an equals sign (with optional white
4921 space) and then the value. For example:
4922 .code
4923 qualify_domain = mydomain.example.com
4924 .endd
4925 .cindex "hiding configuration option values"
4926 .cindex "configuration options" "hiding value of"
4927 .cindex "options" "hiding value of"
4928 Some option settings may contain sensitive data, for example, passwords for
4929 accessing databases. To stop non-admin users from using the &%-bP%& command
4930 line option to read these values, you can precede the option settings with the
4931 word &"hide"&. For example:
4932 .code
4933 hide mysql_servers = localhost/users/admin/secret-password
4934 .endd
4935 For non-admin users, such options are displayed like this:
4936 .code
4937 mysql_servers = <value not displayable>
4938 .endd
4939 If &"hide"& is used on a driver option, it hides the value of that option on
4940 all instances of the same driver.
4941
4942 The following sections describe the syntax used for the different data types
4943 that are found in option settings.
4944
4945
4946 .section "Boolean options" "SECID47"
4947 .cindex "format" "boolean"
4948 .cindex "boolean configuration values"
4949 .oindex "&%no_%&&'xxx'&"
4950 .oindex "&%not_%&&'xxx'&"
4951 Options whose type is given as boolean are on/off switches. There are two
4952 different ways of specifying such options: with and without a data value. If
4953 the option name is specified on its own without data, the switch is turned on;
4954 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
4955 boolean options may be followed by an equals sign and one of the words
4956 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
4957 the following two settings have exactly the same effect:
4958 .code
4959 queue_only
4960 queue_only = true
4961 .endd
4962 The following two lines also have the same (opposite) effect:
4963 .code
4964 no_queue_only
4965 queue_only = false
4966 .endd
4967 You can use whichever syntax you prefer.
4968
4969
4970
4971
4972 .section "Integer values" "SECID48"
4973 .cindex "integer configuration values"
4974 .cindex "format" "integer"
4975 If an option's type is given as &"integer"&, the value can be given in decimal,
4976 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
4977 number is assumed. Otherwise, it is treated as an octal number unless it starts
4978 with the characters &"0x"&, in which case the remainder is interpreted as a
4979 hexadecimal number.
4980
4981 If an integer value is followed by the letter K, it is multiplied by 1024; if
4982 it is followed by the letter M, it is multiplied by 1024x1024. When the values
4983 of integer option settings are output, values which are an exact multiple of
4984 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
4985 and M. The printing style is independent of the actual input format that was
4986 used.
4987
4988
4989 .section "Octal integer values" "SECID49"
4990 .cindex "integer format"
4991 .cindex "format" "octal integer"
4992 If an option's type is given as &"octal integer"&, its value is always
4993 interpreted as an octal number, whether or not it starts with the digit zero.
4994 Such options are always output in octal.
4995
4996
4997 .section "Fixed point numbers" "SECID50"
4998 .cindex "fixed point configuration values"
4999 .cindex "format" "fixed point"
5000 If an option's type is given as &"fixed-point"&, its value must be a decimal
5001 integer, optionally followed by a decimal point and up to three further digits.
5002
5003
5004
5005 .section "Time intervals" "SECTtimeformat"
5006 .cindex "time interval" "specifying in configuration"
5007 .cindex "format" "time interval"
5008 A time interval is specified as a sequence of numbers, each followed by one of
5009 the following letters, with no intervening white space:
5010
5011 .table2 30pt
5012 .irow &%s%& seconds
5013 .irow &%m%& minutes
5014 .irow &%h%& hours
5015 .irow &%d%& days
5016 .irow &%w%& weeks
5017 .endtable
5018
5019 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5020 intervals are output in the same format. Exim does not restrict the values; it
5021 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5022
5023
5024
5025 .section "String values" "SECTstrings"
5026 .cindex "string" "format of configuration values"
5027 .cindex "format" "string"
5028 If an option's type is specified as &"string"&, the value can be specified with
5029 or without double-quotes. If it does not start with a double-quote, the value
5030 consists of the remainder of the line plus any continuation lines, starting at
5031 the first character after any leading white space, with trailing white space
5032 removed, and with no interpretation of the characters in the string. Because
5033 Exim removes comment lines (those beginning with #) at an early stage, they can
5034 appear in the middle of a multi-line string. The following two settings are
5035 therefore equivalent:
5036 .code
5037 trusted_users = uucp:mail
5038 trusted_users = uucp:\
5039                 # This comment line is ignored
5040                 mail
5041 .endd
5042 .cindex "string" "quoted"
5043 .cindex "escape characters in quoted strings"
5044 If a string does start with a double-quote, it must end with a closing
5045 double-quote, and any backslash characters other than those used for line
5046 continuation are interpreted as escape characters, as follows:
5047
5048 .table2 100pt
5049 .irow &`\\`&                     "single backslash"
5050 .irow &`\n`&                     "newline"
5051 .irow &`\r`&                     "carriage return"
5052 .irow &`\t`&                     "tab"
5053 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5054 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5055                                    character"
5056 .endtable
5057
5058 If a backslash is followed by some other character, including a double-quote
5059 character, that character replaces the pair.
5060
5061 Quoting is necessary only if you want to make use of the backslash escapes to
5062 insert special characters, or if you need to specify a value with leading or
5063 trailing spaces. These cases are rare, so quoting is almost never needed in
5064 current versions of Exim. In versions of Exim before 3.14, quoting was required
5065 in order to continue lines, so you may come across older configuration files
5066 and examples that apparently quote unnecessarily.
5067
5068
5069 .section "Expanded strings" "SECID51"
5070 .cindex "expansion" "definition of"
5071 Some strings in the configuration file are subjected to &'string expansion'&,
5072 by which means various parts of the string may be changed according to the
5073 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5074 is as just described; in particular, the handling of backslashes in quoted
5075 strings is done as part of the input process, before expansion takes place.
5076 However, backslash is also an escape character for the expander, so any
5077 backslashes that are required for that reason must be doubled if they are
5078 within a quoted configuration string.
5079
5080
5081 .section "User and group names" "SECID52"
5082 .cindex "user name" "format of"
5083 .cindex "format" "user name"
5084 .cindex "groups" "name format"
5085 .cindex "format" "group name"
5086 User and group names are specified as strings, using the syntax described
5087 above, but the strings are interpreted specially. A user or group name must
5088 either consist entirely of digits, or be a name that can be looked up using the
5089 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5090
5091
5092 .section "List construction" "SECTlistconstruct"
5093 .cindex "list" "syntax of in configuration"
5094 .cindex "format" "list item in configuration"
5095 .cindex "string" "list, definition of"
5096 The data for some configuration options is a list of items, with colon as the
5097 default separator. Many of these options are shown with type &"string list"& in
5098 the descriptions later in this document. Others are listed as &"domain list"&,
5099 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5100 are all the same; however, those other than &"string list"& are subject to
5101 particular kinds of interpretation, as described in chapter
5102 &<<CHAPdomhosaddlists>>&.
5103
5104 In all these cases, the entire list is treated as a single string as far as the
5105 input syntax is concerned. The &%trusted_users%& setting in section
5106 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5107 in a list, it must be entered as two colons. Leading and trailing white space
5108 on each item in a list is ignored. This makes it possible to include items that
5109 start with a colon, and in particular, certain forms of IPv6 address. For
5110 example, the list
5111 .code
5112 local_interfaces = 127.0.0.1 : ::::1
5113 .endd
5114 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5115
5116 &*Note*&: Although leading and trailing white space is ignored in individual
5117 list items, it is not ignored when parsing the list. The space after the first
5118 colon in the example above is necessary. If it were not there, the list would
5119 be interpreted as the two items 127.0.0.1:: and 1.
5120
5121 .section "Changing list separators" "SECID53"
5122 .cindex "list separator" "changing"
5123 .cindex "IPv6" "addresses in lists"
5124 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5125 introduced to allow the separator character to be changed. If a list begins
5126 with a left angle bracket, followed by any punctuation character, that
5127 character is used instead of colon as the list separator. For example, the list
5128 above can be rewritten to use a semicolon separator like this:
5129 .code
5130 local_interfaces = <; 127.0.0.1 ; ::1
5131 .endd
5132 This facility applies to all lists, with the exception of the list in
5133 &%log_file_path%&. It is recommended that the use of non-colon separators be
5134 confined to circumstances where they really are needed.
5135
5136 .cindex "list separator" "newline as"
5137 .cindex "newline" "as list separator"
5138 It is also possible to use newline and other control characters (those with
5139 code values less than 32, plus DEL) as separators in lists. Such separators
5140 must be provided literally at the time the list is processed. For options that
5141 are string-expanded, you can write the separator using a normal escape
5142 sequence. This will be processed by the expander before the string is
5143 interpreted as a list. For example, if a newline-separated list of domains is
5144 generated by a lookup, you can process it directly by a line such as this:
5145 .code
5146 domains = <\n ${lookup mysql{.....}}
5147 .endd
5148 This avoids having to change the list separator in such data. You are unlikely
5149 to want to use a control character as a separator in an option that is not
5150 expanded, because the value is literal text. However, it can be done by giving
5151 the value in quotes. For example:
5152 .code
5153 local_interfaces = "<\n 127.0.0.1 \n ::1"
5154 .endd
5155 Unlike printing character separators, which can be included in list items by
5156 doubling, it is not possible to include a control character as data when it is
5157 set as the separator. Two such characters in succession are interpreted as
5158 enclosing an empty list item.
5159
5160
5161
5162 .section "Empty items in lists" "SECTempitelis"
5163 .cindex "list" "empty item in"
5164 An empty item at the end of a list is always ignored. In other words, trailing
5165 separator characters are ignored. Thus, the list in
5166 .code
5167 senders = user@domain :
5168 .endd
5169 contains only a single item. If you want to include an empty string as one item
5170 in a list, it must not be the last item. For example, this list contains three
5171 items, the second of which is empty:
5172 .code
5173 senders = user1@domain : : user2@domain
5174 .endd
5175 &*Note*&: There must be white space between the two colons, as otherwise they
5176 are interpreted as representing a single colon data character (and the list
5177 would then contain just one item). If you want to specify a list that contains
5178 just one, empty item, you can do it as in this example:
5179 .code
5180 senders = :
5181 .endd
5182 In this case, the first item is empty, and the second is discarded because it
5183 is at the end of the list.
5184
5185
5186
5187
5188 .section "Format of driver configurations" "SECTfordricon"
5189 .cindex "drivers" "configuration format"
5190 There are separate parts in the configuration for defining routers, transports,
5191 and authenticators. In each part, you are defining a number of driver
5192 instances, each with its own set of options. Each driver instance is defined by
5193 a sequence of lines like this:
5194 .display
5195 <&'instance name'&>:
5196   <&'option'&>
5197   ...
5198   <&'option'&>
5199 .endd
5200 In the following example, the instance name is &(localuser)&, and it is
5201 followed by three options settings:
5202 .code
5203 localuser:
5204   driver = accept
5205   check_local_user
5206   transport = local_delivery
5207 .endd
5208 For each driver instance, you specify which Exim code module it uses &-- by the
5209 setting of the &%driver%& option &-- and (optionally) some configuration
5210 settings. For example, in the case of transports, if you want a transport to
5211 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5212 a local file you would use the &(appendfile)& driver. Each of the drivers is
5213 described in detail in its own separate chapter later in this manual.
5214
5215 You can have several routers, transports, or authenticators that are based on
5216 the same underlying driver (each must have a different instance name).
5217
5218 The order in which routers are defined is important, because addresses are
5219 passed to individual routers one by one, in order. The order in which
5220 transports are defined does not matter at all. The order in which
5221 authenticators are defined is used only when Exim, as a client, is searching
5222 them to find one that matches an authentication mechanism offered by the
5223 server.
5224
5225 .cindex "generic options"
5226 .cindex "options" "generic &-- definition of"
5227 Within a driver instance definition, there are two kinds of option: &'generic'&
5228 and &'private'&. The generic options are those that apply to all drivers of the
5229 same type (that is, all routers, all transports or all authenticators). The
5230 &%driver%& option is a generic option that must appear in every definition.
5231 .cindex "private options"
5232 The private options are special for each driver, and none need appear, because
5233 they all have default values.
5234
5235 The options may appear in any order, except that the &%driver%& option must
5236 precede any private options, since these depend on the particular driver. For
5237 this reason, it is recommended that &%driver%& always be the first option.
5238
5239 Driver instance names, which are used for reference in log entries and
5240 elsewhere, can be any sequence of letters, digits, and underscores (starting
5241 with a letter) and must be unique among drivers of the same type. A router and
5242 a transport (for example) can each have the same name, but no two router
5243 instances can have the same name. The name of a driver instance should not be
5244 confused with the name of the underlying driver module. For example, the
5245 configuration lines:
5246 .code
5247 remote_smtp:
5248   driver = smtp
5249 .endd
5250 create an instance of the &(smtp)& transport driver whose name is
5251 &(remote_smtp)&. The same driver code can be used more than once, with
5252 different instance names and different option settings each time. A second
5253 instance of the &(smtp)& transport, with different options, might be defined
5254 thus:
5255 .code
5256 special_smtp:
5257   driver = smtp
5258   port = 1234
5259   command_timeout = 10s
5260 .endd
5261 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5262 these transport instances from routers, and these names would appear in log
5263 lines.
5264
5265 Comment lines may be present in the middle of driver specifications. The full
5266 list of option settings for any particular driver instance, including all the
5267 defaulted values, can be extracted by making use of the &%-bP%& command line
5268 option.
5269
5270
5271
5272
5273
5274
5275 . ////////////////////////////////////////////////////////////////////////////
5276 . ////////////////////////////////////////////////////////////////////////////
5277
5278 .chapter "The default configuration file" "CHAPdefconfil"
5279 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5280 .cindex "default" "configuration file &""walk through""&"
5281 The default configuration file supplied with Exim as &_src/configure.default_&
5282 is sufficient for a host with simple mail requirements. As an introduction to
5283 the way Exim is configured, this chapter &"walks through"& the default
5284 configuration, giving brief explanations of the settings. Detailed descriptions
5285 of the options are given in subsequent chapters. The default configuration file
5286 itself contains extensive comments about ways you might want to modify the
5287 initial settings. However, note that there are many options that are not
5288 mentioned at all in the default configuration.
5289
5290
5291
5292 .section "Main configuration settings" "SECTdefconfmain"
5293 The main (global) configuration option settings must always come first in the
5294 file. The first thing you'll see in the file, after some initial comments, is
5295 the line
5296 .code
5297 # primary_hostname =
5298 .endd
5299 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5300 to know the official, fully qualified name of your host, and this is where you
5301 can specify it. However, in most cases you do not need to set this option. When
5302 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5303
5304 The first three non-comment configuration lines are as follows:
5305 .code
5306 domainlist local_domains = @
5307 domainlist relay_to_domains =
5308 hostlist   relay_from_hosts = 127.0.0.1
5309 .endd
5310 These are not, in fact, option settings. They are definitions of two named
5311 domain lists and one named host list. Exim allows you to give names to lists of
5312 domains, hosts, and email addresses, in order to make it easier to manage the
5313 configuration file (see section &<<SECTnamedlists>>&).
5314
5315 The first line defines a domain list called &'local_domains'&; this is used
5316 later in the configuration to identify domains that are to be delivered
5317 on the local host.
5318
5319 .cindex "@ in a domain list"
5320 There is just one item in this list, the string &"@"&. This is a special form
5321 of entry which means &"the name of the local host"&. Thus, if the local host is
5322 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5323 be delivered locally. Because the local host's name is referenced indirectly,
5324 the same configuration file can be used on different hosts.
5325
5326 The second line defines a domain list called &'relay_to_domains'&, but the
5327 list itself is empty. Later in the configuration we will come to the part that
5328 controls mail relaying through the local host; it allows relaying to any
5329 domains in this list. By default, therefore, no relaying on the basis of a mail
5330 domain is permitted.
5331
5332 The third line defines a host list called &'relay_from_hosts'&. This list is
5333 used later in the configuration to permit relaying from any host or IP address
5334 that matches the list. The default contains just the IP address of the IPv4
5335 loopback interface, which means that processes on the local host are able to
5336 submit mail for relaying by sending it over TCP/IP to that interface. No other
5337 hosts are permitted to submit messages for relaying.
5338
5339 Just to be sure there's no misunderstanding: at this point in the configuration
5340 we aren't actually setting up any controls. We are just defining some domains
5341 and hosts that will be used in the controls that are specified later.
5342
5343 The next two configuration lines are genuine option settings:
5344 .code
5345 acl_smtp_rcpt = acl_check_rcpt
5346 acl_smtp_data = acl_check_data
5347 .endd
5348 These options specify &'Access Control Lists'& (ACLs) that are to be used
5349 during an incoming SMTP session for every recipient of a message (every RCPT
5350 command), and after the contents of the message have been received,
5351 respectively. The names of the lists are &'acl_check_rcpt'& and
5352 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5353 section of the configuration. The RCPT ACL controls which recipients are
5354 accepted for an incoming message &-- if a configuration does not provide an ACL
5355 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5356 contents of a message to be checked.
5357
5358 Two commented-out option settings are next:
5359 .code
5360 # av_scanner = clamd:/tmp/clamd
5361 # spamd_address = 127.0.0.1 783
5362 .endd
5363 These are example settings that can be used when Exim is compiled with the
5364 content-scanning extension. The first specifies the interface to the virus
5365 scanner, and the second specifies the interface to SpamAssassin. Further
5366 details are given in chapter &<<CHAPexiscan>>&.
5367
5368 Three more commented-out option settings follow:
5369 .code
5370 # tls_advertise_hosts = *
5371 # tls_certificate = /etc/ssl/exim.crt
5372 # tls_privatekey = /etc/ssl/exim.pem
5373 .endd
5374 These are example settings that can be used when Exim is compiled with
5375 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5376 first one specifies the list of clients that are allowed to use TLS when
5377 connecting to this server; in this case the wildcard means all clients. The
5378 other options specify where Exim should find its TLS certificate and private
5379 key, which together prove the server's identity to any clients that connect.
5380 More details are given in chapter &<<CHAPTLS>>&.
5381
5382 Another two commented-out option settings follow:
5383 .code
5384 # daemon_smtp_ports = 25 : 465 : 587
5385 # tls_on_connect_ports = 465
5386 .endd
5387 .cindex "port" "465 and 587"
5388 .cindex "port" "for message submission"
5389 .cindex "message" "submission, ports for"
5390 .cindex "ssmtp protocol"
5391 .cindex "smtps protocol"
5392 .cindex "SMTP" "ssmtp protocol"
5393 .cindex "SMTP" "smtps protocol"
5394 These options provide better support for roaming users who wish to use this
5395 server for message submission. They are not much use unless you have turned on
5396 TLS (as described in the previous paragraph) and authentication (about which
5397 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5398 on end-user networks, so RFC 4409 specifies that message submission should use
5399 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5400 configured to use port 587 correctly, so these settings also enable the
5401 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5402 &<<SECTsupobssmt>>&).
5403
5404 Two more commented-out options settings follow:
5405 .code
5406 # qualify_domain =
5407 # qualify_recipient =
5408 .endd
5409 The first of these specifies a domain that Exim uses when it constructs a
5410 complete email address from a local login name. This is often needed when Exim
5411 receives a message from a local process. If you do not set &%qualify_domain%&,
5412 the value of &%primary_hostname%& is used. If you set both of these options,
5413 you can have different qualification domains for sender and recipient
5414 addresses. If you set only the first one, its value is used in both cases.
5415
5416 .cindex "domain literal" "recognizing format"
5417 The following line must be uncommented if you want Exim to recognize
5418 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5419 (an IP address within square brackets) instead of a named domain.
5420 .code
5421 # allow_domain_literals
5422 .endd
5423 The RFCs still require this form, but many people think that in the modern
5424 Internet it makes little sense to permit mail to be sent to specific hosts by
5425 quoting their IP addresses. This ancient format has been used by people who
5426 try to abuse hosts by using them for unwanted relaying. However, some
5427 people believe there are circumstances (for example, messages addressed to
5428 &'postmaster'&) where domain literals are still useful.
5429
5430 The next configuration line is a kind of trigger guard:
5431 .code
5432 never_users = root
5433 .endd
5434 It specifies that no delivery must ever be run as the root user. The normal
5435 convention is to set up &'root'& as an alias for the system administrator. This
5436 setting is a guard against slips in the configuration.
5437 The list of users specified by &%never_users%& is not, however, the complete
5438 list; the build-time configuration in &_Local/Makefile_& has an option called
5439 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5440 contents of &%never_users%& are added to this list. By default
5441 FIXED_NEVER_USERS also specifies root.
5442
5443 When a remote host connects to Exim in order to send mail, the only information
5444 Exim has about the host's identity is its IP address. The next configuration
5445 line,
5446 .code
5447 host_lookup = *
5448 .endd
5449 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5450 in order to get a host name. This improves the quality of the logging
5451 information, but if you feel it is too expensive, you can remove it entirely,
5452 or restrict the lookup to hosts on &"nearby"& networks.
5453 Note that it is not always possible to find a host name from an IP address,
5454 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5455 unreachable.
5456
5457 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5458 1413 (hence their names):
5459 .code
5460 rfc1413_hosts = *
5461 rfc1413_query_timeout = 5s
5462 .endd
5463 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5464 You can limit the hosts to which these calls are made, or change the timeout
5465 that is used. If you set the timeout to zero, all ident calls are disabled.
5466 Although they are cheap and can provide useful information for tracing problem
5467 messages, some hosts and firewalls have problems with ident calls. This can
5468 result in a timeout instead of an immediate refused connection, leading to
5469 delays on starting up an incoming SMTP session.
5470
5471 When Exim receives messages over SMTP connections, it expects all addresses to
5472 be fully qualified with a domain, as required by the SMTP definition. However,
5473 if you are running a server to which simple clients submit messages, you may
5474 find that they send unqualified addresses. The two commented-out options:
5475 .code
5476 # sender_unqualified_hosts =
5477 # recipient_unqualified_hosts =
5478 .endd
5479 show how you can specify hosts that are permitted to send unqualified sender
5480 and recipient addresses, respectively.
5481
5482 The &%percent_hack_domains%& option is also commented out:
5483 .code
5484 # percent_hack_domains =
5485 .endd
5486 It provides a list of domains for which the &"percent hack"& is to operate.
5487 This is an almost obsolete form of explicit email routing. If you do not know
5488 anything about it, you can safely ignore this topic.
5489
5490 The last two settings in the main part of the default configuration are
5491 concerned with messages that have been &"frozen"& on Exim's queue. When a
5492 message is frozen, Exim no longer continues to try to deliver it. Freezing
5493 occurs when a bounce message encounters a permanent failure because the sender
5494 address of the original message that caused the bounce is invalid, so the
5495 bounce cannot be delivered. This is probably the most common case, but there
5496 are also other conditions that cause freezing, and frozen messages are not
5497 always bounce messages.
5498 .code
5499 ignore_bounce_errors_after = 2d
5500 timeout_frozen_after = 7d
5501 .endd
5502 The first of these options specifies that failing bounce messages are to be
5503 discarded after 2 days on the queue. The second specifies that any frozen
5504 message (whether a bounce message or not) is to be timed out (and discarded)
5505 after a week. In this configuration, the first setting ensures that no failing
5506 bounce message ever lasts a week.
5507
5508
5509
5510 .section "ACL configuration" "SECID54"
5511 .cindex "default" "ACLs"
5512 .cindex "&ACL;" "default configuration"
5513 In the default configuration, the ACL section follows the main configuration.
5514 It starts with the line
5515 .code
5516 begin acl
5517 .endd
5518 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5519 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5520 and &%acl_smtp_data%& above.
5521
5522 .cindex "RCPT" "ACL for"
5523 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5524 RCPT command specifies one of the message's recipients. The ACL statements
5525 are considered in order, until the recipient address is either accepted or
5526 rejected. The RCPT command is then accepted or rejected, according to the
5527 result of the ACL processing.
5528 .code
5529 acl_check_rcpt:
5530 .endd
5531 This line, consisting of a name terminated by a colon, marks the start of the
5532 ACL, and names it.
5533 .code
5534 accept  hosts = :
5535 .endd
5536 This ACL statement accepts the recipient if the sending host matches the list.
5537 But what does that strange list mean? It doesn't actually contain any host
5538 names or IP addresses. The presence of the colon puts an empty item in the
5539 list; Exim matches this only if the incoming message did not come from a remote
5540 host, because in that case, the remote hostname is empty. The colon is
5541 important. Without it, the list itself is empty, and can never match anything.
5542
5543 What this statement is doing is to accept unconditionally all recipients in
5544 messages that are submitted by SMTP from local processes using the standard
5545 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5546 manner.
5547 .code
5548 deny    message       = Restricted characters in address
5549         domains       = +local_domains
5550         local_parts   = ^[.] : ^.*[@%!/|]
5551
5552 deny    message       = Restricted characters in address
5553         domains       = !+local_domains
5554         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5555 .endd
5556 These statements are concerned with local parts that contain any of the
5557 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5558 Although these characters are entirely legal in local parts (in the case of
5559 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5560 in Internet mail addresses.
5561
5562 The first three have in the past been associated with explicitly routed
5563 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5564 option). Addresses containing these characters are regularly tried by spammers
5565 in an attempt to bypass relaying restrictions, and also by open relay testing
5566 programs. Unless you really need them it is safest to reject these characters
5567 at this early stage. This configuration is heavy-handed in rejecting these
5568 characters for all messages it accepts from remote hosts. This is a deliberate
5569 policy of being as safe as possible.
5570
5571 The first rule above is stricter, and is applied to messages that are addressed
5572 to one of the local domains handled by this host. This is implemented by the
5573 first condition, which restricts it to domains that are listed in the
5574 &'local_domains'& domain list. The &"+"& character is used to indicate a
5575 reference to a named list. In this configuration, there is just one domain in
5576 &'local_domains'&, but in general there may be many.
5577
5578 The second condition on the first statement uses two regular expressions to
5579 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5580 or &"|"&. If you have local accounts that include these characters, you will
5581 have to modify this rule.
5582
5583 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5584 allows them because they have been encountered in practice. (Consider the
5585 common convention of local parts constructed as
5586 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5587 the author of Exim, who has no second initial.) However, a local part starting
5588 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5589 file name (for example, for a mailing list). This is also true for local parts
5590 that contain slashes. A pipe symbol can also be troublesome if the local part
5591 is incorporated unthinkingly into a shell command line.
5592
5593 The second rule above applies to all other domains, and is less strict. This
5594 allows your own users to send outgoing messages to sites that use slashes
5595 and vertical bars in their local parts. It blocks local parts that begin
5596 with a dot, slash, or vertical bar, but allows these characters within the
5597 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5598 and &"!"& is blocked, as before. The motivation here is to prevent your users
5599 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5600 .code
5601 accept  local_parts   = postmaster
5602         domains       = +local_domains
5603 .endd
5604 This statement, which has two conditions, accepts an incoming address if the
5605 local part is &'postmaster'& and the domain is one of those listed in the
5606 &'local_domains'& domain list. The &"+"& character is used to indicate a
5607 reference to a named list. In this configuration, there is just one domain in
5608 &'local_domains'&, but in general there may be many.
5609
5610 The presence of this statement means that mail to postmaster is never blocked
5611 by any of the subsequent tests. This can be helpful while sorting out problems
5612 in cases where the subsequent tests are incorrectly denying access.
5613 .code
5614 require verify        = sender
5615 .endd
5616 This statement requires the sender address to be verified before any subsequent
5617 ACL statement can be used. If verification fails, the incoming recipient
5618 address is refused. Verification consists of trying to route the address, to
5619 see if a bounce message could be delivered to it. In the case of remote
5620 addresses, basic verification checks only the domain, but &'callouts'& can be
5621 used for more verification if required. Section &<<SECTaddressverification>>&
5622 discusses the details of address verification.
5623 .code
5624 accept  hosts         = +relay_from_hosts
5625         control       = submission
5626 .endd
5627 This statement accepts the address if the message is coming from one of the
5628 hosts that are defined as being allowed to relay through this host. Recipient
5629 verification is omitted here, because in many cases the clients are dumb MUAs
5630 that do not cope well with SMTP error responses. For the same reason, the
5631 second line specifies &"submission mode"& for messages that are accepted. This
5632 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5633 messages that are deficient in some way, for example, because they lack a
5634 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5635 probably add recipient verification here, and disable submission mode.
5636 .code
5637 accept  authenticated = *
5638         control       = submission
5639 .endd
5640 This statement accepts the address if the client host has authenticated itself.
5641 Submission mode is again specified, on the grounds that such messages are most
5642 likely to come from MUAs. The default configuration does not define any
5643 authenticators, though it does include some nearly complete commented-out
5644 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5645 fact authenticate until you complete the authenticator definitions.
5646 .code
5647 require message = relay not permitted
5648         domains = +local_domains : +relay_domains
5649 .endd
5650 This statement rejects the address if its domain is neither a local domain nor
5651 one of the domains for which this host is a relay.
5652 .code
5653 require verify = recipient
5654 .endd
5655 This statement requires the recipient address to be verified; if verification
5656 fails, the address is rejected.
5657 .code
5658 # deny    message     = rejected because $sender_host_address \
5659 #                       is in a black list at $dnslist_domain\n\
5660 #                       $dnslist_text
5661 #         dnslists    = black.list.example
5662 #
5663 # warn    dnslists    = black.list.example
5664 #         add_header  = X-Warning: $sender_host_address is in \
5665 #                       a black list at $dnslist_domain
5666 #         log_message = found in $dnslist_domain
5667 .endd
5668 These commented-out lines are examples of how you could configure Exim to check
5669 sending hosts against a DNS black list. The first statement rejects messages
5670 from blacklisted hosts, whereas the second just inserts a warning header
5671 line.
5672 .code
5673 # require verify = csa
5674 .endd
5675 This commented-out line is an example of how you could turn on client SMTP
5676 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5677 records.
5678 .code
5679 accept
5680 .endd
5681 The final statement in the first ACL unconditionally accepts any recipient
5682 address that has successfully passed all the previous tests.
5683 .code
5684 acl_check_data:
5685 .endd
5686 This line marks the start of the second ACL, and names it. Most of the contents
5687 of this ACL are commented out:
5688 .code
5689 # deny    malware   = *
5690 #         message   = This message contains a virus \
5691 #                     ($malware_name).
5692 .endd
5693 These lines are examples of how to arrange for messages to be scanned for
5694 viruses when Exim has been compiled with the content-scanning extension, and a
5695 suitable virus scanner is installed. If the message is found to contain a
5696 virus, it is rejected with the given custom error message.
5697 .code
5698 # warn    spam      = nobody
5699 #         message   = X-Spam_score: $spam_score\n\
5700 #                     X-Spam_score_int: $spam_score_int\n\
5701 #                     X-Spam_bar: $spam_bar\n\
5702 #                     X-Spam_report: $spam_report
5703 .endd
5704 These lines are an example of how to arrange for messages to be scanned by
5705 SpamAssassin when Exim has been compiled with the content-scanning extension,
5706 and SpamAssassin has been installed. The SpamAssassin check is run with
5707 &`nobody`& as its user parameter, and the results are added to the message as a
5708 series of extra header line. In this case, the message is not rejected,
5709 whatever the spam score.
5710 .code
5711 accept
5712 .endd
5713 This final line in the DATA ACL accepts the message unconditionally.
5714
5715
5716 .section "Router configuration" "SECID55"
5717 .cindex "default" "routers"
5718 .cindex "routers" "default"
5719 The router configuration comes next in the default configuration, introduced
5720 by the line
5721 .code
5722 begin routers
5723 .endd
5724 Routers are the modules in Exim that make decisions about where to send
5725 messages. An address is passed to each router in turn, until it is either
5726 accepted, or failed. This means that the order in which you define the routers
5727 matters. Each router is fully described in its own chapter later in this
5728 manual. Here we give only brief overviews.
5729 .code
5730 # domain_literal:
5731 #   driver = ipliteral
5732 #   domains = !+local_domains
5733 #   transport = remote_smtp
5734 .endd
5735 .cindex "domain literal" "default router"
5736 This router is commented out because the majority of sites do not want to
5737 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5738 you uncomment this router, you also need to uncomment the setting of
5739 &%allow_domain_literals%& in the main part of the configuration.
5740 .code
5741 dnslookup:
5742   driver = dnslookup
5743   domains = ! +local_domains
5744   transport = remote_smtp
5745   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5746   no_more
5747 .endd
5748 The first uncommented router handles addresses that do not involve any local
5749 domains. This is specified by the line
5750 .code
5751 domains = ! +local_domains
5752 .endd
5753 The &%domains%& option lists the domains to which this router applies, but the
5754 exclamation mark is a negation sign, so the router is used only for domains
5755 that are not in the domain list called &'local_domains'& (which was defined at
5756 the start of the configuration). The plus sign before &'local_domains'&
5757 indicates that it is referring to a named list. Addresses in other domains are
5758 passed on to the following routers.
5759
5760 The name of the router driver is &(dnslookup)&,
5761 and is specified by the &%driver%& option. Do not be confused by the fact that
5762 the name of this router instance is the same as the name of the driver. The
5763 instance name is arbitrary, but the name set in the &%driver%& option must be
5764 one of the driver modules that is in the Exim binary.
5765
5766 The &(dnslookup)& router routes addresses by looking up their domains in the
5767 DNS in order to obtain a list of hosts to which the address is routed. If the
5768 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5769 specified by the &%transport%& option. If the router does not find the domain
5770 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5771 the address fails and is bounced.
5772
5773 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5774 be entirely ignored. This option is present because a number of cases have been
5775 encountered where MX records in the DNS point to host names
5776 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5777 Completely ignoring these IP addresses causes Exim to fail to route the
5778 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5779 continue to try to deliver the message periodically until the address timed
5780 out.
5781 .code
5782 system_aliases:
5783   driver = redirect
5784   allow_fail
5785   allow_defer
5786   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5787 # user = exim
5788   file_transport = address_file
5789   pipe_transport = address_pipe
5790 .endd
5791 Control reaches this and subsequent routers only for addresses in the local
5792 domains. This router checks to see whether the local part is defined as an
5793 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5794 data that it looks up from that file. If no data is found for the local part,
5795 the value of the &%data%& option is empty, causing the address to be passed to
5796 the next router.
5797
5798 &_/etc/aliases_& is a conventional name for the system aliases file that is
5799 often used. That is why it is referenced by from the default configuration
5800 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5801 &_Local/Makefile_& before building Exim.
5802 .code
5803 userforward:
5804   driver = redirect
5805   check_local_user
5806 # local_part_suffix = +* : -*
5807 # local_part_suffix_optional
5808   file = $home/.forward
5809 # allow_filter
5810   no_verify
5811   no_expn
5812   check_ancestor
5813   file_transport = address_file
5814   pipe_transport = address_pipe
5815   reply_transport = address_reply
5816 .endd
5817 This is the most complicated router in the default configuration. It is another
5818 redirection router, but this time it is looking for forwarding data set up by
5819 individual users. The &%check_local_user%& setting specifies a check that the
5820 local part of the address is the login name of a local user. If it is not, the
5821 router is skipped. The two commented options that follow &%check_local_user%&,
5822 namely:
5823 .code
5824 # local_part_suffix = +* : -*
5825 # local_part_suffix_optional
5826 .endd
5827 .vindex "&$local_part_suffix$&"
5828 show how you can specify the recognition of local part suffixes. If the first
5829 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5830 by any sequence of characters, is removed from the local part and placed in the
5831 variable &$local_part_suffix$&. The second suffix option specifies that the
5832 presence of a suffix in the local part is optional. When a suffix is present,
5833 the check for a local login uses the local part with the suffix removed.
5834
5835 When a local user account is found, the file called &_.forward_& in the user's
5836 home directory is consulted. If it does not exist, or is empty, the router
5837 declines. Otherwise, the contents of &_.forward_& are interpreted as
5838 redirection data (see chapter &<<CHAPredirect>>& for more details).
5839
5840 .cindex "Sieve filter" "enabling in default router"
5841 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5842 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5843 is commented out by default), the contents of the file are interpreted as a set
5844 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5845 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5846 separate document entitled &'Exim's interfaces to mail filtering'&.
5847
5848 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5849 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5850 There are two reasons for doing this:
5851
5852 .olist
5853 Whether or not a local user has a &_.forward_& file is not really relevant when
5854 checking an address for validity; it makes sense not to waste resources doing
5855 unnecessary work.
5856 .next
5857 More importantly, when Exim is verifying addresses or handling an EXPN
5858 command during an SMTP session, it is running as the Exim user, not as root.
5859 The group is the Exim group, and no additional groups are set up.
5860 It may therefore not be possible for Exim to read users' &_.forward_& files at
5861 this time.
5862 .endlist
5863
5864 The setting of &%check_ancestor%& prevents the router from generating a new
5865 address that is the same as any previous address that was redirected. (This
5866 works round a problem concerning a bad interaction between aliasing and
5867 forwarding &-- see section &<<SECTredlocmai>>&).
5868
5869 The final three option settings specify the transports that are to be used when
5870 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5871 auto-reply, respectively. For example, if a &_.forward_& file contains
5872 .code
5873 a.nother@elsewhere.example, /home/spqr/archive
5874 .endd
5875 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5876 transport.
5877 .code
5878 localuser:
5879   driver = accept
5880   check_local_user
5881 # local_part_suffix = +* : -*
5882 # local_part_suffix_optional
5883   transport = local_delivery
5884 .endd
5885 The final router sets up delivery into local mailboxes, provided that the local
5886 part is the name of a local login, by accepting the address and assigning it to
5887 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5888 routers, so the address is bounced. The commented suffix settings fulfil the
5889 same purpose as they do for the &(userforward)& router.
5890
5891
5892 .section "Transport configuration" "SECID56"
5893 .cindex "default" "transports"
5894 .cindex "transports" "default"
5895 Transports define mechanisms for actually delivering messages. They operate
5896 only when referenced from routers, so the order in which they are defined does
5897 not matter. The transports section of the configuration starts with
5898 .code
5899 begin transports
5900 .endd
5901 One remote transport and four local transports are defined.
5902 .code
5903 remote_smtp:
5904   driver = smtp
5905 .endd
5906 This transport is used for delivering messages over SMTP connections. All its
5907 options are defaulted. The list of remote hosts comes from the router.
5908 .code
5909 local_delivery:
5910   driver = appendfile
5911   file = /var/mail/$local_part
5912   delivery_date_add
5913   envelope_to_add
5914   return_path_add
5915 # group = mail
5916 # mode = 0660
5917 .endd
5918 This &(appendfile)& transport is used for local delivery to user mailboxes in
5919 traditional BSD mailbox format. By default it runs under the uid and gid of the
5920 local user, which requires the sticky bit to be set on the &_/var/mail_&
5921 directory. Some systems use the alternative approach of running mail deliveries
5922 under a particular group instead of using the sticky bit. The commented options
5923 show how this can be done.
5924
5925 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5926 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5927 similarly-named options above.
5928 .code
5929 address_pipe:
5930   driver = pipe
5931   return_output
5932 .endd
5933 This transport is used for handling deliveries to pipes that are generated by
5934 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
5935 option specifies that any output generated by the pipe is to be returned to the
5936 sender.
5937 .code
5938 address_file:
5939   driver = appendfile
5940   delivery_date_add
5941   envelope_to_add
5942   return_path_add
5943 .endd
5944 This transport is used for handling deliveries to files that are generated by
5945 redirection. The name of the file is not specified in this instance of
5946 &(appendfile)&, because it comes from the &(redirect)& router.
5947 .code
5948 address_reply:
5949   driver = autoreply
5950 .endd
5951 This transport is used for handling automatic replies generated by users'
5952 filter files.
5953
5954
5955
5956 .section "Default retry rule" "SECID57"
5957 .cindex "retry" "default rule"
5958 .cindex "default" "retry rule"
5959 The retry section of the configuration file contains rules which affect the way
5960 Exim retries deliveries that cannot be completed at the first attempt. It is
5961 introduced by the line
5962 .code
5963 begin retry
5964 .endd
5965 In the default configuration, there is just one rule, which applies to all
5966 errors:
5967 .code
5968 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
5969 .endd
5970 This causes any temporarily failing address to be retried every 15 minutes for
5971 2 hours, then at intervals starting at one hour and increasing by a factor of
5972 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
5973 is not delivered after 4 days of temporary failure, it is bounced.
5974
5975 If the retry section is removed from the configuration, or is empty (that is,
5976 if no retry rules are defined), Exim will not retry deliveries. This turns
5977 temporary errors into permanent errors.
5978
5979
5980 .section "Rewriting configuration" "SECID58"
5981 The rewriting section of the configuration, introduced by
5982 .code
5983 begin rewrite
5984 .endd
5985 contains rules for rewriting addresses in messages as they arrive. There are no
5986 rewriting rules in the default configuration file.
5987
5988
5989
5990 .section "Authenticators configuration" "SECTdefconfauth"
5991 .cindex "AUTH" "configuration"
5992 The authenticators section of the configuration, introduced by
5993 .code
5994 begin authenticators
5995 .endd
5996 defines mechanisms for the use of the SMTP AUTH command. The default
5997 configuration file contains two commented-out example authenticators
5998 which support plaintext username/password authentication using the
5999 standard PLAIN mechanism and the traditional but non-standard LOGIN
6000 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6001 to support most MUA software.
6002
6003 The example PLAIN authenticator looks like this:
6004 .code
6005 #PLAIN:
6006 #  driver                  = plaintext
6007 #  server_set_id           = $auth2
6008 #  server_prompts          = :
6009 #  server_condition        = Authentication is not yet configured
6010 #  server_advertise_condition = ${if def:tls_cipher }
6011 .endd
6012 And the example LOGIN authenticator looks like this:
6013 .code
6014 #LOGIN:
6015 #  driver                  = plaintext
6016 #  server_set_id           = $auth1
6017 #  server_prompts          = <| Username: | Password:
6018 #  server_condition        = Authentication is not yet configured
6019 #  server_advertise_condition = ${if def:tls_cipher }
6020 .endd
6021
6022 The &%server_set_id%& option makes Exim remember the authenticated username
6023 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6024 &%server_prompts%& option configures the &(plaintext)& authenticator so
6025 that it implements the details of the specific authentication mechanism,
6026 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6027 when Exim offers authentication to clients; in the examples, this is only
6028 when TLS or SSL has been started, so to enable the authenticators you also
6029 need to add support for TLS as described in &<<SECTdefconfmain>>&.
6030
6031 The &%server_condition%& setting defines how to verify that the username and
6032 password are correct. In the examples it just produces an error message.
6033 To make the authenticators work, you can use a string expansion
6034 expression like one of the examples in &<<CHAPplaintext>>&.
6035
6036 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6037 usercode and password are in different positions.  &<<CHAPplaintext>>&
6038 covers both.
6039
6040 .ecindex IIDconfiwal
6041
6042
6043
6044 . ////////////////////////////////////////////////////////////////////////////
6045 . ////////////////////////////////////////////////////////////////////////////
6046
6047 .chapter "Regular expressions" "CHAPregexp"
6048
6049 .cindex "regular expressions" "library"
6050 .cindex "PCRE"
6051 Exim supports the use of regular expressions in many of its options. It
6052 uses the PCRE regular expression library; this provides regular expression
6053 matching that is compatible with Perl 5. The syntax and semantics of
6054 regular expressions is discussed in many Perl reference books, and also in
6055 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6056 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6057
6058 The documentation for the syntax and semantics of the regular expressions that
6059 are supported by PCRE is included in the PCRE distribution, and no further
6060 description is included here. The PCRE functions are called from Exim using
6061 the default option settings (that is, with no PCRE options set), except that
6062 the PCRE_CASELESS option is set when the matching is required to be
6063 case-insensitive.
6064
6065 In most cases, when a regular expression is required in an Exim configuration,
6066 it has to start with a circumflex, in order to distinguish it from plain text
6067 or an &"ends with"& wildcard. In this example of a configuration setting, the
6068 second item in the colon-separated list is a regular expression.
6069 .code
6070 domains = a.b.c : ^\\d{3} : *.y.z : ...
6071 .endd
6072 The doubling of the backslash is required because of string expansion that
6073 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6074 of this issue, and a way of avoiding the need for doubling backslashes. The
6075 regular expression that is eventually used in this example contains just one
6076 backslash. The circumflex is included in the regular expression, and has the
6077 normal effect of &"anchoring"& it to the start of the string that is being
6078 matched.
6079
6080 There are, however, two cases where a circumflex is not required for the
6081 recognition of a regular expression: these are the &%match%& condition in a
6082 string expansion, and the &%matches%& condition in an Exim filter file. In
6083 these cases, the relevant string is always treated as a regular expression; if
6084 it does not start with a circumflex, the expression is not anchored, and can
6085 match anywhere in the subject string.
6086
6087 In all cases, if you want a regular expression to match at the end of a string,
6088 you must code the $ metacharacter to indicate this. For example:
6089 .code
6090 domains = ^\\d{3}\\.example
6091 .endd
6092 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6093 You need to use:
6094 .code
6095 domains = ^\\d{3}\\.example\$
6096 .endd
6097 if you want &'example'& to be the top-level domain. The backslash before the
6098 $ is needed because string expansion also interprets dollar characters.
6099
6100
6101
6102 . ////////////////////////////////////////////////////////////////////////////
6103 . ////////////////////////////////////////////////////////////////////////////
6104
6105 .chapter "File and database lookups" "CHAPfdlookup"
6106 .scindex IIDfidalo1 "file" "lookups"
6107 .scindex IIDfidalo2 "database" "lookups"
6108 .cindex "lookup" "description of"
6109 Exim can be configured to look up data in files or databases as it processes
6110 messages. Two different kinds of syntax are used:
6111
6112 .olist
6113 A string that is to be expanded may contain explicit lookup requests. These
6114 cause parts of the string to be replaced by data that is obtained from the
6115 lookup. Lookups of this type are conditional expansion items. Different results
6116 can be defined for the cases of lookup success and failure. See chapter
6117 &<<CHAPexpand>>&, where string expansions are described in detail.
6118 .next
6119 Lists of domains, hosts, and email addresses can contain lookup requests as a
6120 way of avoiding excessively long linear lists. In this case, the data that is
6121 returned by the lookup is often (but not always) discarded; whether the lookup
6122 succeeds or fails is what really counts. These kinds of list are described in
6123 chapter &<<CHAPdomhosaddlists>>&.
6124 .endlist
6125
6126 String expansions, lists, and lookups interact with each other in such a way
6127 that there is no order in which to describe any one of them that does not
6128 involve references to the others. Each of these three chapters makes more sense
6129 if you have read the other two first. If you are reading this for the first
6130 time, be aware that some of it will make a lot more sense after you have read
6131 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6132
6133 .section "Examples of different lookup syntax" "SECID60"
6134 It is easy to confuse the two different kinds of lookup, especially as the
6135 lists that may contain the second kind are always expanded before being
6136 processed as lists. Therefore, they may also contain lookups of the first kind.
6137 Be careful to distinguish between the following two examples:
6138 .code
6139 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6140 domains = lsearch;/some/file
6141 .endd
6142 The first uses a string expansion, the result of which must be a domain list.
6143 No strings have been specified for a successful or a failing lookup; the
6144 defaults in this case are the looked-up data and an empty string, respectively.
6145 The expansion takes place before the string is processed as a list, and the
6146 file that is searched could contain lines like this:
6147 .code
6148 192.168.3.4: domain1:domain2:...
6149 192.168.1.9: domain3:domain4:...
6150 .endd
6151 When the lookup succeeds, the result of the expansion is a list of domains (and
6152 possibly other types of item that are allowed in domain lists).
6153
6154 In the second example, the lookup is a single item in a domain list. It causes
6155 Exim to use a lookup to see if the domain that is being processed can be found
6156 in the file. The file could contains lines like this:
6157 .code
6158 domain1:
6159 domain2:
6160 .endd
6161 Any data that follows the keys is not relevant when checking that the domain
6162 matches the list item.
6163
6164 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6165 Consider a file containing lines like this:
6166 .code
6167 192.168.5.6: lsearch;/another/file
6168 .endd
6169 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6170 first &%domains%& setting above generates the second setting, which therefore
6171 causes a second lookup to occur.
6172
6173 The rest of this chapter describes the different lookup types that are
6174 available. Any of them can be used in any part of the configuration where a
6175 lookup is permitted.
6176
6177
6178 .section "Lookup types" "SECID61"
6179 .cindex "lookup" "types of"
6180 .cindex "single-key lookup" "definition of"
6181 Two different types of data lookup are implemented:
6182
6183 .ilist
6184 The &'single-key'& type requires the specification of a file in which to look,
6185 and a single key to search for. The key must be a non-empty string for the
6186 lookup to succeed. The lookup type determines how the file is searched.
6187 .next
6188 .cindex "query-style lookup" "definition of"
6189 The &'query-style'& type accepts a generalized database query. No particular
6190 key value is assumed by Exim for query-style lookups. You can use whichever
6191 Exim variables you need to construct the database query.
6192 .endlist
6193
6194 The code for each lookup type is in a separate source file that is included in
6195 the binary of Exim only if the corresponding compile-time option is set. The
6196 default settings in &_src/EDITME_& are:
6197 .code
6198 LOOKUP_DBM=yes
6199 LOOKUP_LSEARCH=yes
6200 .endd
6201 which means that only linear searching and DBM lookups are included by default.
6202 For some types of lookup (e.g. SQL databases), you need to install appropriate
6203 libraries and header files before building Exim.
6204
6205
6206
6207
6208 .section "Single-key lookup types" "SECTsinglekeylookups"
6209 .cindex "lookup" "single-key types"
6210 .cindex "single-key lookup" "list of types"
6211 The following single-key lookup types are implemented:
6212
6213 .ilist
6214 .cindex "cdb" "description of"
6215 .cindex "lookup" "cdb"
6216 .cindex "binary zero" "in lookup key"
6217 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6218 string without a terminating binary zero. The cdb format is designed for
6219 indexed files that are read frequently and never updated, except by total
6220 re-creation. As such, it is particularly suitable for large files containing
6221 aliases or other indexed data referenced by an MTA. Information about cdb can
6222 be found in several places:
6223 .display
6224 &url(http://www.pobox.com/~djb/cdb.html)
6225 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6226 &url(http://packages.debian.org/stable/utils/freecdb.html)
6227 .endd
6228 A cdb distribution is not needed in order to build Exim with cdb support,
6229 because the code for reading cdb files is included directly in Exim itself.
6230 However, no means of building or testing cdb files is provided with Exim, so
6231 you need to obtain a cdb distribution in order to do this.
6232 .next
6233 .cindex "DBM" "lookup type"
6234 .cindex "lookup" "dbm"
6235 .cindex "binary zero" "in lookup key"
6236 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6237 DBM file by looking up the record with the given key. A terminating binary
6238 zero is included in the key that is passed to the DBM library. See section
6239 &<<SECTdb>>& for a discussion of DBM libraries.
6240
6241 .cindex "Berkeley DB library" "file format"
6242 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6243 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6244 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6245 the DB_UNKNOWN option. This enables it to handle any of the types of database
6246 that the library supports, and can be useful for accessing DBM files created by
6247 other applications. (For earlier DB versions, DB_HASH is always used.)
6248 .new
6249 .next
6250 .cindex "lookup" "dbmjz"
6251 .cindex "lookup" "dbm &-- embedded NULs"
6252 .cindex "sasldb2"
6253 .cindex "dbmjz lookup type"
6254 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6255 interpreted as an Exim list; the elements of the list are joined together with
6256 ASCII NUL characters to form the lookup key.  An example usage would be to
6257 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6258 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6259 &(cram_md5)& authenticator.
6260 .wen
6261 .next
6262 .cindex "lookup" "dbmnz"
6263 .cindex "lookup" "dbm &-- terminating zero"
6264 .cindex "binary zero" "in lookup key"
6265 .cindex "Courier"
6266 .cindex "&_/etc/userdbshadow.dat_&"
6267 .cindex "dbmnz lookup type"
6268 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6269 is not included in the key that is passed to the DBM library. You may need this
6270 if you want to look up data in files that are created by or shared with some
6271 other application that does not use terminating zeros. For example, you need to
6272 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6273 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6274 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6275 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6276 .next
6277 .cindex "lookup" "dsearch"
6278 .cindex "dsearch lookup type"
6279 &(dsearch)&: The given file must be a directory; this is searched for an entry
6280 whose name is the key by calling the &[lstat()]& function. The key may not
6281 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6282 the lookup is the name of the entry, which may be a file, directory,
6283 symbolic link, or any other kind of directory entry. An example of how this
6284 lookup can be used to support virtual domains is given in section
6285 &<<SECTvirtualdomains>>&.
6286 .next
6287 .cindex "lookup" "iplsearch"
6288 .cindex "iplsearch lookup type"
6289 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6290 terminated by a colon or white space or the end of the line. The keys in the
6291 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6292 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6293 being interpreted as a key terminator. For example:
6294 .code
6295 1.2.3.4:           data for 1.2.3.4
6296 192.168.0.0/16:    data for 192.168.0.0/16
6297 "abcd::cdab":      data for abcd::cdab
6298 "abcd:abcd::/32"   data for abcd:abcd::/32
6299 .endd
6300 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6301 file is searched linearly, using the CIDR masks where present, until a matching
6302 key is found. The first key that matches is used; there is no attempt to find a
6303 &"best"& match. Apart from the way the keys are matched, the processing for
6304 &(iplsearch)& is the same as for &(lsearch)&.
6305
6306 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6307 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6308 lookup types support only literal keys.
6309
6310 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6311 the implicit key is the host's IP address rather than its name (see section
6312 &<<SECThoslispatsikey>>&).
6313 .next
6314 .cindex "linear search"
6315 .cindex "lookup" "lsearch"
6316 .cindex "lsearch lookup type"
6317 .cindex "case sensitivity" "in lsearch lookup"
6318 &(lsearch)&: The given file is a text file that is searched linearly for a
6319 line beginning with the search key, terminated by a colon or white space or the
6320 end of the line. The search is case-insensitive; that is, upper and lower case
6321 letters are treated as the same. The first occurrence of the key that is found
6322 in the file is used.
6323
6324 White space between the key and the colon is permitted. The remainder of the
6325 line, with leading and trailing white space removed, is the data. This can be
6326 continued onto subsequent lines by starting them with any amount of white
6327 space, but only a single space character is included in the data at such a
6328 junction. If the data begins with a colon, the key must be terminated by a
6329 colon, for example:
6330 .code
6331 baduser:  :fail:
6332 .endd
6333 Empty lines and lines beginning with # are ignored, even if they occur in the
6334 middle of an item. This is the traditional textual format of alias files. Note
6335 that the keys in an &(lsearch)& file are literal strings. There is no
6336 wildcarding of any kind.
6337
6338 .cindex "lookup" "lsearch &-- colons in keys"
6339 .cindex "white space" "in lsearch key"
6340 In most &(lsearch)& files, keys are not required to contain colons or #
6341 characters, or white space. However, if you need this feature, it is available.
6342 If a key begins with a doublequote character, it is terminated only by a
6343 matching quote (or end of line), and the normal escaping rules apply to its
6344 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6345 quoted keys (exactly as for unquoted keys). There is no special handling of
6346 quotes for the data part of an &(lsearch)& line.
6347
6348 .next
6349 .cindex "NIS lookup type"
6350 .cindex "lookup" "NIS"
6351 .cindex "binary zero" "in lookup key"
6352 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6353 the given key, without a terminating binary zero. There is a variant called
6354 &(nis0)& which does include the terminating binary zero in the key. This is
6355 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6356 aliases; the full map names must be used.
6357
6358 .next
6359 .cindex "wildlsearch lookup type"
6360 .cindex "lookup" "wildlsearch"
6361 .cindex "nwildlsearch lookup type"
6362 .cindex "lookup" "nwildlsearch"
6363 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6364 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6365 the file may be wildcarded. The difference between these two lookup types is
6366 that for &(wildlsearch)&, each key in the file is string-expanded before being
6367 used, whereas for &(nwildlsearch)&, no expansion takes place.
6368
6369 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6370 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6371 file that are regular expressions can be made case-sensitive by the use of
6372 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6373
6374 . ==== As this is a nested list, any displays it contains must be indented
6375 . ==== as otherwise they are too far to the left.
6376
6377 .olist
6378 The string may begin with an asterisk to mean &"ends with"&. For example:
6379 .code
6380     *.a.b.c       data for anything.a.b.c
6381     *fish         data for anythingfish
6382 .endd
6383 .next
6384 The string may begin with a circumflex to indicate a regular expression. For
6385 example, for &(wildlsearch)&:
6386 .code
6387     ^\N\d+\.a\.b\N    data for <digits>.a.b
6388 .endd
6389 Note the use of &`\N`& to disable expansion of the contents of the regular
6390 expression. If you are using &(nwildlsearch)&, where the keys are not
6391 string-expanded, the equivalent entry is:
6392 .code
6393     ^\d+\.a\.b        data for <digits>.a.b
6394 .endd
6395 The case-insensitive flag is set at the start of compiling the regular
6396 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6397 For example, to make the entire pattern case-sensitive:
6398 .code
6399     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6400 .endd
6401
6402 If the regular expression contains white space or colon characters, you must
6403 either quote it (see &(lsearch)& above), or represent these characters in other
6404 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6405 colon. This may be easier than quoting, because if you quote, you have to
6406 escape all the backslashes inside the quotes.
6407
6408 &*Note*&: It is not possible to capture substrings in a regular expression
6409 match for later use, because the results of all lookups are cached. If a lookup
6410 is repeated, the result is taken from the cache, and no actual pattern matching
6411 takes place. The values of all the numeric variables are unset after a
6412 &((n)wildlsearch)& match.
6413
6414 .next
6415 Although I cannot see it being of much use, the general matching function that
6416 is used to implement &((n)wildlsearch)& means that the string may begin with a
6417 lookup name terminated by a semicolon, and followed by lookup data. For
6418 example:
6419 .code
6420     cdb;/some/file  data for keys that match the file
6421 .endd
6422 The data that is obtained from the nested lookup is discarded.
6423 .endlist olist
6424
6425 Keys that do not match any of these patterns are interpreted literally. The
6426 continuation rules for the data are the same as for &(lsearch)&, and keys may
6427 be followed by optional colons.
6428
6429 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6430 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6431 lookup types support only literal keys.
6432 .endlist ilist
6433
6434
6435 .section "Query-style lookup types" "SECID62"
6436 .cindex "lookup" "query-style types"
6437 .cindex "query-style lookup" "list of types"
6438 The supported query-style lookup types are listed below. Further details about
6439 many of them are given in later sections.
6440
6441 .ilist
6442 .cindex "DNS" "as a lookup type"
6443 .cindex "lookup" "DNS"
6444 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6445 are given in the supplied query. The resulting data is the contents of the
6446 records. See section &<<SECTdnsdb>>&.
6447 .next
6448 .cindex "InterBase lookup type"
6449 .cindex "lookup" "InterBase"
6450 &(ibase)&: This does a lookup in an InterBase database.
6451 .next
6452 .cindex "LDAP" "lookup type"
6453 .cindex "lookup" "LDAP"
6454 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6455 returns attributes from a single entry. There is a variant called &(ldapm)&
6456 that permits values from multiple entries to be returned. A third variant
6457 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6458 any attribute values. See section &<<SECTldap>>&.
6459 .next
6460 .cindex "MySQL" "lookup type"
6461 .cindex "lookup" "MySQL"
6462 &(mysql)&: The format of the query is an SQL statement that is passed to a
6463 MySQL database. See section &<<SECTsql>>&.
6464 .next
6465 .cindex "NIS+ lookup type"
6466 .cindex "lookup" "NIS+"
6467 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6468 the field to be returned. See section &<<SECTnisplus>>&.
6469 .next
6470 .cindex "Oracle" "lookup type"
6471 .cindex "lookup" "Oracle"
6472 &(oracle)&: The format of the query is an SQL statement that is passed to an
6473 Oracle database. See section &<<SECTsql>>&.
6474 .next
6475 .cindex "lookup" "passwd"
6476 .cindex "passwd lookup type"
6477 .cindex "&_/etc/passwd_&"
6478 &(passwd)& is a query-style lookup with queries that are just user names. The
6479 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6480 success, the result string is the same as you would get from an &(lsearch)&
6481 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6482 password value. For example:
6483 .code
6484 *:42:42:King Rat:/home/kr:/bin/bash
6485 .endd
6486 .next
6487 .cindex "PostgreSQL lookup type"
6488 .cindex "lookup" "PostgreSQL"
6489 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6490 PostgreSQL database. See section &<<SECTsql>>&.
6491
6492 .next
6493 .cindex "sqlite lookup type"
6494 .cindex "lookup" "sqlite"
6495 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6496 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6497
6498 .next
6499 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6500 not likely to be useful in normal operation.
6501 .next
6502 .cindex "whoson lookup type"
6503 .cindex "lookup" "whoson"
6504 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6505 allows a server to check whether a particular (dynamically allocated) IP
6506 address is currently allocated to a known (trusted) user and, optionally, to
6507 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6508 at one time for &"POP before SMTP"& authentication, but that approach has been
6509 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6510 &"POP before SMTP"& checking using ACL statements such as
6511 .code
6512 require condition = \
6513   ${lookup whoson {$sender_host_address}{yes}{no}}
6514 .endd
6515 The query consists of a single IP address. The value returned is the name of
6516 the authenticated user, which is stored in the variable &$value$&. However, in
6517 this example, the data in &$value$& is not used; the result of the lookup is
6518 one of the fixed strings &"yes"& or &"no"&.
6519 .endlist
6520
6521
6522
6523 .section "Temporary errors in lookups" "SECID63"
6524 .cindex "lookup" "temporary error in"
6525 Lookup functions can return temporary error codes if the lookup cannot be
6526 completed. For example, an SQL or LDAP database might be unavailable. For this
6527 reason, it is not advisable to use a lookup that might do this for critical
6528 options such as a list of local domains.
6529
6530 When a lookup cannot be completed in a router or transport, delivery
6531 of the message (to the relevant address) is deferred, as for any other
6532 temporary error. In other circumstances Exim may assume the lookup has failed,
6533 or may give up altogether.
6534
6535
6536
6537 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6538 .cindex "wildcard lookups"
6539 .cindex "lookup" "default values"
6540 .cindex "lookup" "wildcard"
6541 .cindex "lookup" "* added to type"
6542 .cindex "default" "in single-key lookups"
6543 In this context, a &"default value"& is a value specified by the administrator
6544 that is to be used if a lookup fails.
6545
6546 &*Note:*& This section applies only to single-key lookups. For query-style
6547 lookups, the facilities of the query language must be used. An attempt to
6548 specify a default for a query-style lookup provokes an error.
6549
6550 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6551 and the initial lookup fails, the key &"*"& is looked up in the file to
6552 provide a default value. See also the section on partial matching below.
6553
6554 .cindex "*@ with single-key lookup"
6555 .cindex "lookup" "*@ added to type"
6556 .cindex "alias file" "per-domain default"
6557 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6558 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6559 character, a second lookup is done with everything before the last @ replaced
6560 by *. This makes it possible to provide per-domain defaults in alias files
6561 that include the domains in the keys. If the second lookup fails (or doesn't
6562 take place because there is no @ in the key), &"*"& is looked up.
6563 For example, a &(redirect)& router might contain:
6564 .code
6565 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6566 .endd
6567 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6568 looks up these keys, in this order:
6569 .code
6570 jane@eyre.example
6571 *@eyre.example
6572 *
6573 .endd
6574 The data is taken from whichever key it finds first. &*Note*&: In an
6575 &(lsearch)& file, this does not mean the first of these keys in the file. A
6576 complete scan is done for each key, and only if it is not found at all does
6577 Exim move on to try the next key.
6578
6579
6580
6581 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6582 .cindex "partial matching"
6583 .cindex "wildcard lookups"
6584 .cindex "lookup" "partial matching"
6585 .cindex "lookup" "wildcard"
6586 .cindex "asterisk" "in search type"
6587 The normal operation of a single-key lookup is to search the file for an exact
6588 match with the given key. However, in a number of situations where domains are
6589 being looked up, it is useful to be able to do partial matching. In this case,
6590 information in the file that has a key starting with &"*."& is matched by any
6591 domain that ends with the components that follow the full stop. For example, if
6592 a key in a DBM file is
6593 .code
6594 *.dates.fict.example
6595 .endd
6596 then when partial matching is enabled this is matched by (amongst others)
6597 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6598 by &'dates.fict.example'&, if that does not appear as a separate key in the
6599 file.
6600
6601 &*Note*&: Partial matching is not available for query-style lookups. It is
6602 also not available for any lookup items in address lists (see section
6603 &<<SECTaddresslist>>&).
6604
6605 Partial matching is implemented by doing a series of separate lookups using
6606 keys constructed by modifying the original subject key. This means that it can
6607 be used with any of the single-key lookup types, provided that
6608 partial matching keys
6609 beginning with a special prefix (default &"*."&) are included in the data file.
6610 Keys in the file that do not begin with the prefix are matched only by
6611 unmodified subject keys when partial matching is in use.
6612
6613 Partial matching is requested by adding the string &"partial-"& to the front of
6614 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6615 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6616 is added at the start of the subject key, and it is looked up again. If that
6617 fails, further lookups are tried with dot-separated components removed from the
6618 start of the subject key, one-by-one, and &"*."& added on the front of what
6619 remains.
6620
6621 A minimum number of two non-* components are required. This can be adjusted
6622 by including a number before the hyphen in the search type. For example,
6623 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6624 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6625 subject key is &'2250.dates.fict.example'& then the following keys are looked
6626 up when the minimum number of non-* components is two:
6627 .code
6628 2250.dates.fict.example
6629 *.2250.dates.fict.example
6630 *.dates.fict.example
6631 *.fict.example
6632 .endd
6633 As soon as one key in the sequence is successfully looked up, the lookup
6634 finishes.
6635
6636 .cindex "lookup" "partial matching &-- changing prefix"
6637 .cindex "prefix" "for partial matching"
6638 The use of &"*."& as the partial matching prefix is a default that can be
6639 changed. The motivation for this feature is to allow Exim to operate with file
6640 formats that are used by other MTAs. A different prefix can be supplied in
6641 parentheses instead of the hyphen after &"partial"&. For example:
6642 .code
6643 domains = partial(.)lsearch;/some/file
6644 .endd
6645 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6646 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6647 components is unchanged). The prefix may consist of any punctuation characters
6648 other than a closing parenthesis. It may be empty, for example:
6649 .code
6650 domains = partial1()cdb;/some/file
6651 .endd
6652 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6653 &`a.b.c`&, &`b.c`&, and &`c`&.
6654
6655 If &"partial0"& is specified, what happens at the end (when the lookup with
6656 just one non-wild component has failed, and the original key is shortened right
6657 down to the null string) depends on the prefix:
6658
6659 .ilist
6660 If the prefix has zero length, the whole lookup fails.
6661 .next
6662 If the prefix has length 1, a lookup for just the prefix is done. For
6663 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6664 .next
6665 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6666 remainder is looked up. With the default prefix, therefore, the final lookup is
6667 for &"*"& on its own.
6668 .next
6669 Otherwise, the whole prefix is looked up.
6670 .endlist
6671
6672
6673 If the search type ends in &"*"& or &"*@"& (see section
6674 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6675 this implies happens after all partial lookups have failed. If &"partial0"& is
6676 specified, adding &"*"& to the search type has no effect with the default
6677 prefix, because the &"*"& key is already included in the sequence of partial
6678 lookups. However, there might be a use for lookup types such as
6679 &"partial0(.)lsearch*"&.
6680
6681 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6682 in domain lists and the like. Partial matching works only in terms of
6683 dot-separated components; a key such as &`*fict.example`&
6684 in a database file is useless, because the asterisk in a partial matching
6685 subject key is always followed by a dot.
6686
6687
6688
6689
6690 .section "Lookup caching" "SECID64"
6691 .cindex "lookup" "caching"
6692 .cindex "caching" "lookup data"
6693 Exim caches all lookup results in order to avoid needless repetition of
6694 lookups. However, because (apart from the daemon) Exim operates as a collection
6695 of independent, short-lived processes, this caching applies only within a
6696 single Exim process. There is no inter-process lookup caching facility.
6697
6698 For single-key lookups, Exim keeps the relevant files open in case there is
6699 another lookup that needs them. In some types of configuration this can lead to
6700 many files being kept open for messages with many recipients. To avoid hitting
6701 the operating system limit on the number of simultaneously open files, Exim
6702 closes the least recently used file when it needs to open more files than its
6703 own internal limit, which can be changed via the &%lookup_open_max%& option.
6704
6705 The single-key lookup files are closed and the lookup caches are flushed at
6706 strategic points during delivery &-- for example, after all routing is
6707 complete.
6708
6709
6710
6711
6712 .section "Quoting lookup data" "SECID65"
6713 .cindex "lookup" "quoting"
6714 .cindex "quoting" "in lookups"
6715 When data from an incoming message is included in a query-style lookup, there
6716 is the possibility of special characters in the data messing up the syntax of
6717 the query. For example, a NIS+ query that contains
6718 .code
6719 [name=$local_part]
6720 .endd
6721 will be broken if the local part happens to contain a closing square bracket.
6722 For NIS+, data can be enclosed in double quotes like this:
6723 .code
6724 [name="$local_part"]
6725 .endd
6726 but this still leaves the problem of a double quote in the data. The rule for
6727 NIS+ is that double quotes must be doubled. Other lookup types have different
6728 rules, and to cope with the differing requirements, an expansion operator
6729 of the following form is provided:
6730 .code
6731 ${quote_<lookup-type>:<string>}
6732 .endd
6733 For example, the safest way to write the NIS+ query is
6734 .code
6735 [name="${quote_nisplus:$local_part}"]
6736 .endd
6737 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6738 operator can be used for all lookup types, but has no effect for single-key
6739 lookups, since no quoting is ever needed in their key strings.
6740
6741
6742
6743
6744 .section "More about dnsdb" "SECTdnsdb"
6745 .cindex "dnsdb lookup"
6746 .cindex "lookup" "dnsdb"
6747 .cindex "DNS" "as a lookup type"
6748 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6749 of a record type and a domain name, separated by an equals sign. For example,
6750 an expansion string could contain:
6751 .code
6752 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6753 .endd
6754 If the lookup succeeds, the result is placed in &$value$&, which in this case
6755 is used on its own as the result. If the lookup does not succeed, the
6756 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6757 &<<SECTforexpfai>>& for an explanation of what this means.
6758
6759 .new
6760 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, and TXT,
6761 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6762 configured). If no type is given, TXT is assumed. When the type is PTR,
6763 the data can be an IP address, written as normal; inversion and the addition of
6764 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6765 .wen
6766 .code
6767 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6768 .endd
6769 If the data for a PTR record is not a syntactically valid IP address, it is not
6770 altered and nothing is added.
6771
6772 .cindex "MX record" "in &(dnsdb)& lookup"
6773 .cindex "SRV record" "in &(dnsdb)& lookup"
6774 For an MX lookup, both the preference value and the host name are returned for
6775 each record, separated by a space. For an SRV lookup, the priority, weight,
6776 port, and host name are returned for each record, separated by spaces.
6777
6778 For any record type, if multiple records are found (or, for A6 lookups, if a
6779 single record leads to multiple addresses), the data is returned as a
6780 concatenation, with newline as the default separator. The order, of course,
6781 depends on the DNS resolver. You can specify a different separator character
6782 between multiple records by putting a right angle-bracket followed immediately
6783 by the new separator at the start of the query. For example:
6784 .code
6785 ${lookup dnsdb{>: a=host1.example}}
6786 .endd
6787 It is permitted to specify a space as the separator character. Further
6788 white space is ignored.
6789
6790 .cindex "TXT record" "in &(dnsdb)& lookup"
6791 .cindex "SPF record" "in &(dnsdb)& lookup"
6792 .new
6793 For TXT and SPF records with multiple items of data, only the first item is returned,
6794 unless a separator for them is specified using a comma after the separator
6795 character followed immediately by the TXT/SPF record item separator. To concatenate
6796 items without a separator, use a semicolon instead.
6797 .wen
6798 .code
6799 ${lookup dnsdb{>\n,: txt=a.b.example}}
6800 ${lookup dnsdb{>\n; txt=a.b.example}}
6801 .endd
6802 It is permitted to specify a space as the separator character. Further
6803 white space is ignored.
6804
6805 .section "Pseudo dnsdb record types" "SECID66"
6806 .cindex "MX record" "in &(dnsdb)& lookup"
6807 By default, both the preference value and the host name are returned for
6808 each MX record, separated by a space. If you want only host names, you can use
6809 the pseudo-type MXH:
6810 .code
6811 ${lookup dnsdb{mxh=a.b.example}}
6812 .endd
6813 In this case, the preference values are omitted, and just the host names are
6814 returned.
6815
6816 .cindex "name server for enclosing domain"
6817 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6818 records on the given domain, but if none are found, it removes the first
6819 component of the domain name, and tries again. This process continues until NS
6820 records are found or there are no more components left (or there is a DNS
6821 error). In other words, it may return the name servers for a top-level domain,
6822 but it never returns the root name servers. If there are no NS records for the
6823 top-level domain, the lookup fails. Consider these examples:
6824 .code
6825 ${lookup dnsdb{zns=xxx.quercite.com}}
6826 ${lookup dnsdb{zns=xxx.edu}}
6827 .endd
6828 Assuming that in each case there are no NS records for the full domain name,
6829 the first returns the name servers for &%quercite.com%&, and the second returns
6830 the name servers for &%edu%&.
6831
6832 You should be careful about how you use this lookup because, unless the
6833 top-level domain does not exist, the lookup always returns some host names. The
6834 sort of use to which this might be put is for seeing if the name servers for a
6835 given domain are on a blacklist. You can probably assume that the name servers
6836 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6837 such a list.
6838
6839 .cindex "CSA" "in &(dnsdb)& lookup"
6840 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6841 records according to the CSA rules, which are described in section
6842 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6843 not sufficient because of the extra parent domain search behaviour of CSA. The
6844 result of a successful lookup such as:
6845 .code
6846 ${lookup dnsdb {csa=$sender_helo_name}}
6847 .endd
6848 has two space-separated fields: an authorization code and a target host name.
6849 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6850 authorization required but absent, or &"?"& for unknown.
6851
6852
6853 .section "Multiple dnsdb lookups" "SECID67"
6854 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6855 However, you can specify a list of domains or IP addresses in a single
6856 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6857 the default separator, but with the ability to change this. For example:
6858 .code
6859 ${lookup dnsdb{one.domain.com:two.domain.com}}
6860 ${lookup dnsdb{a=one.host.com:two.host.com}}
6861 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6862 .endd
6863 In order to retain backwards compatibility, there is one special case: if
6864 the lookup type is PTR and no change of separator is specified, Exim looks
6865 to see if the rest of the string is precisely one IPv6 address. In this
6866 case, it does not treat it as a list.
6867
6868 The data from each lookup is concatenated, with newline separators by default,
6869 in the same way that multiple DNS records for a single item are handled. A
6870 different separator can be specified, as described above.
6871
6872 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6873 temporary DNS error for any of them, the behaviour is controlled by
6874 an optional keyword followed by a comma that may appear before the record
6875 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6876 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6877 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6878 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6879 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6880 error causes the whole lookup to defer only if none of the other lookups
6881 succeed. The default is &"lax"&, so the following lookups are equivalent:
6882 .code
6883 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6884 ${lookup dnsdb{a=one.host.com:two.host.com}}
6885 .endd
6886 Thus, in the default case, as long as at least one of the DNS lookups
6887 yields some data, the lookup succeeds.
6888
6889
6890
6891
6892 .section "More about LDAP" "SECTldap"
6893 .cindex "LDAP" "lookup, more about"
6894 .cindex "lookup" "LDAP"
6895 .cindex "Solaris" "LDAP"
6896 The original LDAP implementation came from the University of Michigan; this has
6897 become &"Open LDAP"&, and there are now two different releases. Another
6898 implementation comes from Netscape, and Solaris 7 and subsequent releases
6899 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6900 the lookup function level, their error handling is different. For this reason
6901 it is necessary to set a compile-time variable when building Exim with LDAP, to
6902 indicate which LDAP library is in use. One of the following should appear in
6903 your &_Local/Makefile_&:
6904 .code
6905 LDAP_LIB_TYPE=UMICHIGAN
6906 LDAP_LIB_TYPE=OPENLDAP1
6907 LDAP_LIB_TYPE=OPENLDAP2
6908 LDAP_LIB_TYPE=NETSCAPE
6909 LDAP_LIB_TYPE=SOLARIS
6910 .endd
6911 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6912 same interface as the University of Michigan version.
6913
6914 There are three LDAP lookup types in Exim. These behave slightly differently in
6915 the way they handle the results of a query:
6916
6917 .ilist
6918 &(ldap)& requires the result to contain just one entry; if there are more, it
6919 gives an error.
6920 .next
6921 &(ldapdn)& also requires the result to contain just one entry, but it is the
6922 Distinguished Name that is returned rather than any attribute values.
6923 .next
6924 &(ldapm)& permits the result to contain more than one entry; the attributes
6925 from all of them are returned.
6926 .endlist
6927
6928
6929 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6930 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6931 the data returned by a successful lookup is described in the next section.
6932 First we explain how LDAP queries are coded.
6933
6934
6935 .section "Format of LDAP queries" "SECTforldaque"
6936 .cindex "LDAP" "query format"
6937 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
6938 the configuration of a &(redirect)& router one might have this setting:
6939 .code
6940 data = ${lookup ldap \
6941   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
6942   c=UK?mailbox?base?}}
6943 .endd
6944 .cindex "LDAP" "with TLS"
6945 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
6946 secure (encrypted) LDAP connections. The second of these ensures that an
6947 encrypted TLS connection is used.
6948
6949 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
6950 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
6951 See the &%ldap_start_tls%& option.
6952
6953
6954 .section "LDAP quoting" "SECID68"
6955 .cindex "LDAP" "quoting"
6956 Two levels of quoting are required in LDAP queries, the first for LDAP itself
6957 and the second because the LDAP query is represented as a URL. Furthermore,
6958 within an LDAP query, two different kinds of quoting are required. For this
6959 reason, there are two different LDAP-specific quoting operators.
6960
6961 The &%quote_ldap%& operator is designed for use on strings that are part of
6962 filter specifications. Conceptually, it first does the following conversions on
6963 the string:
6964 .code
6965 *   =>   \2A
6966 (   =>   \28
6967 )   =>   \29
6968 \   =>   \5C
6969 .endd
6970 in accordance with RFC 2254. The resulting string is then quoted according
6971 to the rules for URLs, that is, all non-alphanumeric characters except
6972 .code
6973 ! $ ' - . _ ( ) * +
6974 .endd
6975 are converted to their hex values, preceded by a percent sign. For example:
6976 .code
6977 ${quote_ldap: a(bc)*, a<yz>; }
6978 .endd
6979 yields
6980 .code
6981 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
6982 .endd
6983 Removing the URL quoting, this is (with a leading and a trailing space):
6984 .code
6985 a\28bc\29\2A, a<yz>;
6986 .endd
6987 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
6988 base DN specifications in queries. Conceptually, it first converts the string
6989 by inserting a backslash in front of any of the following characters:
6990 .code
6991 , + " \ < > ;
6992 .endd
6993 It also inserts a backslash before any leading spaces or # characters, and
6994 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
6995 is then quoted according to the rules for URLs. For example:
6996 .code
6997 ${quote_ldap_dn: a(bc)*, a<yz>; }
6998 .endd
6999 yields
7000 .code
7001 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7002 .endd
7003 Removing the URL quoting, this is (with a trailing space):
7004 .code
7005 \ a(bc)*\, a\<yz\>\;\
7006 .endd
7007 There are some further comments about quoting in the section on LDAP
7008 authentication below.
7009
7010
7011 .section "LDAP connections" "SECID69"
7012 .cindex "LDAP" "connections"
7013 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7014 is in use, via a Unix domain socket. The example given above does not specify
7015 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7016 by starting it with
7017 .code
7018 ldap://<hostname>:<port>/...
7019 .endd
7020 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7021 used. When no server is specified in a query, a list of default servers is
7022 taken from the &%ldap_default_servers%& configuration option. This supplies a
7023 colon-separated list of servers which are tried in turn until one successfully
7024 handles a query, or there is a serious error. Successful handling either
7025 returns the requested data, or indicates that it does not exist. Serious errors
7026 are syntactical, or multiple values when only a single value is expected.
7027 Errors which cause the next server to be tried are connection failures, bind
7028 failures, and timeouts.
7029
7030 For each server name in the list, a port number can be given. The standard way
7031 of specifying a host and port is to use a colon separator (RFC 1738). Because
7032 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7033 doubled. For example
7034 .code
7035 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7036 .endd
7037 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7038 to the LDAP library with no server name, and the library's default (normally
7039 the local host) is used.
7040
7041 If you are using the OpenLDAP library, you can connect to an LDAP server using
7042 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7043 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7044 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7045 not available.
7046
7047 For this type of connection, instead of a host name for the server, a pathname
7048 for the socket is required, and the port number is not relevant. The pathname
7049 can be specified either as an item in &%ldap_default_servers%&, or inline in
7050 the query. In the former case, you can have settings such as
7051 .code
7052 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7053 .endd
7054 When the pathname is given in the query, you have to escape the slashes as
7055 &`%2F`& to fit in with the LDAP URL syntax. For example:
7056 .code
7057 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7058 .endd
7059 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7060 a pathname, it uses the Unix domain socket code, even if the query actually
7061 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7062 socket connection. This behaviour means that you can use a setting of
7063 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7064 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7065 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7066 backup host.
7067
7068 If an explicit &`ldapi`& type is given in a query when a host name is
7069 specified, an error is diagnosed. However, if there are more items in
7070 &%ldap_default_servers%&, they are tried. In other words:
7071
7072 .ilist
7073 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7074 interface.
7075 .next
7076 Using &`ldapi`& with a host name causes an error.
7077 .endlist
7078
7079
7080 Using &`ldapi`& with no host or path in the query, and no setting of
7081 &%ldap_default_servers%&, does whatever the library does by default.
7082
7083
7084
7085 .section "LDAP authentication and control information" "SECID70"
7086 .cindex "LDAP" "authentication"
7087 The LDAP URL syntax provides no way of passing authentication and other control
7088 information to the server. To make this possible, the URL in an LDAP query may
7089 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7090 spaces. If a value contains spaces it must be enclosed in double quotes, and
7091 when double quotes are used, backslash is interpreted in the usual way inside
7092 them. The following names are recognized:
7093 .display
7094 &`DEREFERENCE`&  set the dereferencing parameter
7095 &`NETTIME    `&  set a timeout for a network operation
7096 &`USER       `&  set the DN, for authenticating the LDAP bind
7097 &`PASS       `&  set the password, likewise
7098 &`REFERRALS  `&  set the referrals parameter
7099 &`SIZE       `&  set the limit for the number of entries returned
7100 &`TIME       `&  set the maximum waiting time for a query
7101 .endd
7102 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7103 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7104 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7105 library from trying to follow referrals issued by the LDAP server.
7106
7107 The name CONNECT is an obsolete name for NETTIME, retained for
7108 backwards compatibility. This timeout (specified as a number of seconds) is
7109 enforced from the client end for operations that can be carried out over a
7110 network. Specifically, it applies to network connections and calls to the
7111 &'ldap_result()'& function. If the value is greater than zero, it is used if
7112 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7113 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7114 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7115 Netscape SDK; for OpenLDAP no action is taken.
7116
7117 The TIME parameter (also a number of seconds) is passed to the server to
7118 set a server-side limit on the time taken to complete a search.
7119
7120
7121 Here is an example of an LDAP query in an Exim lookup that uses some of these
7122 values. This is a single line, folded to fit on the page:
7123 .code
7124 ${lookup ldap
7125   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7126   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7127   {$value}fail}
7128 .endd
7129 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7130 any of the auxiliary data. Exim configuration settings that include lookups
7131 which contain password information should be preceded by &"hide"& to prevent
7132 non-admin users from using the &%-bP%& option to see their values.
7133
7134 The auxiliary data items may be given in any order. The default is no
7135 connection timeout (the system timeout is used), no user or password, no limit
7136 on the number of entries returned, and no time limit on queries.
7137
7138 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7139 removes any URL quoting that it may contain before passing it LDAP. Apparently
7140 some libraries do this for themselves, but some do not. Removing the URL
7141 quoting has two advantages:
7142
7143 .ilist
7144 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7145 DNs as with DNs inside actual queries.
7146 .next
7147 It permits spaces inside USER= DNs.
7148 .endlist
7149
7150 For example, a setting such as
7151 .code
7152 USER=cn=${quote_ldap_dn:$1}
7153 .endd
7154 should work even if &$1$& contains spaces.
7155
7156 Expanded data for the PASS= value should be quoted using the &%quote%&
7157 expansion operator, rather than the LDAP quote operators. The only reason this
7158 field needs quoting is to ensure that it conforms to the Exim syntax, which
7159 does not allow unquoted spaces. For example:
7160 .code
7161 PASS=${quote:$3}
7162 .endd
7163 The LDAP authentication mechanism can be used to check passwords as part of
7164 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7165 &<<CHAPexpand>>&.
7166
7167
7168
7169 .section "Format of data returned by LDAP" "SECID71"
7170 .cindex "LDAP" "returned data formats"
7171 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7172 as a sequence of values, for example
7173 .code
7174 cn=manager, o=University of Cambridge, c=UK
7175 .endd
7176 The &(ldap)& lookup type generates an error if more than one entry matches the
7177 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7178 the result between the data from different entries. It is possible for multiple
7179 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7180 you know that whatever values are returned all came from a single entry in the
7181 directory.
7182
7183 In the common case where you specify a single attribute in your LDAP query, the
7184 result is not quoted, and does not contain the attribute name. If the attribute
7185 has multiple values, they are separated by commas.
7186
7187 If you specify multiple attributes, the result contains space-separated, quoted
7188 strings, each preceded by the attribute name and an equals sign. Within the
7189 quotes, the quote character, backslash, and newline are escaped with
7190 backslashes, and commas are used to separate multiple values for the attribute.
7191 Apart from the escaping, the string within quotes takes the same form as the
7192 output when a single attribute is requested. Specifying no attributes is the
7193 same as specifying all of an entry's attributes.
7194
7195 Here are some examples of the output format. The first line of each pair is an
7196 LDAP query, and the second is the data that is returned. The attribute called
7197 &%attr1%& has two values, whereas &%attr2%& has only one value:
7198 .code
7199 ldap:///o=base?attr1?sub?(uid=fred)
7200 value1.1, value1.2
7201
7202 ldap:///o=base?attr2?sub?(uid=fred)
7203 value two
7204
7205 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7206 attr1="value1.1, value1.2" attr2="value two"
7207
7208 ldap:///o=base??sub?(uid=fred)
7209 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7210 .endd
7211 The &%extract%& operator in string expansions can be used to pick out
7212 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7213 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7214 results of LDAP lookups.
7215
7216
7217
7218
7219 .section "More about NIS+" "SECTnisplus"
7220 .cindex "NIS+ lookup type"
7221 .cindex "lookup" "NIS+"
7222 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7223 and field name. If this is given, the result of a successful query is the
7224 contents of the named field; otherwise the result consists of a concatenation
7225 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7226 values containing spaces are quoted. For example, the query
7227 .code
7228 [name=mg1456],passwd.org_dir
7229 .endd
7230 might return the string
7231 .code
7232 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7233 home=/home/mg1456 shell=/bin/bash shadow=""
7234 .endd
7235 (split over two lines here to fit on the page), whereas
7236 .code
7237 [name=mg1456],passwd.org_dir:gcos
7238 .endd
7239 would just return
7240 .code
7241 Martin Guerre
7242 .endd
7243 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7244 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7245 operator is to double any quote characters within the text.
7246
7247
7248
7249 .section "SQL lookups" "SECTsql"
7250 .cindex "SQL lookup types"
7251 .cindex "MySQL" "lookup type"
7252 .cindex "PostgreSQL lookup type"
7253 .cindex "lookup" "MySQL"
7254 .cindex "lookup" "PostgreSQL"
7255 .cindex "Oracle" "lookup type"
7256 .cindex "lookup" "Oracle"
7257 .cindex "InterBase lookup type"
7258 .cindex "lookup" "InterBase"
7259 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7260 databases. Queries for these databases contain SQL statements, so an example
7261 might be
7262 .code
7263 ${lookup mysql{select mailbox from users where id='userx'}\
7264   {$value}fail}
7265 .endd
7266 If the result of the query contains more than one field, the data for each
7267 field in the row is returned, preceded by its name, so the result of
7268 .code
7269 ${lookup pgsql{select home,name from users where id='userx'}\
7270   {$value}}
7271 .endd
7272 might be
7273 .code
7274 home=/home/userx name="Mister X"
7275 .endd
7276 Empty values and values containing spaces are double quoted, with embedded
7277 quotes escaped by a backslash. If the result of the query contains just one
7278 field, the value is passed back verbatim, without a field name, for example:
7279 .code
7280 Mister X
7281 .endd
7282 If the result of the query yields more than one row, it is all concatenated,
7283 with a newline between the data for each row.
7284
7285
7286 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7287 .cindex "MySQL" "lookup type"
7288 .cindex "PostgreSQL lookup type"
7289 .cindex "lookup" "MySQL"
7290 .cindex "lookup" "PostgreSQL"
7291 .cindex "Oracle" "lookup type"
7292 .cindex "lookup" "Oracle"
7293 .cindex "InterBase lookup type"
7294 .cindex "lookup" "InterBase"
7295 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7296 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7297 option (as appropriate) must be set to a colon-separated list of server
7298 information.
7299 (For MySQL and PostgreSQL only, the global option need not be set if all
7300 queries contain their own server information &-- see section
7301 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7302 items: host name, database name, user name, and password. In the case of
7303 Oracle, the host name field is used for the &"service name"&, and the database
7304 name field is not used and should be empty. For example:
7305 .code
7306 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7307 .endd
7308 Because password data is sensitive, you should always precede the setting with
7309 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7310 option. Here is an example where two MySQL servers are listed:
7311 .code
7312 hide mysql_servers = localhost/users/root/secret:\
7313                      otherhost/users/root/othersecret
7314 .endd
7315 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7316 because this is a colon-separated list, the colon has to be doubled. For each
7317 query, these parameter groups are tried in order until a connection is made and
7318 a query is successfully processed. The result of a query may be that no data is
7319 found, but that is still a successful query. In other words, the list of
7320 servers provides a backup facility, not a list of different places to look.
7321
7322 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7323 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7324 respectively, and the characters single-quote, double-quote, and backslash
7325 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7326 addition, escapes the percent and underscore characters. This cannot be done
7327 for MySQL because these escapes are not recognized in contexts where these
7328 characters are not special.
7329
7330 .section "Specifying the server in the query" "SECTspeserque"
7331 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7332 it is possible to specify a list of servers with an individual query. This is
7333 done by starting the query with
7334 .display
7335 &`servers=`&&'server1:server2:server3:...'&&`;`&
7336 .endd
7337 Each item in the list may take one of two forms:
7338 .olist
7339 If it contains no slashes it is assumed to be just a host name. The appropriate
7340 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7341 of the same name, and the remaining parameters (database, user, password) are
7342 taken from there.
7343 .next
7344 If it contains any slashes, it is taken as a complete parameter set.
7345 .endlist
7346 The list of servers is used in exactly the same way as the global list.
7347 Once a connection to a server has happened and a query has been
7348 successfully executed, processing of the lookup ceases.
7349
7350 This feature is intended for use in master/slave situations where updates
7351 are occurring and you want to update the master rather than a slave. If the
7352 master is in the list as a backup for reading, you might have a global setting
7353 like this:
7354 .code
7355 mysql_servers = slave1/db/name/pw:\
7356                 slave2/db/name/pw:\
7357                 master/db/name/pw
7358 .endd
7359 In an updating lookup, you could then write:
7360 .code
7361 ${lookup mysql{servers=master; UPDATE ...} }
7362 .endd
7363 That query would then be sent only to the master server. If, on the other hand,
7364 the master is not to be used for reading, and so is not present in the global
7365 option, you can still update it by a query of this form:
7366 .code
7367 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7368 .endd
7369
7370
7371 .section "Special MySQL features" "SECID73"
7372 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7373 causes a connection to the server on the local host by means of a Unix domain
7374 socket. An alternate socket can be specified in parentheses. The full syntax of
7375 each item in &%mysql_servers%& is:
7376 .display
7377 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7378   <&'user'&>/<&'password'&>
7379 .endd
7380 Any of the three sub-parts of the first field can be omitted. For normal use on
7381 the local host it can be left blank or set to just &"localhost"&.
7382
7383 No database need be supplied &-- but if it is absent here, it must be given in
7384 the queries.
7385
7386 If a MySQL query is issued that does not request any data (an insert, update,
7387 or delete command), the result of the lookup is the number of rows affected.
7388
7389 &*Warning*&: This can be misleading. If an update does not actually change
7390 anything (for example, setting a field to the value it already has), the result
7391 is zero because no rows are affected.
7392
7393
7394 .section "Special PostgreSQL features" "SECID74"
7395 PostgreSQL lookups can also use Unix domain socket connections to the database.
7396 This is usually faster and costs less CPU time than a TCP/IP connection.
7397 However it can be used only if the mail server runs on the same machine as the
7398 database server. A configuration line for PostgreSQL via Unix domain sockets
7399 looks like this:
7400 .code
7401 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7402 .endd
7403 In other words, instead of supplying a host name, a path to the socket is
7404 given. The path name is enclosed in parentheses so that its slashes aren't
7405 visually confused with the delimiters for the other server parameters.
7406
7407 If a PostgreSQL query is issued that does not request any data (an insert,
7408 update, or delete command), the result of the lookup is the number of rows
7409 affected.
7410
7411 .section "More about SQLite" "SECTsqlite"
7412 .cindex "lookup" "SQLite"
7413 .cindex "sqlite lookup type"
7414 SQLite is different to the other SQL lookups because a file name is required in
7415 addition to the SQL query. An SQLite database is a single file, and there is no
7416 daemon as in the other SQL databases. The interface to Exim requires the name
7417 of the file, as an absolute path, to be given at the start of the query. It is
7418 separated from the query by white space. This means that the path name cannot
7419 contain white space. Here is a lookup expansion example:
7420 .code
7421 ${lookup sqlite {/some/thing/sqlitedb \
7422   select name from aliases where id='userx';}}
7423 .endd
7424 In a list, the syntax is similar. For example:
7425 .code
7426 domainlist relay_domains = sqlite;/some/thing/sqlitedb \
7427    select * from relays where ip='$sender_host_address';
7428 .endd
7429 The only character affected by the &%quote_sqlite%& operator is a single
7430 quote, which it doubles.
7431
7432 The SQLite library handles multiple simultaneous accesses to the database
7433 internally. Multiple readers are permitted, but only one process can
7434 update at once. Attempts to access the database while it is being updated
7435 are rejected after a timeout period, during which the SQLite library
7436 waits for the lock to be released. In Exim, the default timeout is set
7437 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7438 option.
7439 .ecindex IIDfidalo1
7440 .ecindex IIDfidalo2
7441
7442
7443 . ////////////////////////////////////////////////////////////////////////////
7444 . ////////////////////////////////////////////////////////////////////////////
7445
7446 .chapter "Domain, host, address, and local part lists" &&&
7447          "CHAPdomhosaddlists" &&&
7448          "Domain, host, and address lists"
7449 .scindex IIDdohoadli "lists of domains; hosts; etc."
7450 A number of Exim configuration options contain lists of domains, hosts,
7451 email addresses, or local parts. For example, the &%hold_domains%& option
7452 contains a list of domains whose delivery is currently suspended. These lists
7453 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7454 arguments to expansion conditions such as &%match_domain%&.
7455
7456 Each item in one of these lists is a pattern to be matched against a domain,
7457 host, email address, or local part, respectively. In the sections below, the
7458 different types of pattern for each case are described, but first we cover some
7459 general facilities that apply to all four kinds of list.
7460
7461
7462
7463 .section "Expansion of lists" "SECID75"
7464 .cindex "expansion" "of lists"
7465 Each list is expanded as a single string before it is used. The result of
7466 expansion must be a list, possibly containing empty items, which is split up
7467 into separate items for matching. By default, colon is the separator character,
7468 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7469 &<<SECTempitelis>>& for details of the list syntax; the second of these
7470 discusses the way to specify empty list items.
7471
7472
7473 If the string expansion is forced to fail, Exim behaves as if the item it is
7474 testing (domain, host, address, or local part) is not in the list. Other
7475 expansion failures cause temporary errors.
7476
7477 If an item in a list is a regular expression, backslashes, dollars and possibly
7478 other special characters in the expression must be protected against
7479 misinterpretation by the string expander. The easiest way to do this is to use
7480 the &`\N`& expansion feature to indicate that the contents of the regular
7481 expression should not be expanded. For example, in an ACL you might have:
7482 .code
7483 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7484                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7485 .endd
7486 The first item is a regular expression that is protected from expansion by
7487 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7488 senders based on the receiving domain.
7489
7490
7491
7492
7493 .section "Negated items in lists" "SECID76"
7494 .cindex "list" "negation"
7495 .cindex "negation" "in lists"
7496 Items in a list may be positive or negative. Negative items are indicated by a
7497 leading exclamation mark, which may be followed by optional white space. A list
7498 defines a set of items (domains, etc). When Exim processes one of these lists,
7499 it is trying to find out whether a domain, host, address, or local part
7500 (respectively) is in the set that is defined by the list. It works like this:
7501
7502 The list is scanned from left to right. If a positive item is matched, the
7503 subject that is being checked is in the set; if a negative item is matched, the
7504 subject is not in the set. If the end of the list is reached without the
7505 subject having matched any of the patterns, it is in the set if the last item
7506 was a negative one, but not if it was a positive one. For example, the list in
7507 .code
7508 domainlist relay_domains = !a.b.c : *.b.c
7509 .endd
7510 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7511 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7512 list is positive. However, if the setting were
7513 .code
7514 domainlist relay_domains = !a.b.c
7515 .endd
7516 then all domains other than &'a.b.c'& would match because the last item in the
7517 list is negative. In other words, a list that ends with a negative item behaves
7518 as if it had an extra item &`:*`& on the end.
7519
7520 Another way of thinking about positive and negative items in lists is to read
7521 the connector as &"or"& after a positive item and as &"and"& after a negative
7522 item.
7523
7524
7525
7526 .section "File names in lists" "SECTfilnamlis"
7527 .cindex "list" "file name in"
7528 If an item in a domain, host, address, or local part list is an absolute file
7529 name (beginning with a slash character), each line of the file is read and
7530 processed as if it were an independent item in the list, except that further
7531 file names are not allowed,
7532 and no expansion of the data from the file takes place.
7533 Empty lines in the file are ignored, and the file may also contain comment
7534 lines:
7535
7536 .ilist
7537 For domain and host lists, if a # character appears anywhere in a line of the
7538 file, it and all following characters are ignored.
7539 .next
7540 Because local parts may legitimately contain # characters, a comment in an
7541 address list or local part list file is recognized only if # is preceded by
7542 white space or the start of the line. For example:
7543 .code
7544 not#comment@x.y.z   # but this is a comment
7545 .endd
7546 .endlist
7547
7548 Putting a file name in a list has the same effect as inserting each line of the
7549 file as an item in the list (blank lines and comments excepted). However, there
7550 is one important difference: the file is read each time the list is processed,
7551 so if its contents vary over time, Exim's behaviour changes.
7552
7553 If a file name is preceded by an exclamation mark, the sense of any match
7554 within the file is inverted. For example, if
7555 .code
7556 hold_domains = !/etc/nohold-domains
7557 .endd
7558 and the file contains the lines
7559 .code
7560 !a.b.c
7561 *.b.c
7562 .endd
7563 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7564 any domain matching &`*.b.c`& is not.
7565
7566
7567
7568 .section "An lsearch file is not an out-of-line list" "SECID77"
7569 As will be described in the sections that follow, lookups can be used in lists
7570 to provide indexed methods of checking list membership. There has been some
7571 confusion about the way &(lsearch)& lookups work in lists. Because
7572 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7573 sometimes thought that it is allowed to contain wild cards and other kinds of
7574 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7575 always fixed strings, just as for any other single-key lookup type.
7576
7577 If you want to use a file to contain wild-card patterns that form part of a
7578 list, just give the file name on its own, without a search type, as described
7579 in the previous section. You could also use the &(wildlsearch)& or
7580 &(nwildlsearch)&, but there is no advantage in doing this.
7581
7582
7583
7584
7585 .section "Named lists" "SECTnamedlists"
7586 .cindex "named lists"
7587 .cindex "list" "named"
7588 A list of domains, hosts, email addresses, or local parts can be given a name
7589 which is then used to refer to the list elsewhere in the configuration. This is
7590 particularly convenient if the same list is required in several different
7591 places. It also allows lists to be given meaningful names, which can improve
7592 the readability of the configuration. For example, it is conventional to define
7593 a domain list called &'local_domains'& for all the domains that are handled
7594 locally on a host, using a configuration line such as
7595 .code
7596 domainlist local_domains = localhost:my.dom.example
7597 .endd
7598 Named lists are referenced by giving their name preceded by a plus sign, so,
7599 for example, a router that is intended to handle local domains would be
7600 configured with the line
7601 .code
7602 domains = +local_domains
7603 .endd
7604 The first router in a configuration is often one that handles all domains
7605 except the local ones, using a configuration with a negated item like this:
7606 .code
7607 dnslookup:
7608   driver = dnslookup
7609   domains = ! +local_domains
7610   transport = remote_smtp
7611   no_more
7612 .endd
7613 The four kinds of named list are created by configuration lines starting with
7614 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7615 respectively. Then there follows the name that you are defining, followed by an
7616 equals sign and the list itself. For example:
7617 .code
7618 hostlist    relay_hosts = 192.168.23.0/24 : my.friend.example
7619 addresslist bad_senders = cdb;/etc/badsenders
7620 .endd
7621 A named list may refer to other named lists:
7622 .code
7623 domainlist  dom1 = first.example : second.example
7624 domainlist  dom2 = +dom1 : third.example
7625 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7626 .endd
7627 &*Warning*&: If the last item in a referenced list is a negative one, the
7628 effect may not be what you intended, because the negation does not propagate
7629 out to the higher level. For example, consider:
7630 .code
7631 domainlist  dom1 = !a.b
7632 domainlist  dom2 = +dom1 : *.b
7633 .endd
7634 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7635 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7636 means it matches the second list as well. The effect is not the same as
7637 .code
7638 domainlist  dom2 = !a.b : *.b
7639 .endd
7640 where &'x.y'& does not match. It's best to avoid negation altogether in
7641 referenced lists if you can.
7642
7643 Named lists may have a performance advantage. When Exim is routing an
7644 address or checking an incoming message, it caches the result of tests on named
7645 lists. So, if you have a setting such as
7646 .code
7647 domains = +local_domains
7648 .endd
7649 on several of your routers
7650 or in several ACL statements,
7651 the actual test is done only for the first one. However, the caching works only
7652 if there are no expansions within the list itself or any sublists that it
7653 references. In other words, caching happens only for lists that are known to be
7654 the same each time they are referenced.
7655
7656 By default, there may be up to 16 named lists of each type. This limit can be
7657 extended by changing a compile-time variable. The use of domain and host lists
7658 is recommended for concepts such as local domains, relay domains, and relay
7659 hosts. The default configuration is set up like this.
7660
7661
7662
7663 .section "Named lists compared with macros" "SECID78"
7664 .cindex "list" "named compared with macro"
7665 .cindex "macro" "compared with named list"
7666 At first sight, named lists might seem to be no different from macros in the
7667 configuration file. However, macros are just textual substitutions. If you
7668 write
7669 .code
7670 ALIST = host1 : host2
7671 auth_advertise_hosts = !ALIST
7672 .endd
7673 it probably won't do what you want, because that is exactly the same as
7674 .code
7675 auth_advertise_hosts = !host1 : host2
7676 .endd
7677 Notice that the second host name is not negated. However, if you use a host
7678 list, and write
7679 .code
7680 hostlist alist = host1 : host2
7681 auth_advertise_hosts = ! +alist
7682 .endd
7683 the negation applies to the whole list, and so that is equivalent to
7684 .code
7685 auth_advertise_hosts = !host1 : !host2
7686 .endd
7687
7688
7689 .section "Named list caching" "SECID79"
7690 .cindex "list" "caching of named"
7691 .cindex "caching" "named lists"
7692 While processing a message, Exim caches the result of checking a named list if
7693 it is sure that the list is the same each time. In practice, this means that
7694 the cache operates only if the list contains no $ characters, which guarantees
7695 that it will not change when it is expanded. Sometimes, however, you may have
7696 an expanded list that you know will be the same each time within a given
7697 message. For example:
7698 .code
7699 domainlist special_domains = \
7700            ${lookup{$sender_host_address}cdb{/some/file}}
7701 .endd
7702 This provides a list of domains that depends only on the sending host's IP
7703 address. If this domain list is referenced a number of times (for example,
7704 in several ACL lines, or in several routers) the result of the check is not
7705 cached by default, because Exim does not know that it is going to be the
7706 same list each time.
7707
7708 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7709 cache the result anyway. For example:
7710 .code
7711 domainlist_cache special_domains = ${lookup{...
7712 .endd
7713 If you do this, you should be absolutely sure that caching is going to do
7714 the right thing in all cases. When in doubt, leave it out.
7715
7716
7717
7718 .section "Domain lists" "SECTdomainlist"
7719 .cindex "domain list" "patterns for"
7720 .cindex "list" "domain list"
7721 Domain lists contain patterns that are to be matched against a mail domain.
7722 The following types of item may appear in domain lists:
7723
7724 .ilist
7725 .cindex "primary host name"
7726 .cindex "host name" "matched in domain list"
7727 .oindex "&%primary_hostname%&"
7728 .cindex "domain list" "matching primary host name"
7729 .cindex "@ in a domain list"
7730 If a pattern consists of a single @ character, it matches the local host name,
7731 as set by the &%primary_hostname%& option (or defaulted). This makes it
7732 possible to use the same configuration file on several different hosts that
7733 differ only in their names.
7734 .next
7735 .cindex "@[] in a domain list"
7736 .cindex "domain list" "matching local IP interfaces"
7737 .cindex "domain literal"
7738 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7739 in square brackets (as in an email address that contains a domain literal), but
7740 only if that IP address is recognized as local for email routing purposes. The
7741 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7742 control which of a host's several IP addresses are treated as local.
7743 In today's Internet, the use of domain literals is controversial.
7744 .next
7745 .cindex "@mx_any"
7746 .cindex "@mx_primary"
7747 .cindex "@mx_secondary"
7748 .cindex "domain list" "matching MX pointers to local host"
7749 If a pattern consists of the string &`@mx_any`& it matches any domain that
7750 has an MX record pointing to the local host or to any host that is listed in
7751 .oindex "&%hosts_treat_as_local%&"
7752 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7753 are similar, except that the first matches only when a primary MX target is the
7754 local host, and the second only when no primary MX target is the local host,
7755 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7756 preference value &-- there may of course be more than one of them.
7757
7758 The MX lookup that takes place when matching a pattern of this type is
7759 performed with the resolver options for widening names turned off. Thus, for
7760 example, a single-component domain will &'not'& be expanded by adding the
7761 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7762 options of the &(dnslookup)& router for a discussion of domain widening.
7763
7764 Sometimes you may want to ignore certain IP addresses when using one of these
7765 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7766 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7767 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7768 on a router). For example:
7769 .code
7770 domains = @mx_any/ignore=127.0.0.1
7771 .endd
7772 This example matches any domain that has an MX record pointing to one of
7773 the local host's IP addresses other than 127.0.0.1.
7774
7775 The list of IP addresses is in fact processed by the same code that processes
7776 host lists, so it may contain CIDR-coded network specifications and it may also
7777 contain negative items.
7778
7779 Because the list of IP addresses is a sublist within a domain list, you have to
7780 be careful about delimiters if there is more than one address. Like any other
7781 list, the default delimiter can be changed. Thus, you might have:
7782 .code
7783 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7784           an.other.domain : ...
7785 .endd
7786 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7787 involved, it is easiest to change the delimiter for the main list as well:
7788 .code
7789 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7790           an.other.domain ? ...
7791 .endd
7792 .next
7793 .cindex "asterisk" "in domain list"
7794 .cindex "domain list" "asterisk in"
7795 .cindex "domain list" "matching &""ends with""&"
7796 If a pattern starts with an asterisk, the remaining characters of the pattern
7797 are compared with the terminating characters of the domain. The use of &"*"& in
7798 domain lists differs from its use in partial matching lookups. In a domain
7799 list, the character following the asterisk need not be a dot, whereas partial
7800 matching works only in terms of dot-separated components. For example, a domain
7801 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7802 &'cipher.key.ex'&.
7803
7804 .next
7805 .cindex "regular expressions" "in domain list"
7806 .cindex "domain list" "matching regular expression"
7807 If a pattern starts with a circumflex character, it is treated as a regular
7808 expression, and matched against the domain using a regular expression matching
7809 function. The circumflex is treated as part of the regular expression.
7810 Email domains are case-independent, so this regular expression match is by
7811 default case-independent, but you can make it case-dependent by starting it
7812 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7813 are given in chapter &<<CHAPregexp>>&.
7814
7815 &*Warning*&: Because domain lists are expanded before being processed, you
7816 must escape any backslash and dollar characters in the regular expression, or
7817 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7818 it is not to be expanded (unless you really do want to build a regular
7819 expression by expansion, of course).
7820 .next
7821 .cindex "lookup" "in domain list"
7822 .cindex "domain list" "matching by lookup"
7823 If a pattern starts with the name of a single-key lookup type followed by a
7824 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7825 must be a file name in a suitable format for the lookup type. For example, for
7826 &"cdb;"& it must be an absolute path:
7827 .code
7828 domains = cdb;/etc/mail/local_domains.cdb
7829 .endd
7830 The appropriate type of lookup is done on the file using the domain name as the
7831 key. In most cases, the data that is looked up is not used; Exim is interested
7832 only in whether or not the key is present in the file. However, when a lookup
7833 is used for the &%domains%& option on a router
7834 or a &%domains%& condition in an ACL statement, the data is preserved in the
7835 &$domain_data$& variable and can be referred to in other router options or
7836 other statements in the same ACL.
7837
7838 .next
7839 Any of the single-key lookup type names may be preceded by
7840 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7841 .code
7842 domains = partial-dbm;/partial/domains
7843 .endd
7844 This causes partial matching logic to be invoked; a description of how this
7845 works is given in section &<<SECTpartiallookup>>&.
7846
7847 .next
7848 .cindex "asterisk" "in lookup type"
7849 Any of the single-key lookup types may be followed by an asterisk. This causes
7850 a default lookup for a key consisting of a single asterisk to be done if the
7851 original lookup fails. This is not a useful feature when using a domain list to
7852 select particular domains (because any domain would match), but it might have
7853 value if the result of the lookup is being used via the &$domain_data$&
7854 expansion variable.
7855 .next
7856 If the pattern starts with the name of a query-style lookup type followed by a
7857 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7858 pattern must be an appropriate query for the lookup type, as described in
7859 chapter &<<CHAPfdlookup>>&. For example:
7860 .code
7861 hold_domains = mysql;select domain from holdlist \
7862   where domain = '${quote_mysql:$domain}';
7863 .endd
7864 In most cases, the data that is looked up is not used (so for an SQL query, for
7865 example, it doesn't matter what field you select). Exim is interested only in
7866 whether or not the query succeeds. However, when a lookup is used for the
7867 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7868 variable and can be referred to in other options.
7869 .next
7870 .cindex "domain list" "matching literal domain name"
7871 If none of the above cases apply, a caseless textual comparison is made
7872 between the pattern and the domain.
7873 .endlist
7874
7875 Here is an example that uses several different kinds of pattern:
7876 .code
7877 domainlist funny_domains = \
7878   @ : \
7879   lib.unseen.edu : \
7880   *.foundation.fict.example : \
7881   \N^[1-2]\d{3}\.fict\.example$\N : \
7882   partial-dbm;/opt/data/penguin/book : \
7883   nis;domains.byname : \
7884   nisplus;[name=$domain,status=local],domains.org_dir
7885 .endd
7886 There are obvious processing trade-offs among the various matching modes. Using
7887 an asterisk is faster than a regular expression, and listing a few names
7888 explicitly probably is too. The use of a file or database lookup is expensive,
7889 but may be the only option if hundreds of names are required. Because the
7890 patterns are tested in order, it makes sense to put the most commonly matched
7891 patterns earlier.
7892
7893
7894
7895 .section "Host lists" "SECThostlist"
7896 .cindex "host list" "patterns in"
7897 .cindex "list" "host list"
7898 Host lists are used to control what remote hosts are allowed to do. For
7899 example, some hosts may be allowed to use the local host as a relay, and some
7900 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7901 two different ways, by name or by IP address. In a host list, some types of
7902 pattern are matched to a host name, and some are matched to an IP address.
7903 You need to be particularly careful with this when single-key lookups are
7904 involved, to ensure that the right value is being used as the key.
7905
7906
7907 .section "Special host list patterns" "SECID80"
7908 .cindex "empty item in hosts list"
7909 .cindex "host list" "empty string in"
7910 If a host list item is the empty string, it matches only when no remote host is
7911 involved. This is the case when a message is being received from a local
7912 process using SMTP on the standard input, that is, when a TCP/IP connection is
7913 not used.
7914
7915 .cindex "asterisk" "in host list"
7916 The special pattern &"*"& in a host list matches any host or no host. Neither
7917 the IP address nor the name is actually inspected.
7918
7919
7920
7921 .section "Host list patterns that match by IP address" "SECThoslispatip"
7922 .cindex "host list" "matching IP addresses"
7923 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7924 the incoming address actually appears in the IPv6 host as
7925 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7926 list, it is converted into a traditional IPv4 address first. (Not all operating
7927 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7928 concerns.)
7929
7930 The following types of pattern in a host list check the remote host by
7931 inspecting its IP address:
7932
7933 .ilist
7934 If the pattern is a plain domain name (not a regular expression, not starting
7935 with *, not a lookup of any kind), Exim calls the operating system function
7936 to find the associated IP address(es). Exim uses the newer
7937 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
7938 This typically causes a forward DNS lookup of the name. The result is compared
7939 with the IP address of the subject host.
7940
7941 If there is a temporary problem (such as a DNS timeout) with the host name
7942 lookup, a temporary error occurs. For example, if the list is being used in an
7943 ACL condition, the ACL gives a &"defer"& response, usually leading to a
7944 temporary SMTP error code. If no IP address can be found for the host name,
7945 what happens is described in section &<<SECTbehipnot>>& below.
7946
7947 .next
7948 .cindex "@ in a host list"
7949 If the pattern is &"@"&, the primary host name is substituted and used as a
7950 domain name, as just described.
7951
7952 .next
7953 If the pattern is an IP address, it is matched against the IP address of the
7954 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
7955 IPv6 addresses can be given in colon-separated format, but the colons have to
7956 be doubled so as not to be taken as item separators when the default list
7957 separator is used. IPv6 addresses are recognized even when Exim is compiled
7958 without IPv6 support. This means that if they appear in a host list on an
7959 IPv4-only host, Exim will not treat them as host names. They are just addresses
7960 that can never match a client host.
7961
7962 .next
7963 .cindex "@[] in a host list"
7964 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
7965 the local host. For example, if the local host is an IPv4 host with one
7966 interface address 10.45.23.56, these two ACL statements have the same effect:
7967 .code
7968 accept hosts = 127.0.0.1 : 10.45.23.56
7969 accept hosts = @[]
7970 .endd
7971 .next
7972 .cindex "CIDR notation"
7973 If the pattern is an IP address followed by a slash and a mask length (for
7974 example 10.11.42.0/24), it is matched against the IP address of the subject
7975 host under the given mask. This allows, an entire network of hosts to be
7976 included (or excluded) by a single item. The mask uses CIDR notation; it
7977 specifies the number of address bits that must match, starting from the most
7978 significant end of the address.
7979
7980 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
7981 of a range of addresses. It is the number of bits in the network portion of the
7982 address. The above example specifies a 24-bit netmask, so it matches all 256
7983 addresses in the 10.11.42.0 network. An item such as
7984 .code
7985 192.168.23.236/31
7986 .endd
7987 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
7988 32 for an IPv4 address is the same as no mask at all; just a single address
7989 matches.
7990
7991 Here is another example which shows an IPv4 and an IPv6 network:
7992 .code
7993 recipient_unqualified_hosts = 192.168.0.0/16: \
7994                               3ffe::ffff::836f::::/48
7995 .endd
7996 The doubling of list separator characters applies only when these items
7997 appear inline in a host list. It is not required when indirecting via a file.
7998 For example:
7999 .code
8000 recipient_unqualified_hosts = /opt/exim/unqualnets
8001 .endd
8002 could make use of a file containing
8003 .code
8004 172.16.0.0/12
8005 3ffe:ffff:836f::/48
8006 .endd
8007 to have exactly the same effect as the previous example. When listing IPv6
8008 addresses inline, it is usually more convenient to use the facility for
8009 changing separator characters. This list contains the same two networks:
8010 .code
8011 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8012                                  3ffe:ffff:836f::/48
8013 .endd
8014 The separator is changed to semicolon by the leading &"<;"& at the start of the
8015 list.
8016 .endlist
8017
8018
8019
8020 .section "Host list patterns for single-key lookups by host address" &&&
8021          "SECThoslispatsikey"
8022 .cindex "host list" "lookup of IP address"
8023 When a host is to be identified by a single-key lookup of its complete IP
8024 address, the pattern takes this form:
8025 .display
8026 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8027 .endd
8028 For example:
8029 .code
8030 hosts_lookup = net-cdb;/hosts-by-ip.db
8031 .endd
8032 The text form of the IP address of the subject host is used as the lookup key.
8033 IPv6 addresses are converted to an unabbreviated form, using lower case
8034 letters, with dots as separators because colon is the key terminator in
8035 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8036 quoting the keys, but this is a facility that was added later.] The data
8037 returned by the lookup is not used.
8038
8039 .cindex "IP address" "masking"
8040 .cindex "host list" "masked IP address"
8041 Single-key lookups can also be performed using masked IP addresses, using
8042 patterns of this form:
8043 .display
8044 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8045 .endd
8046 For example:
8047 .code
8048 net24-dbm;/networks.db
8049 .endd
8050 The IP address of the subject host is masked using <&'number'&> as the mask
8051 length. A textual string is constructed from the masked value, followed by the
8052 mask, and this is used as the lookup key. For example, if the host's IP address
8053 is 192.168.34.6, the key that is looked up for the above example is
8054 &"192.168.34.0/24"&.
8055
8056 When an IPv6 address is converted to a string, dots are normally used instead
8057 of colons, so that keys in &(lsearch)& files need not contain colons (which
8058 terminate &(lsearch)& keys). This was implemented some time before the ability
8059 to quote keys was made available in &(lsearch)& files. However, the more
8060 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8061 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8062 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8063 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8064 addresses are always used.
8065
8066 Ideally, it would be nice to tidy up this anomalous situation by changing to
8067 colons in all cases, given that quoting is now available for &(lsearch)&.
8068 However, this would be an incompatible change that might break some existing
8069 configurations.
8070
8071 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8072 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8073 the former case the key strings include the mask value, whereas in the latter
8074 case the IP address is used on its own.
8075
8076
8077
8078 .section "Host list patterns that match by host name" "SECThoslispatnam"
8079 .cindex "host" "lookup failures"
8080 .cindex "unknown host name"
8081 .cindex "host list" "matching host name"
8082 There are several types of pattern that require Exim to know the name of the
8083 remote host. These are either wildcard patterns or lookups by name. (If a
8084 complete hostname is given without any wildcarding, it is used to find an IP
8085 address to match against, as described in the section &<<SECThoslispatip>>&
8086 above.)
8087
8088 If the remote host name is not already known when Exim encounters one of these
8089 patterns, it has to be found from the IP address.
8090 Although many sites on the Internet are conscientious about maintaining reverse
8091 DNS data for their hosts, there are also many that do not do this.
8092 Consequently, a name cannot always be found, and this may lead to unwanted
8093 effects. Take care when configuring host lists with wildcarded name patterns.
8094 Consider what will happen if a name cannot be found.
8095
8096 Because of the problems of determining host names from IP addresses, matching
8097 against host names is not as common as matching against IP addresses.
8098
8099 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8100 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8101 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8102 are done can be changed by setting the &%host_lookup_order%& option. For
8103 security, once Exim has found one or more names, it looks up the IP addresses
8104 for these names and compares them with the IP address that it started with.
8105 Only those names whose IP addresses match are accepted. Any other names are
8106 discarded. If no names are left, Exim behaves as if the host name cannot be
8107 found. In the most common case there is only one name and one IP address.
8108
8109 There are some options that control what happens if a host name cannot be
8110 found. These are described in section &<<SECTbehipnot>>& below.
8111
8112 .cindex "host" "alias for"
8113 .cindex "alias for host"
8114 As a result of aliasing, hosts may have more than one name. When processing any
8115 of the following types of pattern, all the host's names are checked:
8116
8117 .ilist
8118 .cindex "asterisk" "in host list"
8119 If a pattern starts with &"*"& the remainder of the item must match the end of
8120 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8121 &'.b.c'&. This special simple form is provided because this is a very common
8122 requirement. Other kinds of wildcarding require the use of a regular
8123 expression.
8124 .next
8125 .cindex "regular expressions" "in host list"
8126 .cindex "host list" "regular expression in"
8127 If the item starts with &"^"& it is taken to be a regular expression which is
8128 matched against the host name. Host names are case-independent, so this regular
8129 expression match is by default case-independent, but you can make it
8130 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8131 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8132 example,
8133 .code
8134 ^(a|b)\.c\.d$
8135 .endd
8136 is a regular expression that matches either of the two hosts &'a.c.d'& or
8137 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8138 that backslash and dollar characters are not misinterpreted as part of the
8139 string expansion. The simplest way to do this is to use &`\N`& to mark that
8140 part of the string as non-expandable. For example:
8141 .code
8142 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8143 .endd
8144 &*Warning*&: If you want to match a complete host name, you must include the
8145 &`$`& terminating metacharacter in the regular expression, as in the above
8146 example. Without it, a match at the start of the host name is all that is
8147 required.
8148 .endlist
8149
8150
8151
8152
8153 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8154 .cindex "host" "lookup failures, permanent"
8155 While processing a host list, Exim may need to look up an IP address from a
8156 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8157 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8158 behaviour when it fails to find the information it is seeking is the same.
8159
8160 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8161 apply to temporary DNS errors, whose handling is described in the next section.
8162
8163 .cindex "&`+include_unknown`&"
8164 .cindex "&`+ignore_unknown`&"
8165 By default, Exim behaves as if the host does not match the list. This may not
8166 always be what you want to happen. To change Exim's behaviour, the special
8167 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8168 top level &-- they are not recognized in an indirected file).
8169
8170 .ilist
8171 If any item that follows &`+include_unknown`& requires information that
8172 cannot found, Exim behaves as if the host does match the list. For example,
8173 .code
8174 host_reject_connection = +include_unknown:*.enemy.ex
8175 .endd
8176 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8177 any hosts whose name it cannot find.
8178
8179 .next
8180 If any item that follows &`+ignore_unknown`& requires information that cannot
8181 be found, Exim ignores that item and proceeds to the rest of the list. For
8182 example:
8183 .code
8184 accept hosts = +ignore_unknown : friend.example : \
8185                192.168.4.5
8186 .endd
8187 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8188 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8189 name can be found for 192.168.4.5, it is rejected.
8190 .endlist
8191
8192 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8193 list. The effect of each one lasts until the next, or until the end of the
8194 list.
8195
8196
8197 .section "Temporary DNS errors when looking up host information" &&&
8198          "SECTtemdnserr"
8199 .cindex "host" "lookup failures, temporary"
8200 .cindex "&`+include_defer`&"
8201 .cindex "&`+ignore_defer`&"
8202 A temporary DNS lookup failure normally causes a defer action (except when
8203 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8204 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8205 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8206 section. These options should be used with care, probably only in non-critical
8207 host lists such as whitelists.
8208
8209
8210
8211 .section "Host list patterns for single-key lookups by host name" &&&
8212          "SECThoslispatnamsk"
8213 .cindex "unknown host name"
8214 .cindex "host list" "matching host name"
8215 If a pattern is of the form
8216 .display
8217 <&'single-key-search-type'&>;<&'search-data'&>
8218 .endd
8219 for example
8220 .code
8221 dbm;/host/accept/list
8222 .endd
8223 a single-key lookup is performed, using the host name as its key. If the
8224 lookup succeeds, the host matches the item. The actual data that is looked up
8225 is not used.
8226
8227 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8228 keys in the file, not IP addresses. If you want to do lookups based on IP
8229 addresses, you must precede the search type with &"net-"& (see section
8230 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8231 two items in the same list, one doing an address lookup and one doing a name
8232 lookup, both using the same file.
8233
8234
8235
8236 .section "Host list patterns for query-style lookups" "SECID81"
8237 If a pattern is of the form
8238 .display
8239 <&'query-style-search-type'&>;<&'query'&>
8240 .endd
8241 the query is obeyed, and if it succeeds, the host matches the item. The actual
8242 data that is looked up is not used. The variables &$sender_host_address$& and
8243 &$sender_host_name$& can be used in the query. For example:
8244 .code
8245 hosts_lookup = pgsql;\
8246   select ip from hostlist where ip='$sender_host_address'
8247 .endd
8248 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8249 can use the &%sg%& expansion item to change this if you need to. If you want to
8250 use masked IP addresses in database queries, you can use the &%mask%& expansion
8251 operator.
8252
8253 If the query contains a reference to &$sender_host_name$&, Exim automatically
8254 looks up the host name if has not already done so. (See section
8255 &<<SECThoslispatnam>>& for comments on finding host names.)
8256
8257 Historical note: prior to release 4.30, Exim would always attempt to find a
8258 host name before running the query, unless the search type was preceded by
8259 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8260 still recognized for query-style lookups, but its presence or absence has no
8261 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8262 See section &<<SECThoslispatsikey>>&.)
8263
8264
8265
8266 .section "Mixing wildcarded host names and addresses in host lists" &&&
8267          "SECTmixwilhos"
8268 .cindex "host list" "mixing names and addresses in"
8269 If you have name lookups or wildcarded host names and IP addresses in the same
8270 host list, you should normally put the IP addresses first. For example, in an
8271 ACL you could have:
8272 .code
8273 accept hosts = 10.9.8.7 : *.friend.example
8274 .endd
8275 The reason for this lies in the left-to-right way that Exim processes lists.
8276 It can test IP addresses without doing any DNS lookups, but when it reaches an
8277 item that requires a host name, it fails if it cannot find a host name to
8278 compare with the pattern. If the above list is given in the opposite order, the
8279 &%accept%& statement fails for a host whose name cannot be found, even if its
8280 IP address is 10.9.8.7.
8281
8282 If you really do want to do the name check first, and still recognize the IP
8283 address, you can rewrite the ACL like this:
8284 .code
8285 accept hosts = *.friend.example
8286 accept hosts = 10.9.8.7
8287 .endd
8288 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8289 &<<CHAPACL>>& for details of ACLs.
8290
8291
8292
8293
8294
8295 .section "Address lists" "SECTaddresslist"
8296 .cindex "list" "address list"
8297 .cindex "address list" "empty item"
8298 .cindex "address list" "patterns"
8299 Address lists contain patterns that are matched against mail addresses. There
8300 is one special case to be considered: the sender address of a bounce message is
8301 always empty. You can test for this by providing an empty item in an address
8302 list. For example, you can set up a router to process bounce messages by
8303 using this option setting:
8304 .code
8305 senders = :
8306 .endd
8307 The presence of the colon creates an empty item. If you do not provide any
8308 data, the list is empty and matches nothing. The empty sender can also be
8309 detected by a regular expression that matches an empty string,
8310 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8311
8312 Non-empty items in an address list can be straightforward email addresses. For
8313 example:
8314 .code
8315 senders = jbc@askone.example : hs@anacreon.example
8316 .endd
8317 A certain amount of wildcarding is permitted. If a pattern contains an @
8318 character, but is not a regular expression and does not begin with a
8319 semicolon-terminated lookup type (described below), the local part of the
8320 subject address is compared with the local part of the pattern, which may start
8321 with an asterisk. If the local parts match, the domain is checked in exactly
8322 the same way as for a pattern in a domain list. For example, the domain can be
8323 wildcarded, refer to a named list, or be a lookup:
8324 .code
8325 deny senders = *@*.spamming.site:\
8326                *@+hostile_domains:\
8327                bozo@partial-lsearch;/list/of/dodgy/sites:\
8328                *@dbm;/bad/domains.db
8329 .endd
8330 .cindex "local part" "starting with !"
8331 .cindex "address list" "local part starting with !"
8332 If a local part that begins with an exclamation mark is required, it has to be
8333 specified using a regular expression, because otherwise the exclamation mark is
8334 treated as a sign of negation, as is standard in lists.
8335
8336 If a non-empty pattern that is not a regular expression or a lookup does not
8337 contain an @ character, it is matched against the domain part of the subject
8338 address. The only two formats that are recognized this way are a literal
8339 domain, or a domain pattern that starts with *. In both these cases, the effect
8340 is the same as if &`*@`& preceded the pattern. For example:
8341 .code
8342 deny senders = enemy.domain : *.enemy.domain
8343 .endd
8344
8345 The following kinds of more complicated address list pattern can match any
8346 address, including the empty address that is characteristic of bounce message
8347 senders:
8348
8349 .ilist
8350 .cindex "regular expressions" "in address list"
8351 .cindex "address list" "regular expression in"
8352 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8353 done against the complete address, with the pattern as the regular expression.
8354 You must take care that backslash and dollar characters are not misinterpreted
8355 as part of the string expansion. The simplest way to do this is to use &`\N`&
8356 to mark that part of the string as non-expandable. For example:
8357 .code
8358 deny senders = \N^.*this.*@example\.com$\N : \
8359                \N^\d{8}.+@spamhaus.example$\N : ...
8360 .endd
8361 The &`\N`& sequences are removed by the expansion, so these items do indeed
8362 start with &"^"& by the time they are being interpreted as address patterns.
8363
8364 .next
8365 .cindex "address list" "lookup for complete address"
8366 Complete addresses can be looked up by using a pattern that starts with a
8367 lookup type terminated by a semicolon, followed by the data for the lookup. For
8368 example:
8369 .code
8370 deny senders = cdb;/etc/blocked.senders : \
8371   mysql;select address from blocked where \
8372   address='${quote_mysql:$sender_address}'
8373 .endd
8374 Both query-style and single-key lookup types can be used. For a single-key
8375 lookup type, Exim uses the complete address as the key. However, empty keys are
8376 not supported for single-key lookups, so a match against the empty address
8377 always fails. This restriction does not apply to query-style lookups.
8378
8379 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8380 cannot be used, and is ignored if specified, with an entry being written to the
8381 panic log.
8382 .cindex "*@ with single-key lookup"
8383 However, you can configure lookup defaults, as described in section
8384 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8385 default. For example, with this lookup:
8386 .code
8387 accept senders = lsearch*@;/some/file
8388 .endd
8389 the file could contains lines like this:
8390 .code
8391 user1@domain1.example
8392 *@domain2.example
8393 .endd
8394 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8395 that are tried is:
8396 .code
8397 nimrod@jaeger.example
8398 *@jaeger.example
8399 *
8400 .endd
8401 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8402 would mean that every address matches, thus rendering the test useless.
8403
8404 &*Warning 2*&: Do not confuse these two kinds of item:
8405 .code
8406 deny recipients = dbm*@;/some/file
8407 deny recipients = *@dbm;/some/file
8408 .endd
8409 The first does a whole address lookup, with defaulting, as just described,
8410 because it starts with a lookup type. The second matches the local part and
8411 domain independently, as described in a bullet point below.
8412 .endlist
8413
8414
8415 The following kinds of address list pattern can match only non-empty addresses.
8416 If the subject address is empty, a match against any of these pattern types
8417 always fails.
8418
8419
8420 .ilist
8421 .cindex "@@ with single-key lookup"
8422 .cindex "address list" "@@ lookup type"
8423 .cindex "address list" "split local part and domain"
8424 If a pattern starts with &"@@"& followed by a single-key lookup item
8425 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8426 split into a local part and a domain. The domain is looked up in the file. If
8427 it is not found, there is no match. If it is found, the data that is looked up
8428 from the file is treated as a colon-separated list of local part patterns, each
8429 of which is matched against the subject local part in turn.
8430
8431 .cindex "asterisk" "in address list"
8432 The lookup may be a partial one, and/or one involving a search for a default
8433 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8434 patterns that are looked up can be regular expressions or begin with &"*"&, or
8435 even be further lookups. They may also be independently negated. For example,
8436 with
8437 .code
8438 deny senders = @@dbm;/etc/reject-by-domain
8439 .endd
8440 the data from which the DBM file is built could contain lines like
8441 .code
8442 baddomain.com:  !postmaster : *
8443 .endd
8444 to reject all senders except &%postmaster%& from that domain.
8445
8446 .cindex "local part" "starting with !"
8447 If a local part that actually begins with an exclamation mark is required, it
8448 has to be specified using a regular expression. In &(lsearch)& files, an entry
8449 may be split over several lines by indenting the second and subsequent lines,
8450 but the separating colon must still be included at line breaks. White space
8451 surrounding the colons is ignored. For example:
8452 .code
8453 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8454 spammer3 : spammer4
8455 .endd
8456 As in all colon-separated lists in Exim, a colon can be included in an item by
8457 doubling.
8458
8459 If the last item in the list starts with a right angle-bracket, the remainder
8460 of the item is taken as a new key to look up in order to obtain a continuation
8461 list of local parts. The new key can be any sequence of characters. Thus one
8462 might have entries like
8463 .code
8464 aol.com: spammer1 : spammer 2 : >*
8465 xyz.com: spammer3 : >*
8466 *:       ^\d{8}$
8467 .endd
8468 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8469 local parts for all domains, in addition to the specific local parts listed for
8470 each domain. Of course, using this feature costs another lookup each time a
8471 chain is followed, but the effort needed to maintain the data is reduced.
8472
8473 .cindex "loop" "in lookups"
8474 It is possible to construct loops using this facility, and in order to catch
8475 them, the chains may be no more than fifty items long.
8476
8477 .next
8478 The @@<&'lookup'&> style of item can also be used with a query-style
8479 lookup, but in this case, the chaining facility is not available. The lookup
8480 can only return a single list of local parts.
8481 .endlist
8482
8483 &*Warning*&: There is an important difference between the address list items
8484 in these two examples:
8485 .code
8486 senders = +my_list
8487 senders = *@+my_list
8488 .endd
8489 In the first one, &`my_list`& is a named address list, whereas in the second
8490 example it is a named domain list.
8491
8492
8493
8494
8495 .section "Case of letters in address lists" "SECTcasletadd"
8496 .cindex "case of local parts"
8497 .cindex "address list" "case forcing"
8498 .cindex "case forcing in address lists"
8499 Domains in email addresses are always handled caselessly, but for local parts
8500 case may be significant on some systems (see &%caseful_local_part%& for how
8501 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8502 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8503 blocking lists should be done in a case-independent manner. Since most address
8504 lists in Exim are used for this kind of control, Exim attempts to do this by
8505 default.
8506
8507 The domain portion of an address is always lowercased before matching it to an
8508 address list. The local part is lowercased by default, and any string
8509 comparisons that take place are done caselessly. This means that the data in
8510 the address list itself, in files included as plain file names, and in any file
8511 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8512 keys in files that are looked up by a search type other than &(lsearch)& (which
8513 works caselessly) must be in lower case, because these lookups are not
8514 case-independent.
8515
8516 .cindex "&`+caseful`&"
8517 To allow for the possibility of caseful address list matching, if an item in
8518 an address list is the string &"+caseful"&, the original case of the local
8519 part is restored for any comparisons that follow, and string comparisons are no
8520 longer case-independent. This does not affect the domain, which remains in
8521 lower case. However, although independent matches on the domain alone are still
8522 performed caselessly, regular expressions that match against an entire address
8523 become case-sensitive after &"+caseful"& has been seen.
8524
8525
8526
8527 .section "Local part lists" "SECTlocparlis"
8528 .cindex "list" "local part list"
8529 .cindex "local part" "list"
8530 Case-sensitivity in local part lists is handled in the same way as for address
8531 lists, as just described. The &"+caseful"& item can be used if required. In a
8532 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8533 set false, the subject is lowercased and the matching is initially
8534 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8535 matching in the local part list, but not elsewhere in the router. If
8536 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8537 option is case-sensitive from the start.
8538
8539 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8540 comments are handled in the same way as address lists &-- they are recognized
8541 only if the # is preceded by white space or the start of the line.
8542 Otherwise, local part lists are matched in the same way as domain lists, except
8543 that the special items that refer to the local host (&`@`&, &`@[]`&,
8544 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8545 Refer to section &<<SECTdomainlist>>& for details of the other available item
8546 types.
8547 .ecindex IIDdohoadli
8548
8549
8550
8551
8552 . ////////////////////////////////////////////////////////////////////////////
8553 . ////////////////////////////////////////////////////////////////////////////
8554
8555 .chapter "String expansions" "CHAPexpand"
8556 .scindex IIDstrexp "expansion" "of strings"
8557 Many strings in Exim's run time configuration are expanded before use. Some of
8558 them are expanded every time they are used; others are expanded only once.
8559
8560 When a string is being expanded it is copied verbatim from left to right except
8561 when a dollar or backslash character is encountered. A dollar specifies the
8562 start of a portion of the string that is interpreted and replaced as described
8563 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8564 escape character, as described in the following section.
8565
8566 Whether a string is expanded depends upon the context.  Usually this is solely
8567 dependent upon the option for which a value is sought; in this documentation,
8568 options for which string expansion is performed are marked with &dagger; after
8569 the data type.  ACL rules always expand strings.  A couple of expansion
8570 conditions do not expand some of the brace-delimited branches, for security
8571 reasons.
8572
8573
8574
8575 .section "Literal text in expanded strings" "SECTlittext"
8576 .cindex "expansion" "including literal text"
8577 An uninterpreted dollar can be included in an expanded string by putting a
8578 backslash in front of it. A backslash can be used to prevent any special
8579 character being treated specially in an expansion, including backslash itself.
8580 If the string appears in quotes in the configuration file, two backslashes are
8581 required because the quotes themselves cause interpretation of backslashes when
8582 the string is read in (see section &<<SECTstrings>>&).
8583
8584 .cindex "expansion" "non-expandable substrings"
8585 A portion of the string can specified as non-expandable by placing it between
8586 two occurrences of &`\N`&. This is particularly useful for protecting regular
8587 expressions, which often contain backslashes and dollar signs. For example:
8588 .code
8589 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8590 .endd
8591 On encountering the first &`\N`&, the expander copies subsequent characters
8592 without interpretation until it reaches the next &`\N`& or the end of the
8593 string.
8594
8595
8596
8597 .section "Character escape sequences in expanded strings" "SECID82"
8598 .cindex "expansion" "escape sequences"
8599 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8600 expanded string is recognized as an escape sequence for the character newline,
8601 carriage return, or tab, respectively. A backslash followed by up to three
8602 octal digits is recognized as an octal encoding for a single character, and a
8603 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8604 encoding.
8605
8606 These escape sequences are also recognized in quoted strings when they are read
8607 in. Their interpretation in expansions as well is useful for unquoted strings,
8608 and for other cases such as looked-up strings that are then expanded.
8609
8610
8611 .section "Testing string expansions" "SECID83"
8612 .cindex "expansion" "testing"
8613 .cindex "testing" "string expansion"
8614 .oindex "&%-be%&"
8615 Many expansions can be tested by calling Exim with the &%-be%& option. This
8616 takes the command arguments, or lines from the standard input if there are no
8617 arguments, runs them through the string expansion code, and writes the results
8618 to the standard output. Variables based on configuration values are set up, but
8619 since no message is being processed, variables such as &$local_part$& have no
8620 value. Nevertheless the &%-be%& option can be useful for checking out file and
8621 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8622 and &%nhash%&.
8623
8624 Exim gives up its root privilege when it is called with the &%-be%& option, and
8625 instead runs under the uid and gid it was called with, to prevent users from
8626 using &%-be%& for reading files to which they do not have access.
8627
8628 .oindex "&%-bem%&"
8629 If you want to test expansions that include variables whose values are taken
8630 from a message, there are two other options that can be used. The &%-bem%&
8631 option is like &%-be%& except that it is followed by a file name. The file is
8632 read as a message before doing the test expansions. For example:
8633 .code
8634 exim -bem /tmp/test.message '$h_subject:'
8635 .endd
8636 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8637 Exim message identifier. For example:
8638 .code
8639 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8640 .endd
8641 This loads the message from Exim's spool before doing the test expansions, and
8642 is therefore restricted to admin users.
8643
8644
8645 .section "Forced expansion failure" "SECTforexpfai"
8646 .cindex "expansion" "forced failure"
8647 A number of expansions that are described in the following section have
8648 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8649 (which are sometimes called &"curly brackets"&). Which of the two strings is
8650 used depends on some condition that is evaluated as part of the expansion. If,
8651 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8652 the entire string expansion fails in a way that can be detected by the code
8653 that requested the expansion. This is called &"forced expansion failure"&, and
8654 its consequences depend on the circumstances. In some cases it is no different
8655 from any other expansion failure, but in others a different action may be
8656 taken. Such variations are mentioned in the documentation of the option that is
8657 being expanded.
8658
8659
8660
8661
8662 .section "Expansion items" "SECTexpansionitems"
8663 The following items are recognized in expanded strings. White space may be used
8664 between sub-items that are keywords or substrings enclosed in braces inside an
8665 outer set of braces, to improve readability. &*Warning*&: Within braces,
8666 white space is significant.
8667
8668 .vlist
8669 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8670 .cindex "expansion" "variables"
8671 Substitute the contents of the named variable, for example:
8672 .code
8673 $local_part
8674 ${domain}
8675 .endd
8676 The second form can be used to separate the name from subsequent alphanumeric
8677 characters. This form (using braces) is available only for variables; it does
8678 &'not'& apply to message headers. The names of the variables are given in
8679 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8680 given, the expansion fails.
8681
8682 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8683 .cindex "expansion" "operators"
8684 The string is first itself expanded, and then the operation specified by
8685 <&'op'&> is applied to it. For example:
8686 .code
8687 ${lc:$local_part}
8688 .endd
8689 The string starts with the first character after the colon, which may be
8690 leading white space. A list of operators is given in section &<<SECTexpop>>&
8691 below. The operator notation is used for simple expansion items that have just
8692 one argument, because it reduces the number of braces and therefore makes the
8693 string easier to understand.
8694
8695 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8696 This item inserts &"basic"& header lines. It is described with the &%header%&
8697 expansion item below.
8698
8699 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8700        {*&<&'arg'&>&*}...}*&"
8701 .cindex &%dlfunc%&
8702 This expansion dynamically loads and then calls a locally-written C function.
8703 This functionality is available only if Exim is compiled with
8704 .code
8705 EXPAND_DLFUNC=yes
8706 .endd
8707 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8708 object so that it doesn't reload the same object file in the same Exim process
8709 (but of course Exim does start new processes frequently).
8710
8711 There may be from zero to eight arguments to the function. When compiling
8712 a local function that is to be called in this way, &_local_scan.h_& should be
8713 included. The Exim variables and functions that are defined by that API
8714 are also available for dynamically loaded functions. The function itself
8715 must have the following type:
8716 .code
8717 int dlfunction(uschar **yield, int argc, uschar *argv[])
8718 .endd
8719 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8720 function should return one of the following values:
8721
8722 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8723 into the expanded string that is being built.
8724
8725 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8726 from &'yield'&, if it is set.
8727
8728 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8729 taken from &'yield'& if it is set.
8730
8731 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8732
8733 When compiling a function that is to be used in this way with gcc,
8734 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8735 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8736
8737 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8738        {*&<&'string3'&>&*}}*&"
8739 .cindex "expansion" "extracting substrings by key"
8740 .cindex "&%extract%&" "substrings by key"
8741 The key and <&'string1'&> are first expanded separately. Leading and trailing
8742 white space is removed from the key (but not from any of the strings). The key
8743 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8744 form:
8745 .display
8746 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8747 .endd
8748 .vindex "&$value$&"
8749 where the equals signs and spaces (but not both) are optional. If any of the
8750 values contain white space, they must be enclosed in double quotes, and any
8751 values that are enclosed in double quotes are subject to escape processing as
8752 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8753 for the value that corresponds to the key. The search is case-insensitive. If
8754 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8755 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8756 variable &$value$& contains the value that has been extracted. Afterwards, it
8757 is restored to any previous value it might have had.
8758
8759 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8760 key is not found. If {<&'string2'&>} is also omitted, the value that was
8761 extracted is used. Thus, for example, these two expansions are identical, and
8762 yield &"2001"&:
8763 .code
8764 ${extract{gid}{uid=1984 gid=2001}}
8765 ${extract{gid}{uid=1984 gid=2001}{$value}}
8766 .endd
8767 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8768 appear, for example:
8769 .code
8770 ${extract{Z}{A=... B=...}{$value} fail }
8771 .endd
8772 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8773 {<&'string2'&>} must be present for &"fail"& to be recognized.
8774
8775
8776 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8777         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8778 .cindex "expansion" "extracting substrings by number"
8779 .cindex "&%extract%&" "substrings by number"
8780 The <&'number'&> argument must consist entirely of decimal digits,
8781 apart from leading and trailing white space, which is ignored.
8782 This is what distinguishes this form of &%extract%& from the previous kind. It
8783 behaves in the same way, except that, instead of extracting a named field, it
8784 extracts from <&'string1'&> the field whose number is given as the first
8785 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8786 <&'string3'&> as before.
8787
8788 The fields in the string are separated by any one of the characters in the
8789 separator string. These may include space or tab characters.
8790 The first field is numbered one. If the number is negative, the fields are
8791 counted from the end of the string, with the rightmost one numbered -1. If the
8792 number given is zero, the entire string is returned. If the modulus of the
8793 number is greater than the number of fields in the string, the result is the
8794 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8795 provided. For example:
8796 .code
8797 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8798 .endd
8799 yields &"42"&, and
8800 .code
8801 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8802 .endd
8803 yields &"99"&. Two successive separators mean that the field between them is
8804 empty (for example, the fifth field above).
8805
8806
8807 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8808 .cindex "list" "selecting by condition"
8809 .cindex "expansion" "selecting from list by condition"
8810 .vindex "&$item$&"
8811 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8812 default, but the separator can be changed in the usual way. For each item
8813 in this list, its value is place in &$item$&, and then the condition is
8814 evaluated. If the condition is true, &$item$& is added to the output as an
8815 item in a new list; if the condition is false, the item is discarded. The
8816 separator used for the output list is the same as the one used for the
8817 input, but a separator setting is not included in the output. For example:
8818 .code
8819 ${filter{a:b:c}{!eq{$item}{b}}
8820 .endd
8821 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8822 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8823
8824
8825 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8826 .cindex "hash function" "textual"
8827 .cindex "expansion" "textual hash"
8828 This is a textual hashing function, and was the first to be implemented in
8829 early versions of Exim. In current releases, there are other hashing functions
8830 (numeric, MD5, and SHA-1), which are described below.
8831
8832 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8833 <&'n'&>. If you are using fixed values for these numbers, that is, if
8834 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8835 use the simpler operator notation that avoids some of the braces:
8836 .code
8837 ${hash_<n>_<m>:<string>}
8838 .endd
8839 The second number is optional (in both notations). If <&'n'&> is greater than
8840 or equal to the length of the string, the expansion item returns the string.
8841 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8842 function to the string. The new string consists of characters taken from the
8843 first <&'m'&> characters of the string
8844 .code
8845 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8846 .endd
8847 If <&'m'&> is not present the value 26 is used, so that only lower case
8848 letters appear. For example:
8849 .display
8850 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8851 &`$hash{5}{monty}}           `&   yields  &`monty`&
8852 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8853 .endd
8854
8855 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8856         &*$h_*&<&'header&~name'&>&*:*&" &&&
8857        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8858         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8859        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8860         &*$rh_*&<&'header&~name'&>&*:*&"
8861 .cindex "expansion" "header insertion"
8862 .vindex "&$header_$&"
8863 .vindex "&$bheader_$&"
8864 .vindex "&$rheader_$&"
8865 .cindex "header lines" "in expansion strings"
8866 .cindex "header lines" "character sets"
8867 .cindex "header lines" "decoding"
8868 Substitute the contents of the named message header line, for example
8869 .code
8870 $header_reply-to:
8871 .endd
8872 The newline that terminates a header line is not included in the expansion, but
8873 internal newlines (caused by splitting the header line over several physical
8874 lines) may be present.
8875
8876 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8877 the data in the header line is interpreted.
8878
8879 .ilist
8880 .cindex "white space" "in header lines"
8881 &%rheader%& gives the original &"raw"& content of the header line, with no
8882 processing at all, and without the removal of leading and trailing white space.
8883
8884 .next
8885 .cindex "base64 encoding" "in header lines"
8886 &%bheader%& removes leading and trailing white space, and then decodes base64
8887 or quoted-printable MIME &"words"& within the header text, but does no
8888 character set translation. If decoding of what looks superficially like a MIME
8889 &"word"& fails, the raw string is returned. If decoding
8890 .cindex "binary zero" "in header line"
8891 produces a binary zero character, it is replaced by a question mark &-- this is
8892 what Exim does for binary zeros that are actually received in header lines.
8893
8894 .next
8895 &%header%& tries to translate the string as decoded by &%bheader%& to a
8896 standard character set. This is an attempt to produce the same string as would
8897 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8898 returned. Translation is attempted only on operating systems that support the
8899 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8900 a system Makefile or in &_Local/Makefile_&.
8901 .endlist ilist
8902
8903 In a filter file, the target character set for &%header%& can be specified by a
8904 command of the following form:
8905 .code
8906 headers charset "UTF-8"
8907 .endd
8908 This command affects all references to &$h_$& (or &$header_$&) expansions in
8909 subsequently obeyed filter commands. In the absence of this command, the target
8910 character set in a filter is taken from the setting of the &%headers_charset%&
8911 option in the runtime configuration. The value of this option defaults to the
8912 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8913 ISO-8859-1.
8914
8915 Header names follow the syntax of RFC 2822, which states that they may contain
8916 any printing characters except space and colon. Consequently, curly brackets
8917 &'do not'& terminate header names, and should not be used to enclose them as
8918 if they were variables. Attempting to do so causes a syntax error.
8919
8920 Only header lines that are common to all copies of a message are visible to
8921 this mechanism. These are the original header lines that are received with the
8922 message, and any that are added by an ACL statement or by a system
8923 filter. Header lines that are added to a particular copy of a message by a
8924 router or transport are not accessible.
8925
8926 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
8927 before the DATA ACL, because the header structure is not set up until the
8928 message is received. Header lines that are added in a RCPT ACL (for example)
8929 are saved until the message's incoming header lines are available, at which
8930 point they are added. When a DATA ACL is running, however, header lines added
8931 by earlier ACLs are visible.
8932
8933 Upper case and lower case letters are synonymous in header names. If the
8934 following character is white space, the terminating colon may be omitted, but
8935 this is not recommended, because you may then forget it when it is needed. When
8936 white space terminates the header name, it is included in the expanded string.
8937 If the message does not contain the given header, the expansion item is
8938 replaced by an empty string. (See the &%def%& condition in section
8939 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
8940
8941 If there is more than one header with the same name, they are all concatenated
8942 to form the substitution string, up to a maximum length of 64K. Unless
8943 &%rheader%& is being used, leading and trailing white space is removed from
8944 each header before concatenation, and a completely empty header is ignored. A
8945 newline character is then inserted between non-empty headers, but there is no
8946 newline at the very end. For the &%header%& and &%bheader%& expansion, for
8947 those headers that contain lists of addresses, a comma is also inserted at the
8948 junctions between headers. This does not happen for the &%rheader%& expansion.
8949
8950
8951 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
8952 .cindex "expansion" "hmac hashing"
8953 .cindex &%hmac%&
8954 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
8955 shared secret and some text into a message authentication code, as specified in
8956 RFC 2104. This differs from &`${md5:secret_text...}`& or
8957 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
8958 cryptographic hash, allowing for authentication that is not possible with MD5
8959 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
8960 present. For example:
8961 .code
8962 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
8963 .endd
8964 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
8965 produces:
8966 .code
8967 dd97e3ba5d1a61b5006108f8c8252953
8968 .endd
8969 As an example of how this might be used, you might put in the main part of
8970 an Exim configuration:
8971 .code
8972 SPAMSCAN_SECRET=cohgheeLei2thahw
8973 .endd
8974 In a router or a transport you could then have:
8975 .code
8976 headers_add = \
8977   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
8978   ${hmac{md5}{SPAMSCAN_SECRET}\
8979   {${primary_hostname},${message_exim_id},$h_message-id:}}
8980 .endd
8981 Then given a message, you can check where it was scanned by looking at the
8982 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
8983 this header line is authentic by recomputing the authentication code from the
8984 host name, message ID and the &'Message-id:'& header line. This can be done
8985 using Exim's &%-be%& option, or by other means, for example by using the
8986 &'hmac_md5_hex()'& function in Perl.
8987
8988
8989 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8990 .cindex "expansion" "conditional"
8991 .cindex "&%if%&, expansion item"
8992 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
8993 item; otherwise <&'string2'&> is used. The available conditions are described
8994 in section &<<SECTexpcond>>& below. For example:
8995 .code
8996 ${if eq {$local_part}{postmaster} {yes}{no} }
8997 .endd
8998 The second string need not be present; if it is not and the condition is not
8999 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9000 be present instead of the second string (without any curly brackets). In this
9001 case, the expansion is forced to fail if the condition is not true (see section
9002 &<<SECTforexpfai>>&).
9003
9004 If both strings are omitted, the result is the string &`true`& if the condition
9005 is true, and the empty string if the condition is false. This makes it less
9006 cumbersome to write custom ACL and router conditions. For example, instead of
9007 .code
9008 condition = ${if >{$acl_m4}{3}{true}{false}}
9009 .endd
9010 you can use
9011 .code
9012 condition = ${if >{$acl_m4}{3}}
9013 .endd
9014
9015 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9016 .cindex "expansion" "string truncation"
9017 .cindex "&%length%& expansion item"
9018 The &%length%& item is used to extract the initial portion of a string. Both
9019 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9020 you are using a fixed value for the number, that is, if <&'string1'&> does not
9021 change when expanded, you can use the simpler operator notation that avoids
9022 some of the braces:
9023 .code
9024 ${length_<n>:<string>}
9025 .endd
9026 The result of this item is either the first <&'n'&> characters or the whole
9027 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9028 &%strlen%&, which gives the length of a string.
9029
9030
9031 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9032         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9033 This is the first of one of two different types of lookup item, which are both
9034 described in the next item.
9035
9036 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9037         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9038 .cindex "expansion" "lookup in"
9039 .cindex "file" "lookups"
9040 .cindex "lookup" "in expanded string"
9041 The two forms of lookup item specify data lookups in files and databases, as
9042 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9043 lookups, and the second is used for query-style lookups. The <&'key'&>,
9044 <&'file'&>, and <&'query'&> strings are expanded before use.
9045
9046 If there is any white space in a lookup item which is part of a filter command,
9047 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9048 other place where white space is significant, the lookup item must be enclosed
9049 in double quotes. The use of data lookups in users' filter files may be locked
9050 out by the system administrator.
9051
9052 .vindex "&$value$&"
9053 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9054 During its expansion, the variable &$value$& contains the data returned by the
9055 lookup. Afterwards it reverts to the value it had previously (at the outer
9056 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9057 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9058 string on failure. If <&'string2'&> is provided, it can itself be a nested
9059 lookup, thus providing a mechanism for looking up a default value when the
9060 original lookup fails.
9061
9062 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9063 data for the outer lookup while the parameters of the second lookup are
9064 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9065 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9066 appear, and in this case, if the lookup fails, the entire expansion is forced
9067 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9068 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9069 successful lookup, and nothing in the case of failure.
9070
9071 For single-key lookups, the string &"partial"& is permitted to precede the
9072 search type in order to do partial matching, and * or *@ may follow a search
9073 type to request default lookups if the key does not match (see sections
9074 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9075
9076 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9077 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9078 and non-wild parts of the key during the expansion of the replacement text.
9079 They return to their previous values at the end of the lookup item.
9080
9081 This example looks up the postmaster alias in the conventional alias file:
9082 .code
9083 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9084 .endd
9085 This example uses NIS+ to look up the full name of the user corresponding to
9086 the local part of an address, forcing the expansion to fail if it is not found:
9087 .code
9088 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9089   {$value}fail}
9090 .endd
9091
9092
9093 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9094 .cindex "expansion" "list creation"
9095 .vindex "&$item$&"
9096 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9097 default, but the separator can be changed in the usual way. For each item
9098 in this list, its value is place in &$item$&, and then <&'string2'&> is
9099 expanded and added to the output as an item in a new list. The separator used
9100 for the output list is the same as the one used for the input, but a separator
9101 setting is not included in the output. For example:
9102 .code
9103 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9104 .endd
9105 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9106 value of &$item$& is restored to what it was before. See also the &*filter*&
9107 and &*reduce*& expansion items.
9108
9109 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9110 .cindex "expansion" "numeric hash"
9111 .cindex "hash function" "numeric"
9112 The three strings are expanded; the first two must yield numbers. Call them
9113 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9114 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9115 can use the simpler operator notation that avoids some of the braces:
9116 .code
9117 ${nhash_<n>_<m>:<string>}
9118 .endd
9119 The second number is optional (in both notations). If there is only one number,
9120 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9121 processed by a div/mod hash function that returns two numbers, separated by a
9122 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9123 example,
9124 .code
9125 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9126 .endd
9127 returns the string &"6/33"&.
9128
9129
9130
9131 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9132 .cindex "Perl" "use in expanded string"
9133 .cindex "expansion" "calling Perl from"
9134 This item is available only if Exim has been built to include an embedded Perl
9135 interpreter. The subroutine name and the arguments are first separately
9136 expanded, and then the Perl subroutine is called with those arguments. No
9137 additional arguments need be given; the maximum number permitted, including the
9138 name of the subroutine, is nine.
9139
9140 The return value of the subroutine is inserted into the expanded string, unless
9141 the return value is &%undef%&. In that case, the expansion fails in the same
9142 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9143 Whatever you return is evaluated in a scalar context. For example, if you
9144 return the name of a Perl vector, the return value is the size of the vector,
9145 not its contents.
9146
9147 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9148 with the error message that was passed to &%die%&. More details of the embedded
9149 Perl facility are given in chapter &<<CHAPperl>>&.
9150
9151 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9152 out the use of this expansion item in filter files.
9153
9154
9155 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9156 .cindex "&%prvs%& expansion item"
9157 The first argument is a complete email address and the second is secret
9158 keystring. The third argument, specifying a key number, is optional. If absent,
9159 it defaults to 0. The result of the expansion is a prvs-signed email address,
9160 to be typically used with the &%return_path%& option on an &(smtp)& transport
9161 as part of a bounce address tag validation (BATV) scheme. For more discussion
9162 and an example, see section &<<SECTverifyPRVS>>&.
9163
9164 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9165         {*&<&'string'&>&*}}*&"
9166 .cindex "&%prvscheck%& expansion item"
9167 This expansion item is the complement of the &%prvs%& item. It is used for
9168 checking prvs-signed addresses. If the expansion of the first argument does not
9169 yield a syntactically valid prvs-signed address, the whole item expands to the
9170 empty string. When the first argument does expand to a syntactically valid
9171 prvs-signed address, the second argument is expanded, with the prvs-decoded
9172 version of the address and the key number extracted from the address in the
9173 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9174
9175 These two variables can be used in the expansion of the second argument to
9176 retrieve the secret. The validity of the prvs-signed address is then checked
9177 against the secret. The result is stored in the variable &$prvscheck_result$&,
9178 which is empty for failure or &"1"& for success.
9179
9180 The third argument is optional; if it is missing, it defaults to an empty
9181 string. This argument is now expanded. If the result is an empty string, the
9182 result of the expansion is the decoded version of the address. This is the case
9183 whether or not the signature was valid. Otherwise, the result of the expansion
9184 is the expansion of the third argument.
9185
9186 All three variables can be used in the expansion of the third argument.
9187 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9188 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9189
9190 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9191 .cindex "expansion" "inserting an entire file"
9192 .cindex "file" "inserting into expansion"
9193 .cindex "&%readfile%& expansion item"
9194 The file name and end-of-line string are first expanded separately. The file is
9195 then read, and its contents replace the entire item. All newline characters in
9196 the file are replaced by the end-of-line string if it is present. Otherwise,
9197 newlines are left in the string.
9198 String expansion is not applied to the contents of the file. If you want this,
9199 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9200 the string expansion fails.
9201
9202 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9203 locks out the use of this expansion item in filter files.
9204
9205
9206
9207 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9208         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9209 .cindex "expansion" "inserting from a socket"
9210 .cindex "socket, use of in expansion"
9211 .cindex "&%readsocket%& expansion item"
9212 This item inserts data from a Unix domain or Internet socket into the expanded
9213 string. The minimal way of using it uses just two arguments, as in these
9214 examples:
9215 .code
9216 ${readsocket{/socket/name}{request string}}
9217 ${readsocket{inet:some.host:1234}{request string}}
9218 .endd
9219 For a Unix domain socket, the first substring must be the path to the socket.
9220 For an Internet socket, the first substring must contain &`inet:`& followed by
9221 a host name or IP address, followed by a colon and a port, which can be a
9222 number or the name of a TCP port in &_/etc/services_&. An IP address may
9223 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9224 example:
9225 .code
9226 ${readsocket{inet:[::1]:1234}{request string}}
9227 .endd
9228 Only a single host name may be given, but if looking it up yields more than
9229 one IP address, they are each tried in turn until a connection is made. For
9230 both kinds of socket, Exim makes a connection, writes the request string
9231 (unless it is an empty string) and reads from the socket until an end-of-file
9232 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9233 extend what can be done. Firstly, you can vary the timeout. For example:
9234 .code
9235 ${readsocket{/socket/name}{request string}{3s}}
9236 .endd
9237 A fourth argument allows you to change any newlines that are in the data
9238 that is read, in the same way as for &%readfile%& (see above). This example
9239 turns them into spaces:
9240 .code
9241 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9242 .endd
9243 As with all expansions, the substrings are expanded before the processing
9244 happens. Errors in these sub-expansions cause the expansion to fail. In
9245 addition, the following errors can occur:
9246
9247 .ilist
9248 Failure to create a socket file descriptor;
9249 .next
9250 Failure to connect the socket;
9251 .next
9252 Failure to write the request string;
9253 .next
9254 Timeout on reading from the socket.
9255 .endlist
9256
9257 By default, any of these errors causes the expansion to fail. However, if
9258 you supply a fifth substring, it is expanded and used when any of the above
9259 errors occurs. For example:
9260 .code
9261 ${readsocket{/socket/name}{request string}{3s}{\n}\
9262   {socket failure}}
9263 .endd
9264 You can test for the existence of a Unix domain socket by wrapping this
9265 expansion in &`${if exists`&, but there is a race condition between that test
9266 and the actual opening of the socket, so it is safer to use the fifth argument
9267 if you want to be absolutely sure of avoiding an expansion error for a
9268 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9269
9270 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9271 locks out the use of this expansion item in filter files.
9272
9273
9274 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9275 .cindex "expansion" "reducing a list to a scalar"
9276 .cindex "list" "reducing to a scalar"
9277 .vindex "&$value$&"
9278 .vindex "&$item$&"
9279 This operation reduces a list to a single, scalar string. After expansion,
9280 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9281 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9282 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9283 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9284 them. The result of that expansion is assigned to &$value$& before the next
9285 iteration. When the end of the list is reached, the final value of &$value$& is
9286 added to the expansion output. The &*reduce*& expansion item can be used in a
9287 number of ways. For example, to add up a list of numbers:
9288 .code
9289 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9290 .endd
9291 The result of that expansion would be &`6`&. The maximum of a list of numbers
9292 can be found:
9293 .code
9294 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9295 .endd
9296 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9297 restored to what they were before. See also the &*filter*& and &*map*&
9298 expansion items.
9299
9300 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9301 This item inserts &"raw"& header lines. It is described with the &%header%&
9302 expansion item above.
9303
9304 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9305         {*&<&'string2'&>&*}}*&"
9306 .cindex "expansion" "running a command"
9307 .cindex "&%run%& expansion item"
9308 The command and its arguments are first expanded separately, and then the
9309 command is run in a separate process, but under the same uid and gid. As in
9310 other command executions from Exim, a shell is not used by default. If you want
9311 a shell, you must explicitly code it.
9312
9313 The standard input for the command exists, but is empty. The standard output
9314 and standard error are set to the same file descriptor.
9315 .cindex "return code" "from &%run%& expansion"
9316 .vindex "&$value$&"
9317 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9318 and replaces the entire item; during this expansion, the standard output/error
9319 from the command is in the variable &$value$&. If the command fails,
9320 <&'string2'&>, if present, is expanded and used. Once again, during the
9321 expansion, the standard output/error from the command is in the variable
9322 &$value$&.
9323
9324 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9325 can be the word &"fail"& (not in braces) to force expansion failure if the
9326 command does not succeed. If both strings are omitted, the result is contents
9327 of the standard output/error on success, and nothing on failure.
9328
9329 .vindex "&$runrc$&"
9330 The return code from the command is put in the variable &$runrc$&, and this
9331 remains set afterwards, so in a filter file you can do things like this:
9332 .code
9333 if "${run{x y z}{}}$runrc" is 1 then ...
9334   elif $runrc is 2 then ...
9335   ...
9336 endif
9337 .endd
9338 If execution of the command fails (for example, the command does not exist),
9339 the return code is 127 &-- the same code that shells use for non-existent
9340 commands.
9341
9342 &*Warning*&: In a router or transport, you cannot assume the order in which
9343 option values are expanded, except for those preconditions whose order of
9344 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9345 by the expansion of one option, and use it in another.
9346
9347 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9348 out the use of this expansion item in filter files.
9349
9350
9351 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9352 .cindex "expansion" "string substitution"
9353 .cindex "&%sg%& expansion item"
9354 This item works like Perl's substitution operator (s) with the global (/g)
9355 option; hence its name. However, unlike the Perl equivalent, Exim does not
9356 modify the subject string; instead it returns the modified string for insertion
9357 into the overall expansion. The item takes three arguments: the subject string,
9358 a regular expression, and a substitution string. For example:
9359 .code
9360 ${sg{abcdefabcdef}{abc}{xyz}}
9361 .endd
9362 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9363 if any $ or \ characters are required in the regular expression or in the
9364 substitution string, they have to be escaped. For example:
9365 .code
9366 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9367 .endd
9368 yields &"defabc"&, and
9369 .code
9370 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9371 .endd
9372 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9373 the regular expression from string expansion.
9374
9375
9376
9377 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9378 .cindex "&%substr%& expansion item"
9379 .cindex "substring extraction"
9380 .cindex "expansion" "substring extraction"
9381 The three strings are expanded; the first two must yield numbers. Call them
9382 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9383 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9384 can use the simpler operator notation that avoids some of the braces:
9385 .code
9386 ${substr_<n>_<m>:<string>}
9387 .endd
9388 The second number is optional (in both notations).
9389 If it is absent in the simpler format, the preceding underscore must also be
9390 omitted.
9391
9392 The &%substr%& item can be used to extract more general substrings than
9393 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9394 length required. For example
9395 .code
9396 ${substr{3}{2}{$local_part}}
9397 .endd
9398 If the starting offset is greater than the string length the result is the
9399 null string; if the length plus starting offset is greater than the string
9400 length, the result is the right-hand part of the string, starting from the
9401 given offset. The first character in the string has offset zero.
9402
9403 The &%substr%& expansion item can take negative offset values to count
9404 from the right-hand end of its operand. The last character is offset -1, the
9405 second-last is offset -2, and so on. Thus, for example,
9406 .code
9407 ${substr{-5}{2}{1234567}}
9408 .endd
9409 yields &"34"&. If the absolute value of a negative offset is greater than the
9410 length of the string, the substring starts at the beginning of the string, and
9411 the length is reduced by the amount of overshoot. Thus, for example,
9412 .code
9413 ${substr{-5}{2}{12}}
9414 .endd
9415 yields an empty string, but
9416 .code
9417 ${substr{-3}{2}{12}}
9418 .endd
9419 yields &"1"&.
9420
9421 When the second number is omitted from &%substr%&, the remainder of the string
9422 is taken if the offset is positive. If it is negative, all characters in the
9423 string preceding the offset point are taken. For example, an offset of -1 and
9424 no length, as in these semantically identical examples:
9425 .code
9426 ${substr_-1:abcde}
9427 ${substr{-1}{abcde}}
9428 .endd
9429 yields all but the last character of the string, that is, &"abcd"&.
9430
9431
9432
9433 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9434         {*&<&'replacements'&>&*}}*&"
9435 .cindex "expansion" "character translation"
9436 .cindex "&%tr%& expansion item"
9437 This item does single-character translation on its subject string. The second
9438 argument is a list of characters to be translated in the subject string. Each
9439 matching character is replaced by the corresponding character from the
9440 replacement list. For example
9441 .code
9442 ${tr{abcdea}{ac}{13}}
9443 .endd
9444 yields &`1b3de1`&. If there are duplicates in the second character string, the
9445 last occurrence is used. If the third string is shorter than the second, its
9446 last character is replicated. However, if it is empty, no translation takes
9447 place.
9448 .endlist
9449
9450
9451
9452 .section "Expansion operators" "SECTexpop"
9453 .cindex "expansion" "operators"
9454 For expansion items that perform transformations on a single argument string,
9455 the &"operator"& notation is used because it is simpler and uses fewer braces.
9456 The substring is first expanded before the operation is applied to it. The
9457 following operations can be performed:
9458
9459 .vlist
9460 .vitem &*${address:*&<&'string'&>&*}*&
9461 .cindex "expansion" "RFC 2822 address handling"
9462 .cindex "&%address%& expansion item"
9463 The string is interpreted as an RFC 2822 address, as it might appear in a
9464 header line, and the effective address is extracted from it. If the string does
9465 not parse successfully, the result is empty.
9466
9467
9468 .vitem &*${addresses:*&<&'string'&>&*}*&
9469 .cindex "expansion" "RFC 2822 address handling"
9470 .cindex "&%addresses%& expansion item"
9471 The string (after expansion) is interpreted as a list of addresses in RFC
9472 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9473 operative address (&'local-part@domain'&) is extracted from each item, and the
9474 result of the expansion is a colon-separated list, with appropriate
9475 doubling of colons should any happen to be present in the email addresses.
9476 Syntactically invalid RFC2822 address items are omitted from the output.
9477
9478 It is possible to specify a character other than colon for the output
9479 separator by starting the string with > followed by the new separator
9480 character. For example:
9481 .code
9482 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9483 .endd
9484 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9485 expansion item, which extracts the working address from a single RFC2822
9486 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9487 processing lists.
9488
9489
9490 .vitem &*${base62:*&<&'digits'&>&*}*&
9491 .cindex "&%base62%& expansion item"
9492 .cindex "expansion" "conversion to base 62"
9493 The string must consist entirely of decimal digits. The number is converted to
9494 base 62 and output as a string of six characters, including leading zeros. In
9495 the few operating environments where Exim uses base 36 instead of base 62 for
9496 its message identifiers (because those systems do not have case-sensitive file
9497 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9498 be absolutely clear: this is &'not'& base64 encoding.
9499
9500 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9501 .cindex "&%base62d%& expansion item"
9502 .cindex "expansion" "conversion to base 62"
9503 The string must consist entirely of base-62 digits, or, in operating
9504 environments where Exim uses base 36 instead of base 62 for its message
9505 identifiers, base-36 digits. The number is converted to decimal and output as a
9506 string.
9507
9508 .vitem &*${domain:*&<&'string'&>&*}*&
9509 .cindex "domain" "extraction"
9510 .cindex "expansion" "domain extraction"
9511 The string is interpreted as an RFC 2822 address and the domain is extracted
9512 from it. If the string does not parse successfully, the result is empty.
9513
9514
9515 .vitem &*${escape:*&<&'string'&>&*}*&
9516 .cindex "expansion" "escaping non-printing characters"
9517 .cindex "&%escape%& expansion item"
9518 If the string contains any non-printing characters, they are converted to
9519 escape sequences starting with a backslash. Whether characters with the most
9520 significant bit set (so-called &"8-bit characters"&) count as printing or not
9521 is controlled by the &%print_topbitchars%& option.
9522
9523
9524 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9525 .cindex "expansion" "expression evaluation"
9526 .cindex "expansion" "arithmetic expression"
9527 .cindex "&%eval%& expansion item"
9528 These items supports simple arithmetic and bitwise logical operations in
9529 expansion strings. The string (after expansion) must be a conventional
9530 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9531 logical operators, and parentheses. All operations are carried out using
9532 integer arithmetic. The operator priorities are as follows (the same as in the
9533 C programming language):
9534 .table2 70pt 300pt
9535 .irow &'highest:'& "not (~), negate (-)"
9536 .irow ""   "multiply (*), divide (/), remainder (%)"
9537 .irow ""   "plus (+), minus (-)"
9538 .irow ""   "shift-left (<<), shift-right (>>)"
9539 .irow ""   "and (&&)"
9540 .irow ""   "xor (^)"
9541 .irow &'lowest:'&  "or (|)"
9542 .endtable
9543 Binary operators with the same priority are evaluated from left to right. White
9544 space is permitted before or after operators.
9545
9546 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9547 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9548 decimal, even if they start with a leading zero; hexadecimal numbers are not
9549 permitted. This can be useful when processing numbers extracted from dates or
9550 times, which often do have leading zeros.
9551
9552 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9553 or 1024*1024*1024,
9554 respectively. Negative numbers are supported. The result of the computation is
9555 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9556
9557 .display
9558 &`${eval:1+1}            `&  yields 2
9559 &`${eval:1+2*3}          `&  yields 7
9560 &`${eval:(1+2)*3}        `&  yields 9
9561 &`${eval:2+42%5}         `&  yields 4
9562 &`${eval:0xc&amp;5}          `&  yields 4
9563 &`${eval:0xc|5}          `&  yields 13
9564 &`${eval:0xc^5}          `&  yields 9
9565 &`${eval:0xc>>1}         `&  yields 6
9566 &`${eval:0xc<<1}         `&  yields 24
9567 &`${eval:~255&amp;0x1234}    `&  yields 4608
9568 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9569 .endd
9570
9571 As a more realistic example, in an ACL you might have
9572 .code
9573 deny   message = Too many bad recipients
9574        condition =                    \
9575          ${if and {                   \
9576            {>{$rcpt_count}{10}}       \
9577            {                          \
9578            <                          \
9579              {$recipients_count}      \
9580              {${eval:$rcpt_count/2}}  \
9581            }                          \
9582          }{yes}{no}}
9583 .endd
9584 The condition is true if there have been more than 10 RCPT commands and
9585 fewer than half of them have resulted in a valid recipient.
9586
9587
9588 .vitem &*${expand:*&<&'string'&>&*}*&
9589 .cindex "expansion" "re-expansion of substring"
9590 The &%expand%& operator causes a string to be expanded for a second time. For
9591 example,
9592 .code
9593 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9594 .endd
9595 first looks up a string in a file while expanding the operand for &%expand%&,
9596 and then re-expands what it has found.
9597
9598
9599 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9600 .cindex "Unicode"
9601 .cindex "UTF-8" "conversion from"
9602 .cindex "expansion" "UTF-8 conversion"
9603 .cindex "&%from_utf8%& expansion item"
9604 The world is slowly moving towards Unicode, although there are no standards for
9605 email yet. However, other applications (including some databases) are starting
9606 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9607 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9608 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9609 the result is an undefined sequence of bytes.
9610
9611 Unicode code points with values less than 256 are compatible with ASCII and
9612 ISO-8859-1 (also known as Latin-1).
9613 For example, character 169 is the copyright symbol in both cases, though the
9614 way it is encoded is different. In UTF-8, more than one byte is needed for
9615 characters with code values greater than 127, whereas ISO-8859-1 is a
9616 single-byte encoding (but thereby limited to 256 characters). This makes
9617 translation from UTF-8 to ISO-8859-1 straightforward.
9618
9619
9620 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9621 .cindex "hash function" "textual"
9622 .cindex "expansion" "textual hash"
9623 The &%hash%& operator is a simpler interface to the hashing function that can
9624 be used when the two parameters are fixed numbers (as opposed to strings that
9625 change when expanded). The effect is the same as
9626 .code
9627 ${hash{<n>}{<m>}{<string>}}
9628 .endd
9629 See the description of the general &%hash%& item above for details. The
9630 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9631
9632
9633
9634 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9635 .cindex "base64 encoding" "conversion from hex"
9636 .cindex "expansion" "hex to base64"
9637 .cindex "&%hex2b64%& expansion item"
9638 This operator converts a hex string into one that is base64 encoded. This can
9639 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9640
9641
9642 .vitem &*${lc:*&<&'string'&>&*}*&
9643 .cindex "case forcing in strings"
9644 .cindex "string" "case forcing"
9645 .cindex "lower casing"
9646 .cindex "expansion" "case forcing"
9647 .cindex "&%lc%& expansion item"
9648 This forces the letters in the string into lower-case, for example:
9649 .code
9650 ${lc:$local_part}
9651 .endd
9652
9653 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9654 .cindex "expansion" "string truncation"
9655 .cindex "&%length%& expansion item"
9656 The &%length%& operator is a simpler interface to the &%length%& function that
9657 can be used when the parameter is a fixed number (as opposed to a string that
9658 changes when expanded). The effect is the same as
9659 .code
9660 ${length{<number>}{<string>}}
9661 .endd
9662 See the description of the general &%length%& item above for details. Note that
9663 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9664 when &%length%& is used as an operator.
9665
9666
9667 .vitem &*${local_part:*&<&'string'&>&*}*&
9668 .cindex "expansion" "local part extraction"
9669 .cindex "&%local_part%& expansion item"
9670 The string is interpreted as an RFC 2822 address and the local part is
9671 extracted from it. If the string does not parse successfully, the result is
9672 empty.
9673
9674
9675 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9676 .cindex "masked IP address"
9677 .cindex "IP address" "masking"
9678 .cindex "CIDR notation"
9679 .cindex "expansion" "IP address masking"
9680 .cindex "&%mask%& expansion item"
9681 If the form of the string to be operated on is not an IP address followed by a
9682 slash and an integer (that is, a network address in CIDR notation), the
9683 expansion fails. Otherwise, this operator converts the IP address to binary,
9684 masks off the least significant bits according to the bit count, and converts
9685 the result back to text, with mask appended. For example,
9686 .code
9687 ${mask:10.111.131.206/28}
9688 .endd
9689 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9690 be mostly used for looking up masked addresses in files, the result for an IPv6
9691 address uses dots to separate components instead of colons, because colon
9692 terminates a key string in lsearch files. So, for example,
9693 .code
9694 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9695 .endd
9696 returns the string
9697 .code
9698 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9699 .endd
9700 Letters in IPv6 addresses are always output in lower case.
9701
9702
9703 .vitem &*${md5:*&<&'string'&>&*}*&
9704 .cindex "MD5 hash"
9705 .cindex "expansion" "MD5 hash"
9706 .cindex "&%md5%& expansion item"
9707 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9708 as a 32-digit hexadecimal number, in which any letters are in lower case.
9709
9710
9711 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9712 .cindex "expansion" "numeric hash"
9713 .cindex "hash function" "numeric"
9714 The &%nhash%& operator is a simpler interface to the numeric hashing function
9715 that can be used when the two parameters are fixed numbers (as opposed to
9716 strings that change when expanded). The effect is the same as
9717 .code
9718 ${nhash{<n>}{<m>}{<string>}}
9719 .endd
9720 See the description of the general &%nhash%& item above for details.
9721
9722
9723 .vitem &*${quote:*&<&'string'&>&*}*&
9724 .cindex "quoting" "in string expansions"
9725 .cindex "expansion" "quoting"
9726 .cindex "&%quote%& expansion item"
9727 The &%quote%& operator puts its argument into double quotes if it
9728 is an empty string or
9729 contains anything other than letters, digits, underscores, dots, and hyphens.
9730 Any occurrences of double quotes and backslashes are escaped with a backslash.
9731 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9732 respectively For example,
9733 .code
9734 ${quote:ab"*"cd}
9735 .endd
9736 becomes
9737 .code
9738 "ab\"*\"cd"
9739 .endd
9740 The place where this is useful is when the argument is a substitution from a
9741 variable or a message header.
9742
9743 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9744 .cindex "&%quote_local_part%& expansion item"
9745 This operator is like &%quote%&, except that it quotes the string only if
9746 required to do so by the rules of RFC 2822 for quoting local parts. For
9747 example, a plus sign would not cause quoting (but it would for &%quote%&).
9748 If you are creating a new email address from the contents of &$local_part$&
9749 (or any other unknown data), you should always use this operator.
9750
9751
9752 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9753 .cindex "quoting" "lookup-specific"
9754 This operator applies lookup-specific quoting rules to the string. Each
9755 query-style lookup type has its own quoting rules which are described with
9756 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9757 .code
9758 ${quote_ldap:two * two}
9759 .endd
9760 returns
9761 .code
9762 two%20%5C2A%20two
9763 .endd
9764 For single-key lookup types, no quoting is ever necessary and this operator
9765 yields an unchanged string.
9766
9767
9768 .vitem &*${randint:*&<&'n'&>&*}*&
9769 .cindex "random number"
9770 This operator returns a somewhat random number which is less than the
9771 supplied number and is at least 0.  The quality of this randomness depends
9772 on how Exim was built; the values are not suitable for keying material.
9773 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9774 .new
9775 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
9776 for versions of GnuTLS with that function.
9777 .wen
9778 Otherwise, the implementation may be arc4random(), random() seeded by
9779 srandomdev() or srandom(), or a custom implementation even weaker than
9780 random().
9781
9782
9783 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9784 .cindex "expansion" "IP address"
9785 This operator reverses an IP address; for IPv4 addresses, the result is in
9786 dotted-quad decimal form, while for IPv6 addreses the result is in
9787 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9788 for DNS.  For example,
9789 .code
9790 ${reverse_ip:192.0.2.4}
9791 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9792 .endd
9793 returns
9794 .code
9795 4.2.0.192
9796 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
9797 .endd
9798
9799
9800 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9801 .cindex "expansion" "RFC 2047"
9802 .cindex "RFC 2047" "expansion operator"
9803 .cindex "&%rfc2047%& expansion item"
9804 This operator encodes text according to the rules of RFC 2047. This is an
9805 encoding that is used in header lines to encode non-ASCII characters. It is
9806 assumed that the input string is in the encoding specified by the
9807 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9808 contains only characters in the range 33&--126, and no instances of the
9809 characters
9810 .code
9811 ? = ( ) < > @ , ; : \ " . [ ] _
9812 .endd
9813 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9814 string, using as many &"encoded words"& as necessary to encode all the
9815 characters.
9816
9817
9818 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9819 .cindex "expansion" "RFC 2047"
9820 .cindex "RFC 2047" "decoding"
9821 .cindex "&%rfc2047d%& expansion item"
9822 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9823 bytes are replaced by question marks. Characters are converted into the
9824 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9825 not recognized unless &%check_rfc2047_length%& is set false.
9826
9827 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9828 access a header line, RFC 2047 decoding is done automatically. You do not need
9829 to use this operator as well.
9830
9831
9832
9833 .vitem &*${rxquote:*&<&'string'&>&*}*&
9834 .cindex "quoting" "in regular expressions"
9835 .cindex "regular expressions" "quoting"
9836 .cindex "&%rxquote%& expansion item"
9837 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9838 characters in its argument. This is useful when substituting the values of
9839 variables or headers inside regular expressions.
9840
9841
9842 .vitem &*${sha1:*&<&'string'&>&*}*&
9843 .cindex "SHA-1 hash"
9844 .cindex "expansion" "SHA-1 hashing"
9845 .cindex "&%sha2%& expansion item"
9846 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9847 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9848
9849
9850 .vitem &*${stat:*&<&'string'&>&*}*&
9851 .cindex "expansion" "statting a file"
9852 .cindex "file" "extracting characteristics"
9853 .cindex "&%stat%& expansion item"
9854 The string, after expansion, must be a file path. A call to the &[stat()]&
9855 function is made for this path. If &[stat()]& fails, an error occurs and the
9856 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9857 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9858 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9859 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9860 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9861 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9862 can extract individual fields using the &%extract%& expansion item.
9863
9864 The use of the &%stat%& expansion in users' filter files can be locked out by
9865 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9866 systems for files larger than 2GB.
9867
9868 .vitem &*${str2b64:*&<&'string'&>&*}*&
9869 .cindex "expansion" "base64 encoding"
9870 .cindex "base64 encoding" "in string expansion"
9871 .cindex "&%str2b64%& expansion item"
9872 This operator converts a string into one that is base64 encoded.
9873
9874
9875
9876 .vitem &*${strlen:*&<&'string'&>&*}*&
9877 .cindex "expansion" "string length"
9878 .cindex "string" "length in expansion"
9879 .cindex "&%strlen%& expansion item"
9880 The item is replace by the length of the expanded string, expressed as a
9881 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9882
9883
9884 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9885 .cindex "&%substr%& expansion item"
9886 .cindex "substring extraction"
9887 .cindex "expansion" "substring expansion"
9888 The &%substr%& operator is a simpler interface to the &%substr%& function that
9889 can be used when the two parameters are fixed numbers (as opposed to strings
9890 that change when expanded). The effect is the same as
9891 .code
9892 ${substr{<start>}{<length>}{<string>}}
9893 .endd
9894 See the description of the general &%substr%& item above for details. The
9895 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9896
9897 .vitem &*${time_eval:*&<&'string'&>&*}*&
9898 .cindex "&%time_eval%& expansion item"
9899 .cindex "time interval" "decoding"
9900 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9901 seconds.
9902
9903 .vitem &*${time_interval:*&<&'string'&>&*}*&
9904 .cindex "&%time_interval%& expansion item"
9905 .cindex "time interval" "formatting"
9906 The argument (after sub-expansion) must be a sequence of decimal digits that
9907 represents an interval of time as a number of seconds. It is converted into a
9908 number of larger units and output in Exim's normal time format, for example,
9909 &`1w3d4h2m6s`&.
9910
9911 .vitem &*${uc:*&<&'string'&>&*}*&
9912 .cindex "case forcing in strings"
9913 .cindex "string" "case forcing"
9914 .cindex "upper casing"
9915 .cindex "expansion" "case forcing"
9916 .cindex "&%uc%& expansion item"
9917 This forces the letters in the string into upper-case.
9918 .endlist
9919
9920
9921
9922
9923
9924
9925 .section "Expansion conditions" "SECTexpcond"
9926 .scindex IIDexpcond "expansion" "conditions"
9927 The following conditions are available for testing by the &%${if%& construct
9928 while expanding strings:
9929
9930 .vlist
9931 .vitem &*!*&<&'condition'&>
9932 .cindex "expansion" "negating a condition"
9933 .cindex "negation" "in expansion condition"
9934 Preceding any condition with an exclamation mark negates the result of the
9935 condition.
9936
9937 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9938 .cindex "numeric comparison"
9939 .cindex "expansion" "numeric comparison"
9940 There are a number of symbolic operators for doing numeric comparisons. They
9941 are:
9942 .display
9943 &`=   `&   equal
9944 &`==  `&   equal
9945 &`>   `&   greater
9946 &`>=  `&   greater or equal
9947 &`<   `&   less
9948 &`<=  `&   less or equal
9949 .endd
9950 For example:
9951 .code
9952 ${if >{$message_size}{10M} ...
9953 .endd
9954 Note that the general negation operator provides for inequality testing. The
9955 two strings must take the form of optionally signed decimal integers,
9956 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9957 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9958 As a special case, the numerical value of an empty string is taken as
9959 zero.
9960
9961 In all cases, a relative comparator OP is testing if <&'string1'&> OP
9962 <&'string2'&>; the above example is checking if &$message_size$& is larger than
9963 10M, not if 10M is larger than &$message_size$&.
9964
9965
9966 .vitem &*bool&~{*&<&'string'&>&*}*&
9967 .cindex "expansion" "boolean parsing"
9968 .cindex "&%bool%& expansion condition"
9969 This condition turns a string holding a true or false representation into
9970 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
9971 (case-insensitively); also positive integer numbers map to true if non-zero,
9972 false if zero.
9973 An empty string is treated as false.
9974 Leading and trailing whitespace is ignored;
9975 thus a string consisting only of whitespace is false.
9976 All other string values will result in expansion failure.
9977
9978 When combined with ACL variables, this expansion condition will let you
9979 make decisions in one place and act on those decisions in another place.
9980 For example:
9981 .code
9982 ${if bool{$acl_m_privileged_sender} ...
9983 .endd
9984
9985
9986 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
9987 .cindex "expansion" "boolean parsing"
9988 .cindex "&%bool_lax%& expansion condition"
9989 Like &%bool%&, this condition turns a string into a boolean state.  But
9990 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
9991 loose definition that the Router &%condition%& option uses.  The empty string
9992 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
9993 true.  Leading and trailing whitespace is ignored.
9994
9995 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
9996
9997 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9998 .cindex "expansion" "encrypted comparison"
9999 .cindex "encrypted strings, comparing"
10000 .cindex "&%crypteq%& expansion condition"
10001 This condition is included in the Exim binary if it is built to support any
10002 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10003 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10004 included in the binary.
10005
10006 The &%crypteq%& condition has two arguments. The first is encrypted and
10007 compared against the second, which is already encrypted. The second string may
10008 be in the LDAP form for storing encrypted strings, which starts with the
10009 encryption type in curly brackets, followed by the data. If the second string
10010 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10011 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10012 Typically this will be a field from a password file. An example of an encrypted
10013 string in LDAP form is:
10014 .code
10015 {md5}CY9rzUYh03PK3k6DJie09g==
10016 .endd
10017 If such a string appears directly in an expansion, the curly brackets have to
10018 be quoted, because they are part of the expansion syntax. For example:
10019 .code
10020 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10021 .endd
10022 The following encryption types (whose names are matched case-independently) are
10023 supported:
10024
10025 .ilist
10026 .cindex "MD5 hash"
10027 .cindex "base64 encoding" "in encrypted password"
10028 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10029 printable characters to compare with the remainder of the second string. If the
10030 length of the comparison string is 24, Exim assumes that it is base64 encoded
10031 (as in the above example). If the length is 32, Exim assumes that it is a
10032 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10033 comparison fails.
10034
10035 .next
10036 .cindex "SHA-1 hash"
10037 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10038 printable characters to compare with the remainder of the second string. If the
10039 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10040 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10041 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10042
10043 .next
10044 .cindex "&[crypt()]&"
10045 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10046 only the first eight characters of the password. However, in modern operating
10047 systems this is no longer true, and in many cases the entire password is used,
10048 whatever its length.
10049
10050 .next
10051 .cindex "&[crypt16()]&"
10052 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10053 use up to 16 characters of the password in some operating systems. Again, in
10054 modern operating systems, more characters may be used.
10055 .endlist
10056 Exim has its own version of &[crypt16()]&, which is just a double call to
10057 &[crypt()]&. For operating systems that have their own version, setting
10058 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10059 operating system version instead of its own. This option is set by default in
10060 the OS-dependent &_Makefile_& for those operating systems that are known to
10061 support &[crypt16()]&.
10062
10063 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10064 it was not using the same algorithm as some operating systems' versions. It
10065 turns out that as well as &[crypt16()]& there is a function called
10066 &[bigcrypt()]& in some operating systems. This may or may not use the same
10067 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10068
10069 However, since there is now a move away from the traditional &[crypt()]&
10070 functions towards using SHA1 and other algorithms, tidying up this area of
10071 Exim is seen as very low priority.
10072
10073 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10074 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10075 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10076 default is &`{crypt}`&. Whatever the default, you can always use either
10077 function by specifying it explicitly in curly brackets.
10078
10079 .vitem &*def:*&<&'variable&~name'&>
10080 .cindex "expansion" "checking for empty variable"
10081 .cindex "&%def%& expansion condition"
10082 The &%def%& condition must be followed by the name of one of the expansion
10083 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10084 variable does not contain the empty string. For example:
10085 .code
10086 ${if def:sender_ident {from $sender_ident}}
10087 .endd
10088 Note that the variable name is given without a leading &%$%& character. If the
10089 variable does not exist, the expansion fails.
10090
10091 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10092         &~&*def:h_*&<&'header&~name'&>&*:*&"
10093 .cindex "expansion" "checking header line existence"
10094 This condition is true if a message is being processed and the named header
10095 exists in the message. For example,
10096 .code
10097 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10098 .endd
10099 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10100 the header name must be terminated by a colon if white space does not follow.
10101
10102 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10103        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10104 .cindex "string" "comparison"
10105 .cindex "expansion" "string comparison"
10106 .cindex "&%eq%& expansion condition"
10107 .cindex "&%eqi%& expansion condition"
10108 The two substrings are first expanded. The condition is true if the two
10109 resulting strings are identical. For &%eq%& the comparison includes the case of
10110 letters, whereas for &%eqi%& the comparison is case-independent.
10111
10112 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10113 .cindex "expansion" "file existence test"
10114 .cindex "file" "existence test"
10115 .cindex "&%exists%&, expansion condition"
10116 The substring is first expanded and then interpreted as an absolute path. The
10117 condition is true if the named file (or directory) exists. The existence test
10118 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10119 users' filter files may be locked out by the system administrator.
10120
10121 .vitem &*first_delivery*&
10122 .cindex "delivery" "first"
10123 .cindex "first delivery"
10124 .cindex "expansion" "first delivery test"
10125 .cindex "&%first_delivery%& expansion condition"
10126 This condition, which has no data, is true during a message's first delivery
10127 attempt. It is false during any subsequent delivery attempts.
10128
10129
10130 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10131        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10132 .cindex "list" "iterative conditions"
10133 .cindex "expansion" "&*forall*& condition"
10134 .cindex "expansion" "&*forany*& condition"
10135 .vindex "&$item$&"
10136 These conditions iterate over a list. The first argument is expanded to form
10137 the list. By default, the list separator is a colon, but it can be changed by
10138 the normal method. The second argument is interpreted as a condition that is to
10139 be applied to each item in the list in turn. During the interpretation of the
10140 condition, the current list item is placed in a variable called &$item$&.
10141 .ilist
10142 For &*forany*&, interpretation stops if the condition is true for any item, and
10143 the result of the whole condition is true. If the condition is false for all
10144 items in the list, the overall condition is false.
10145 .next
10146 For &*forall*&, interpretation stops if the condition is false for any item,
10147 and the result of the whole condition is false. If the condition is true for
10148 all items in the list, the overall condition is true.
10149 .endlist
10150 Note that negation of &*forany*& means that the condition must be false for all
10151 items for the overall condition to succeed, and negation of &*forall*& means
10152 that the condition must be false for at least one item. In this example, the
10153 list separator is changed to a comma:
10154 .code
10155 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10156 .endd
10157 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10158 being processed, to enable these expansion items to be nested.
10159
10160
10161 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10162        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10163 .cindex "string" "comparison"
10164 .cindex "expansion" "string comparison"
10165 .cindex "&%ge%& expansion condition"
10166 .cindex "&%gei%& expansion condition"
10167 The two substrings are first expanded. The condition is true if the first
10168 string is lexically greater than or equal to the second string. For &%ge%& the
10169 comparison includes the case of letters, whereas for &%gei%& the comparison is
10170 case-independent.
10171
10172 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10173        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10174 .cindex "string" "comparison"
10175 .cindex "expansion" "string comparison"
10176 .cindex "&%gt%& expansion condition"
10177 .cindex "&%gti%& expansion condition"
10178 The two substrings are first expanded. The condition is true if the first
10179 string is lexically greater than the second string. For &%gt%& the comparison
10180 includes the case of letters, whereas for &%gti%& the comparison is
10181 case-independent.
10182
10183 .new
10184 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10185        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10186 .cindex "string" "comparison"
10187 .cindex "list" "iterative conditions"
10188 Both strings are expanded; the second string is treated as a list of simple
10189 strings; if the first string is a member of the second, then the condition
10190 is true.
10191
10192 These are simpler to use versions of the more powerful &*forany*& condition.
10193 Examples, and the &*forany*& equivalents:
10194 .code
10195 ${if inlist{needle}{foo:needle:bar}}
10196   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10197 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10198   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10199 .endd
10200 .wen
10201
10202 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10203        &*isip4&~{*&<&'string'&>&*}*& &&&
10204        &*isip6&~{*&<&'string'&>&*}*&
10205 .cindex "IP address" "testing string format"
10206 .cindex "string" "testing for IP address"
10207 .cindex "&%isip%& expansion condition"
10208 .cindex "&%isip4%& expansion condition"
10209 .cindex "&%isip6%& expansion condition"
10210 The substring is first expanded, and then tested to see if it has the form of
10211 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10212 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10213
10214 For an IPv4 address, the test is for four dot-separated components, each of
10215 which consists of from one to three digits. For an IPv6 address, up to eight
10216 colon-separated components are permitted, each containing from one to four
10217 hexadecimal digits. There may be fewer than eight components if an empty
10218 component (adjacent colons) is present. Only one empty component is permitted.
10219
10220 &*Note*&: The checks are just on the form of the address; actual numerical
10221 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10222 check. The main use of these tests is to distinguish between IP addresses and
10223 host names, or between IPv4 and IPv6 addresses. For example, you could use
10224 .code
10225 ${if isip4{$sender_host_address}...
10226 .endd
10227 to test which IP version an incoming SMTP connection is using.
10228
10229 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10230 .cindex "LDAP" "use for authentication"
10231 .cindex "expansion" "LDAP authentication test"
10232 .cindex "&%ldapauth%& expansion condition"
10233 This condition supports user authentication using LDAP. See section
10234 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10235 queries. For this use, the query must contain a user name and password. The
10236 query itself is not used, and can be empty. The condition is true if the
10237 password is not empty, and the user name and password are accepted by the LDAP
10238 server. An empty password is rejected without calling LDAP because LDAP binds
10239 with an empty password are considered anonymous regardless of the username, and
10240 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10241 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10242 this can be used.
10243
10244
10245 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10246        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10247 .cindex "string" "comparison"
10248 .cindex "expansion" "string comparison"
10249 .cindex "&%le%& expansion condition"
10250 .cindex "&%lei%& expansion condition"
10251 The two substrings are first expanded. The condition is true if the first
10252 string is lexically less than or equal to the second string. For &%le%& the
10253 comparison includes the case of letters, whereas for &%lei%& the comparison is
10254 case-independent.
10255
10256 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10257        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10258 .cindex "string" "comparison"
10259 .cindex "expansion" "string comparison"
10260 .cindex "&%lt%& expansion condition"
10261 .cindex "&%lti%& expansion condition"
10262 The two substrings are first expanded. The condition is true if the first
10263 string is lexically less than the second string. For &%lt%& the comparison
10264 includes the case of letters, whereas for &%lti%& the comparison is
10265 case-independent.
10266
10267
10268 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10269 .cindex "expansion" "regular expression comparison"
10270 .cindex "regular expressions" "match in expanded string"
10271 .cindex "&%match%& expansion condition"
10272 The two substrings are first expanded. The second is then treated as a regular
10273 expression and applied to the first. Because of the pre-expansion, if the
10274 regular expression contains dollar, or backslash characters, they must be
10275 escaped. Care must also be taken if the regular expression contains braces
10276 (curly brackets). A closing brace must be escaped so that it is not taken as a
10277 premature termination of <&'string2'&>. The easiest approach is to use the
10278 &`\N`& feature to disable expansion of the regular expression.
10279 For example,
10280 .code
10281 ${if match {$local_part}{\N^\d{3}\N} ...
10282 .endd
10283 If the whole expansion string is in double quotes, further escaping of
10284 backslashes is also required.
10285
10286 The condition is true if the regular expression match succeeds.
10287 The regular expression is not required to begin with a circumflex
10288 metacharacter, but if there is no circumflex, the expression is not anchored,
10289 and it may match anywhere in the subject, not just at the start. If you want
10290 the pattern to match at the end of the subject, you must include the &`$`&
10291 metacharacter at an appropriate point.
10292
10293 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10294 At the start of an &%if%& expansion the values of the numeric variable
10295 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10296 succeeds causes them to be reset to the substrings of that condition and they
10297 will have these values during the expansion of the success string. At the end
10298 of the &%if%& expansion, the previous values are restored. After testing a
10299 combination of conditions using &%or%&, the subsequent values of the numeric
10300 variables are those of the condition that succeeded.
10301
10302 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10303 .cindex "&%match_address%& expansion condition"
10304 See &*match_local_part*&.
10305
10306 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10307 .cindex "&%match_domain%& expansion condition"
10308 See &*match_local_part*&.
10309
10310 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10311 .cindex "&%match_ip%& expansion condition"
10312 .new
10313 This condition matches an IP address to a list of IP address patterns. It must
10314 be followed by two argument strings. The first (after expansion) must be an IP
10315 address or an empty string. The second (not expanded) is a restricted host
10316 list that can match only an IP address, not a host name. For example:
10317 .wen
10318 .code
10319 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10320 .endd
10321 The specific types of host list item that are permitted in the list are:
10322
10323 .ilist
10324 An IP address, optionally with a CIDR mask.
10325 .next
10326 A single asterisk, which matches any IP address.
10327 .next
10328 An empty item, which matches only if the IP address is empty. This could be
10329 useful for testing for a locally submitted message or one from specific hosts
10330 in a single test such as
10331 . ==== As this is a nested list, any displays it contains must be indented
10332 . ==== as otherwise they are too far to the left. This comment applies to
10333 . ==== the use of xmlto plus fop. There's no problem when formatting with
10334 . ==== sdop, with or without the extra indent.
10335 .code
10336   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10337 .endd
10338 where the first item in the list is the empty string.
10339 .next
10340 The item @[] matches any of the local host's interface addresses.
10341 .next
10342 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10343 even if &`net-`& is not specified. There is never any attempt to turn the IP
10344 address into a host name. The most common type of linear search for
10345 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10346 masks. For example:
10347 .code
10348   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10349 .endd
10350 It is of course possible to use other kinds of lookup, and in such a case, you
10351 do need to specify the &`net-`& prefix if you want to specify a specific
10352 address mask, for example:
10353 .code
10354   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10355 .endd
10356 However, unless you are combining a &%match_ip%& condition with others, it is
10357 just as easy to use the fact that a lookup is itself a condition, and write:
10358 .code
10359   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10360 .endd
10361 .endlist ilist
10362
10363 .new
10364 Note that <&'string2'&> is not itself subject to string expansion, unless
10365 Exim was built with the EXPAND_LISTMATCH_RHS option.
10366 .wen
10367
10368 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10369
10370 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10371 .cindex "domain list" "in expansion condition"
10372 .cindex "address list" "in expansion condition"
10373 .cindex "local part" "list, in expansion condition"
10374 .cindex "&%match_local_part%& expansion condition"
10375 This condition, together with &%match_address%& and &%match_domain%&, make it
10376 possible to test domain, address, and local part lists within expansions. Each
10377 condition requires two arguments: an item and a list to match. A trivial
10378 example is:
10379 .code
10380 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10381 .endd
10382 In each case, the second argument may contain any of the allowable items for a
10383 list of the appropriate type. Also, because the second argument (after
10384 expansion) is a standard form of list, it is possible to refer to a named list.
10385 Thus, you can use conditions like this:
10386 .code
10387 ${if match_domain{$domain}{+local_domains}{...
10388 .endd
10389 .cindex "&`+caseful`&"
10390 For address lists, the matching starts off caselessly, but the &`+caseful`&
10391 item can be used, as in all address lists, to cause subsequent items to
10392 have their local parts matched casefully. Domains are always matched
10393 caselessly.
10394
10395 .new
10396 Note that <&'string2'&> is not itself subject to string expansion, unless
10397 Exim was built with the EXPAND_LISTMATCH_RHS option.
10398 .wen
10399
10400 &*Note*&: Host lists are &'not'& supported in this way. This is because
10401 hosts have two identities: a name and an IP address, and it is not clear
10402 how to specify cleanly how such a test would work. However, IP addresses can be
10403 matched using &%match_ip%&.
10404
10405 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10406 .cindex "PAM authentication"
10407 .cindex "AUTH" "with PAM"
10408 .cindex "Solaris" "PAM support"
10409 .cindex "expansion" "PAM authentication test"
10410 .cindex "&%pam%& expansion condition"
10411 &'Pluggable Authentication Modules'&
10412 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10413 available in the latest releases of Solaris and in some GNU/Linux
10414 distributions. The Exim support, which is intended for use in conjunction with
10415 the SMTP AUTH command, is available only if Exim is compiled with
10416 .code
10417 SUPPORT_PAM=yes
10418 .endd
10419 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10420 in some releases of GNU/Linux &%-ldl%& is also needed.
10421
10422 The argument string is first expanded, and the result must be a
10423 colon-separated list of strings. Leading and trailing white space is ignored.
10424 The PAM module is initialized with the service name &"exim"& and the user name
10425 taken from the first item in the colon-separated data string (<&'string1'&>).
10426 The remaining items in the data string are passed over in response to requests
10427 from the authentication function. In the simple case there will only be one
10428 request, for a password, so the data consists of just two strings.
10429
10430 There can be problems if any of the strings are permitted to contain colon
10431 characters. In the usual way, these have to be doubled to avoid being taken as
10432 separators. If the data is being inserted from a variable, the &%sg%& expansion
10433 item can be used to double any existing colons. For example, the configuration
10434 of a LOGIN authenticator might contain this setting:
10435 .code
10436 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10437 .endd
10438 For a PLAIN authenticator you could use:
10439 .code
10440 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10441 .endd
10442 In some operating systems, PAM authentication can be done only from a process
10443 running as root. Since Exim is running as the Exim user when receiving
10444 messages, this means that PAM cannot be used directly in those systems.
10445 A patched version of the &'pam_unix'& module that comes with the
10446 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10447 The patched module allows one special uid/gid combination, in addition to root,
10448 to authenticate. If you build the patched module to allow the Exim user and
10449 group, PAM can then be used from an Exim authenticator.
10450
10451
10452 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10453 .cindex "&'pwcheck'& daemon"
10454 .cindex "Cyrus"
10455 .cindex "expansion" "&'pwcheck'& authentication test"
10456 .cindex "&%pwcheck%& expansion condition"
10457 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10458 This is one way of making it possible for passwords to be checked by a process
10459 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10460 deprecated. Its replacement is &'saslauthd'& (see below).
10461
10462 The pwcheck support is not included in Exim by default. You need to specify
10463 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10464 building Exim. For example:
10465 .code
10466 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10467 .endd
10468 You do not need to install the full Cyrus software suite in order to use
10469 the pwcheck daemon. You can compile and install just the daemon alone
10470 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10471 access to the &_/var/pwcheck_& directory.
10472
10473 The &%pwcheck%& condition takes one argument, which must be the user name and
10474 password, separated by a colon. For example, in a LOGIN authenticator
10475 configuration, you might have this:
10476 .code
10477 server_condition = ${if pwcheck{$auth1:$auth2}}
10478 .endd
10479 Again, for a PLAIN authenticator configuration, this would be:
10480 .code
10481 server_condition = ${if pwcheck{$auth2:$auth3}}
10482 .endd
10483 .vitem &*queue_running*&
10484 .cindex "queue runner" "detecting when delivering from"
10485 .cindex "expansion" "queue runner test"
10486 .cindex "&%queue_running%& expansion condition"
10487 This condition, which has no data, is true during delivery attempts that are
10488 initiated by queue runner processes, and false otherwise.
10489
10490
10491 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10492 .cindex "Radius"
10493 .cindex "expansion" "Radius authentication"
10494 .cindex "&%radius%& expansion condition"
10495 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10496 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10497 the Radius client configuration file in order to build Exim with Radius
10498 support.
10499
10500 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10501 library, using the original API. If you are using release 0.4.0 or later of
10502 this library, you need to set
10503 .code
10504 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10505 .endd
10506 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10507 &%libradius%& library that comes with FreeBSD. To do this, set
10508 .code
10509 RADIUS_LIB_TYPE=RADLIB
10510 .endd
10511 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10512 You may also have to supply a suitable setting in EXTRALIBS so that the
10513 Radius library can be found when Exim is linked.
10514
10515 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10516 Radius client library, which calls the Radius server. The condition is true if
10517 the authentication is successful. For example:
10518 .code
10519 server_condition = ${if radius{<arguments>}}
10520 .endd
10521
10522
10523 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10524         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10525 .cindex "&'saslauthd'& daemon"
10526 .cindex "Cyrus"
10527 .cindex "expansion" "&'saslauthd'& authentication test"
10528 .cindex "&%saslauthd%& expansion condition"
10529 This condition supports user authentication using the Cyrus &'saslauthd'&
10530 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10531 Using this daemon is one way of making it possible for passwords to be checked
10532 by a process that is not running as root.
10533
10534 The saslauthd support is not included in Exim by default. You need to specify
10535 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10536 building Exim. For example:
10537 .code
10538 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10539 .endd
10540 You do not need to install the full Cyrus software suite in order to use
10541 the saslauthd daemon. You can compile and install just the daemon alone
10542 from the Cyrus SASL library.
10543
10544 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10545 two are mandatory. For example:
10546 .code
10547 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10548 .endd
10549 The service and the realm are optional (which is why the arguments are enclosed
10550 in their own set of braces). For details of the meaning of the service and
10551 realm, and how to run the daemon, consult the Cyrus documentation.
10552 .endlist vlist
10553
10554
10555
10556 .section "Combining expansion conditions" "SECID84"
10557 .cindex "expansion" "combining conditions"
10558 Several conditions can be tested at once by combining them using the &%and%&
10559 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10560 conditions on their own, and precede their lists of sub-conditions. Each
10561 sub-condition must be enclosed in braces within the overall braces that contain
10562 the list. No repetition of &%if%& is used.
10563
10564
10565 .vlist
10566 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10567 .cindex "&""or""& expansion condition"
10568 .cindex "expansion" "&""or""& of conditions"
10569 The sub-conditions are evaluated from left to right. The condition is true if
10570 any one of the sub-conditions is true.
10571 For example,
10572 .code
10573 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10574 .endd
10575 When a true sub-condition is found, the following ones are parsed but not
10576 evaluated. If there are several &"match"& sub-conditions the values of the
10577 numeric variables afterwards are taken from the first one that succeeds.
10578
10579 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10580 .cindex "&""and""& expansion condition"
10581 .cindex "expansion" "&""and""& of conditions"
10582 The sub-conditions are evaluated from left to right. The condition is true if
10583 all of the sub-conditions are true. If there are several &"match"&
10584 sub-conditions, the values of the numeric variables afterwards are taken from
10585 the last one. When a false sub-condition is found, the following ones are
10586 parsed but not evaluated.
10587 .endlist
10588 .ecindex IIDexpcond
10589
10590
10591
10592
10593 .section "Expansion variables" "SECTexpvar"
10594 .cindex "expansion" "variables, list of"
10595 This section contains an alphabetical list of all the expansion variables. Some
10596 of them are available only when Exim is compiled with specific options such as
10597 support for TLS or the content scanning extension.
10598
10599 .vlist
10600 .vitem "&$0$&, &$1$&, etc"
10601 .cindex "numerical variables (&$1$& &$2$& etc)"
10602 When a &%match%& expansion condition succeeds, these variables contain the
10603 captured substrings identified by the regular expression during subsequent
10604 processing of the success string of the containing &%if%& expansion item.
10605 However, they do not retain their values afterwards; in fact, their previous
10606 values are restored at the end of processing an &%if%& item. The numerical
10607 variables may also be set externally by some other matching process which
10608 precedes the expansion of the string. For example, the commands available in
10609 Exim filter files include an &%if%& command with its own regular expression
10610 matching condition.
10611
10612 .vitem "&$acl_c...$&"
10613 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10614 can be given any name that starts with &$acl_c$& and is at least six characters
10615 long, but the sixth character must be either a digit or an underscore. For
10616 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10617 variables persist throughout the lifetime of an SMTP connection. They can be
10618 used to pass information between ACLs and between different invocations of the
10619 same ACL. When a message is received, the values of these variables are saved
10620 with the message, and can be accessed by filters, routers, and transports
10621 during subsequent delivery.
10622
10623 .vitem "&$acl_m...$&"
10624 These variables are like the &$acl_c...$& variables, except that their values
10625 are reset after a message has been received. Thus, if several messages are
10626 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10627 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10628 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10629 message is received, the values of these variables are saved with the message,
10630 and can be accessed by filters, routers, and transports during subsequent
10631 delivery.
10632
10633 .vitem &$acl_verify_message$&
10634 .vindex "&$acl_verify_message$&"
10635 After an address verification has failed, this variable contains the failure
10636 message. It retains its value for use in subsequent modifiers. The message can
10637 be preserved by coding like this:
10638 .code
10639 warn !verify = sender
10640      set acl_m0 = $acl_verify_message
10641 .endd
10642 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10643 &%log_message%& modifiers, to include information about the verification
10644 failure.
10645
10646 .vitem &$address_data$&
10647 .vindex "&$address_data$&"
10648 This variable is set by means of the &%address_data%& option in routers. The
10649 value then remains with the address while it is processed by subsequent routers
10650 and eventually a transport. If the transport is handling multiple addresses,
10651 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10652 for more details. &*Note*&: The contents of &$address_data$& are visible in
10653 user filter files.
10654
10655 If &$address_data$& is set when the routers are called from an ACL to verify
10656 a recipient address, the final value is still in the variable for subsequent
10657 conditions and modifiers of the ACL statement. If routing the address caused it
10658 to be redirected to just one address, the child address is also routed as part
10659 of the verification, and in this case the final value of &$address_data$& is
10660 from the child's routing.
10661
10662 If &$address_data$& is set when the routers are called from an ACL to verify a
10663 sender address, the final value is also preserved, but this time in
10664 &$sender_address_data$&, to distinguish it from data from a recipient
10665 address.
10666
10667 In both cases (recipient and sender verification), the value does not persist
10668 after the end of the current ACL statement. If you want to preserve
10669 these values for longer, you can save them in ACL variables.
10670
10671 .vitem &$address_file$&
10672 .vindex "&$address_file$&"
10673 When, as a result of aliasing, forwarding, or filtering, a message is directed
10674 to a specific file, this variable holds the name of the file when the transport
10675 is running. At other times, the variable is empty. For example, using the
10676 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10677 .code
10678 /home/r2d2/savemail
10679 .endd
10680 then when the &(address_file)& transport is running, &$address_file$&
10681 contains the text string &`/home/r2d2/savemail`&.
10682 .cindex "Sieve filter" "value of &$address_file$&"
10683 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10684 then up to the transport configuration to generate an appropriate absolute path
10685 to the relevant file.
10686
10687 .vitem &$address_pipe$&
10688 .vindex "&$address_pipe$&"
10689 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10690 this variable holds the pipe command when the transport is running.
10691
10692 .vitem "&$auth1$& &-- &$auth3$&"
10693 .vindex "&$auth1$&, &$auth2$&, etc"
10694 These variables are used in SMTP authenticators (see chapters
10695 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10696
10697 .vitem &$authenticated_id$&
10698 .cindex "authentication" "id"
10699 .vindex "&$authenticated_id$&"
10700 When a server successfully authenticates a client it may be configured to
10701 preserve some of the authentication information in the variable
10702 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10703 user/password authenticator configuration might preserve the user name for use
10704 in the routers. Note that this is not the same information that is saved in
10705 &$sender_host_authenticated$&.
10706 When a message is submitted locally (that is, not over a TCP connection)
10707 the value of &$authenticated_id$& is normally the login name of the calling
10708 process. However, a trusted user can override this by means of the &%-oMai%&
10709 command line option.
10710
10711
10712
10713
10714 .vitem &$authenticated_sender$&
10715 .cindex "sender" "authenticated"
10716 .cindex "authentication" "sender"
10717 .cindex "AUTH" "on MAIL command"
10718 .vindex "&$authenticated_sender$&"
10719 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10720 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10721 described in section &<<SECTauthparamail>>&. Unless the data is the string
10722 &"<>"&, it is set as the authenticated sender of the message, and the value is
10723 available during delivery in the &$authenticated_sender$& variable. If the
10724 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10725
10726 .vindex "&$qualify_domain$&"
10727 When a message is submitted locally (that is, not over a TCP connection), the
10728 value of &$authenticated_sender$& is an address constructed from the login
10729 name of the calling process and &$qualify_domain$&, except that a trusted user
10730 can override this by means of the &%-oMas%& command line option.
10731
10732
10733 .vitem &$authentication_failed$&
10734 .cindex "authentication" "failure"
10735 .vindex "&$authentication_failed$&"
10736 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10737 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10738 possible to distinguish between &"did not try to authenticate"&
10739 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10740 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10741 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10742 negative response to an AUTH command, including (for example) an attempt to use
10743 an undefined mechanism.
10744
10745 .new
10746 .vitem &$av_failed$&
10747 .cindex "content scanning" "AV scanner failure"
10748 This variable is available when Exim is compiled with the content-scanning
10749 extension. It is set to &"0"& by default, but will be set to &"1"& if any
10750 problem occurs with the virus scanner (specified by &%av_scanner%&) during
10751 the ACL malware condition.
10752 .wen
10753
10754 .vitem &$body_linecount$&
10755 .cindex "message body" "line count"
10756 .cindex "body of message" "line count"
10757 .vindex "&$body_linecount$&"
10758 When a message is being received or delivered, this variable contains the
10759 number of lines in the message's body. See also &$message_linecount$&.
10760
10761 .vitem &$body_zerocount$&
10762 .cindex "message body" "binary zero count"
10763 .cindex "body of message" "binary zero count"
10764 .cindex "binary zero" "in message body"
10765 .vindex "&$body_zerocount$&"
10766 When a message is being received or delivered, this variable contains the
10767 number of binary zero bytes (ASCII NULs) in the message's body.
10768
10769 .vitem &$bounce_recipient$&
10770 .vindex "&$bounce_recipient$&"
10771 This is set to the recipient address of a bounce message while Exim is creating
10772 it. It is useful if a customized bounce message text file is in use (see
10773 chapter &<<CHAPemsgcust>>&).
10774
10775 .vitem &$bounce_return_size_limit$&
10776 .vindex "&$bounce_return_size_limit$&"
10777 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10778 up to a multiple of 1000. It is useful when a customized error message text
10779 file is in use (see chapter &<<CHAPemsgcust>>&).
10780
10781 .vitem &$caller_gid$&
10782 .cindex "gid (group id)" "caller"
10783 .vindex "&$caller_gid$&"
10784 The real group id under which the process that called Exim was running. This is
10785 not the same as the group id of the originator of a message (see
10786 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10787 incarnation normally contains the Exim gid.
10788
10789 .vitem &$caller_uid$&
10790 .cindex "uid (user id)" "caller"
10791 .vindex "&$caller_uid$&"
10792 The real user id under which the process that called Exim was running. This is
10793 not the same as the user id of the originator of a message (see
10794 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10795 incarnation normally contains the Exim uid.
10796
10797 .vitem &$compile_date$&
10798 .vindex "&$compile_date$&"
10799 The date on which the Exim binary was compiled.
10800
10801 .vitem &$compile_number$&
10802 .vindex "&$compile_number$&"
10803 The building process for Exim keeps a count of the number
10804 of times it has been compiled. This serves to distinguish different
10805 compilations of the same version of the program.
10806
10807 .vitem &$demime_errorlevel$&
10808 .vindex "&$demime_errorlevel$&"
10809 This variable is available when Exim is compiled with
10810 the content-scanning extension and the obsolete &%demime%& condition. For
10811 details, see section &<<SECTdemimecond>>&.
10812
10813 .vitem &$demime_reason$&
10814 .vindex "&$demime_reason$&"
10815 This variable is available when Exim is compiled with the
10816 content-scanning extension and the obsolete &%demime%& condition. For details,
10817 see section &<<SECTdemimecond>>&.
10818
10819 .vitem &$dnslist_domain$& &&&
10820        &$dnslist_matched$& &&&
10821        &$dnslist_text$& &&&
10822        &$dnslist_value$&
10823 .vindex "&$dnslist_domain$&"
10824 .vindex "&$dnslist_matched$&"
10825 .vindex "&$dnslist_text$&"
10826 .vindex "&$dnslist_value$&"
10827 .cindex "black list (DNS)"
10828 When a DNS (black) list lookup succeeds, these variables are set to contain
10829 the following data from the lookup: the list's domain name, the key that was
10830 looked up, the contents of any associated TXT record, and the value from the
10831 main A record. See section &<<SECID204>>& for more details.
10832
10833 .vitem &$domain$&
10834 .vindex "&$domain$&"
10835 When an address is being routed, or delivered on its own, this variable
10836 contains the domain. Uppercase letters in the domain are converted into lower
10837 case for &$domain$&.
10838
10839 Global address rewriting happens when a message is received, so the value of
10840 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10841 is set during user filtering, but not during system filtering, because a
10842 message may have many recipients and the system filter is called just once.
10843
10844 When more than one address is being delivered at once (for example, several
10845 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10846 have the same domain. Transports can be restricted to handling only one domain
10847 at a time if the value of &$domain$& is required at transport time &-- this is
10848 the default for local transports. For further details of the environment in
10849 which local transports are run, see chapter &<<CHAPenvironment>>&.
10850
10851 .oindex "&%delay_warning_condition%&"
10852 At the end of a delivery, if all deferred addresses have the same domain, it is
10853 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10854
10855 The &$domain$& variable is also used in some other circumstances:
10856
10857 .ilist
10858 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10859 the recipient address. The domain of the &'sender'& address is in
10860 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10861 normally set during the running of the MAIL ACL. However, if the sender address
10862 is verified with a callout during the MAIL ACL, the sender domain is placed in
10863 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10864 the &(smtp)& transport.
10865
10866 .next
10867 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10868 &$domain$& contains the domain portion of the address that is being rewritten;
10869 it can be used in the expansion of the replacement address, for example, to
10870 rewrite domains by file lookup.
10871
10872 .next
10873 With one important exception, whenever a domain list is being scanned,
10874 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10875 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10876 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10877 that, in a RCPT ACL, the sender domain list can be dependent on the
10878 recipient domain (which is what is in &$domain$& at this time).
10879
10880 .next
10881 .cindex "ETRN" "value of &$domain$&"
10882 .oindex "&%smtp_etrn_command%&"
10883 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10884 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10885 .endlist
10886
10887
10888 .vitem &$domain_data$&
10889 .vindex "&$domain_data$&"
10890 When the &%domains%& option on a router matches a domain by
10891 means of a lookup, the data read by the lookup is available during the running
10892 of the router as &$domain_data$&. In addition, if the driver routes the
10893 address to a transport, the value is available in that transport. If the
10894 transport is handling multiple addresses, the value from the first address is
10895 used.
10896
10897 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10898 domain by means of a lookup. The data read by the lookup is available during
10899 the rest of the ACL statement. In all other situations, this variable expands
10900 to nothing.
10901
10902 .vitem &$exim_gid$&
10903 .vindex "&$exim_gid$&"
10904 This variable contains the numerical value of the Exim group id.
10905
10906 .vitem &$exim_path$&
10907 .vindex "&$exim_path$&"
10908 This variable contains the path to the Exim binary.
10909
10910 .vitem &$exim_uid$&
10911 .vindex "&$exim_uid$&"
10912 This variable contains the numerical value of the Exim user id.
10913
10914 .vitem &$found_extension$&
10915 .vindex "&$found_extension$&"
10916 This variable is available when Exim is compiled with the
10917 content-scanning extension and the obsolete &%demime%& condition. For details,
10918 see section &<<SECTdemimecond>>&.
10919
10920 .vitem &$header_$&<&'name'&>
10921 This is not strictly an expansion variable. It is expansion syntax for
10922 inserting the message header line with the given name. Note that the name must
10923 be terminated by colon or white space, because it may contain a wide variety of
10924 characters. Note also that braces must &'not'& be used.
10925
10926 .vitem &$home$&
10927 .vindex "&$home$&"
10928 When the &%check_local_user%& option is set for a router, the user's home
10929 directory is placed in &$home$& when the check succeeds. In particular, this
10930 means it is set during the running of users' filter files. A router may also
10931 explicitly set a home directory for use by a transport; this can be overridden
10932 by a setting on the transport itself.
10933
10934 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10935 of the environment variable HOME.
10936
10937 .vitem &$host$&
10938 .vindex "&$host$&"
10939 If a router assigns an address to a transport (any transport), and passes a
10940 list of hosts with the address, the value of &$host$& when the transport starts
10941 to run is the name of the first host on the list. Note that this applies both
10942 to local and remote transports.
10943
10944 .cindex "transport" "filter"
10945 .cindex "filter" "transport filter"
10946 For the &(smtp)& transport, if there is more than one host, the value of
10947 &$host$& changes as the transport works its way through the list. In
10948 particular, when the &(smtp)& transport is expanding its options for encryption
10949 using TLS, or for specifying a transport filter (see chapter
10950 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10951 is connected.
10952
10953 When used in the client part of an authenticator configuration (see chapter
10954 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10955 client is connected.
10956
10957
10958 .vitem &$host_address$&
10959 .vindex "&$host_address$&"
10960 This variable is set to the remote host's IP address whenever &$host$& is set
10961 for a remote connection. It is also set to the IP address that is being checked
10962 when the &%ignore_target_hosts%& option is being processed.
10963
10964 .vitem &$host_data$&
10965 .vindex "&$host_data$&"
10966 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10967 result of the lookup is made available in the &$host_data$& variable. This
10968 allows you, for example, to do things like this:
10969 .code
10970 deny  hosts = net-lsearch;/some/file
10971 message = $host_data
10972 .endd
10973 .vitem &$host_lookup_deferred$&
10974 .cindex "host name" "lookup, failure of"
10975 .vindex "&$host_lookup_deferred$&"
10976 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10977 message comes from a remote host and there is an attempt to look up the host's
10978 name from its IP address, and the attempt is not successful, one of these
10979 variables is set to &"1"&.
10980
10981 .ilist
10982 If the lookup receives a definite negative response (for example, a DNS lookup
10983 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10984
10985 .next
10986 If there is any kind of problem during the lookup, such that Exim cannot
10987 tell whether or not the host name is defined (for example, a timeout for a DNS
10988 lookup), &$host_lookup_deferred$& is set to &"1"&.
10989 .endlist ilist
10990
10991 Looking up a host's name from its IP address consists of more than just a
10992 single reverse lookup. Exim checks that a forward lookup of at least one of the
10993 names it receives from a reverse lookup yields the original IP address. If this
10994 is not the case, Exim does not accept the looked up name(s), and
10995 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10996 IP address (for example, the existence of a PTR record in the DNS) is not
10997 sufficient on its own for the success of a host name lookup. If the reverse
10998 lookup succeeds, but there is a lookup problem such as a timeout when checking
10999 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11000 &"1"&. See also &$sender_host_name$&.
11001
11002 .vitem &$host_lookup_failed$&
11003 .vindex "&$host_lookup_failed$&"
11004 See &$host_lookup_deferred$&.
11005
11006
11007 .vitem &$inode$&
11008 .vindex "&$inode$&"
11009 The only time this variable is set is while expanding the &%directory_file%&
11010 option in the &(appendfile)& transport. The variable contains the inode number
11011 of the temporary file which is about to be renamed. It can be used to construct
11012 a unique name for the file.
11013
11014 .vitem &$interface_address$&
11015 .vindex "&$interface_address$&"
11016 This is an obsolete name for &$received_ip_address$&.
11017
11018 .vitem &$interface_port$&
11019 .vindex "&$interface_port$&"
11020 This is an obsolete name for &$received_port$&.
11021
11022 .vitem &$item$&
11023 .vindex "&$item$&"
11024 This variable is used during the expansion of &*forall*& and &*forany*&
11025 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11026 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11027 empty.
11028
11029 .vitem &$ldap_dn$&
11030 .vindex "&$ldap_dn$&"
11031 This variable, which is available only when Exim is compiled with LDAP support,
11032 contains the DN from the last entry in the most recently successful LDAP
11033 lookup.
11034
11035 .vitem &$load_average$&
11036 .vindex "&$load_average$&"
11037 This variable contains the system load average, multiplied by 1000 so that it
11038 is an integer. For example, if the load average is 0.21, the value of the
11039 variable is 210. The value is recomputed every time the variable is referenced.
11040
11041 .vitem &$local_part$&
11042 .vindex "&$local_part$&"
11043 When an address is being routed, or delivered on its own, this
11044 variable contains the local part. When a number of addresses are being
11045 delivered together (for example, multiple RCPT commands in an SMTP
11046 session), &$local_part$& is not set.
11047
11048 Global address rewriting happens when a message is received, so the value of
11049 &$local_part$& during routing and delivery is the value after rewriting.
11050 &$local_part$& is set during user filtering, but not during system filtering,
11051 because a message may have many recipients and the system filter is called just
11052 once.
11053
11054 .vindex "&$local_part_prefix$&"
11055 .vindex "&$local_part_suffix$&"
11056 If a local part prefix or suffix has been recognized, it is not included in the
11057 value of &$local_part$& during routing and subsequent delivery. The values of
11058 any prefix or suffix are in &$local_part_prefix$& and
11059 &$local_part_suffix$&, respectively.
11060
11061 When a message is being delivered to a file, pipe, or autoreply transport as a
11062 result of aliasing or forwarding, &$local_part$& is set to the local part of
11063 the parent address, not to the file name or command (see &$address_file$& and
11064 &$address_pipe$&).
11065
11066 When an ACL is running for a RCPT command, &$local_part$& contains the
11067 local part of the recipient address.
11068
11069 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11070 &$local_part$& contains the local part of the address that is being rewritten;
11071 it can be used in the expansion of the replacement address, for example.
11072
11073 In all cases, all quoting is removed from the local part. For example, for both
11074 the addresses
11075 .code
11076 "abc:xyz"@test.example
11077 abc\:xyz@test.example
11078 .endd
11079 the value of &$local_part$& is
11080 .code
11081 abc:xyz
11082 .endd
11083 If you use &$local_part$& to create another address, you should always wrap it
11084 inside a quoting operator. For example, in a &(redirect)& router you could
11085 have:
11086 .code
11087 data = ${quote_local_part:$local_part}@new.domain.example
11088 .endd
11089 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11090 to process local parts in a case-dependent manner in a router, you can set the
11091 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11092
11093 .vitem &$local_part_data$&
11094 .vindex "&$local_part_data$&"
11095 When the &%local_parts%& option on a router matches a local part by means of a
11096 lookup, the data read by the lookup is available during the running of the
11097 router as &$local_part_data$&. In addition, if the driver routes the address
11098 to a transport, the value is available in that transport. If the transport is
11099 handling multiple addresses, the value from the first address is used.
11100
11101 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11102 matches a local part by means of a lookup. The data read by the lookup is
11103 available during the rest of the ACL statement. In all other situations, this
11104 variable expands to nothing.
11105
11106 .vitem &$local_part_prefix$&
11107 .vindex "&$local_part_prefix$&"
11108 When an address is being routed or delivered, and a
11109 specific prefix for the local part was recognized, it is available in this
11110 variable, having been removed from &$local_part$&.
11111
11112 .vitem &$local_part_suffix$&
11113 .vindex "&$local_part_suffix$&"
11114 When an address is being routed or delivered, and a
11115 specific suffix for the local part was recognized, it is available in this
11116 variable, having been removed from &$local_part$&.
11117
11118 .vitem &$local_scan_data$&
11119 .vindex "&$local_scan_data$&"
11120 This variable contains the text returned by the &[local_scan()]& function when
11121 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11122
11123 .vitem &$local_user_gid$&
11124 .vindex "&$local_user_gid$&"
11125 See &$local_user_uid$&.
11126
11127 .vitem &$local_user_uid$&
11128 .vindex "&$local_user_uid$&"
11129 This variable and &$local_user_gid$& are set to the uid and gid after the
11130 &%check_local_user%& router precondition succeeds. This means that their values
11131 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11132 and &%condition%&), for the &%address_data%& expansion, and for any
11133 router-specific expansions. At all other times, the values in these variables
11134 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11135
11136 .vitem &$localhost_number$&
11137 .vindex "&$localhost_number$&"
11138 This contains the expanded value of the
11139 &%localhost_number%& option. The expansion happens after the main options have
11140 been read.
11141
11142 .vitem &$log_inodes$&
11143 .vindex "&$log_inodes$&"
11144 The number of free inodes in the disk partition where Exim's
11145 log files are being written. The value is recalculated whenever the variable is
11146 referenced. If the relevant file system does not have the concept of inodes,
11147 the value of is -1. See also the &%check_log_inodes%& option.
11148
11149 .vitem &$log_space$&
11150 .vindex "&$log_space$&"
11151 The amount of free space (as a number of kilobytes) in the disk
11152 partition where Exim's log files are being written. The value is recalculated
11153 whenever the variable is referenced. If the operating system does not have the
11154 ability to find the amount of free space (only true for experimental systems),
11155 the space value is -1. See also the &%check_log_space%& option.
11156
11157
11158 .vitem &$mailstore_basename$&
11159 .vindex "&$mailstore_basename$&"
11160 This variable is set only when doing deliveries in &"mailstore"& format in the
11161 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11162 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11163 contains the basename of the files that are being written, that is, the name
11164 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11165 variable is empty.
11166
11167 .vitem &$malware_name$&
11168 .vindex "&$malware_name$&"
11169 This variable is available when Exim is compiled with the
11170 content-scanning extension. It is set to the name of the virus that was found
11171 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11172
11173 .vitem &$max_received_linelength$&
11174 .vindex "&$max_received_linelength$&"
11175 .cindex "maximum" "line length"
11176 .cindex "line length" "maximum"
11177 This variable contains the number of bytes in the longest line that was
11178 received as part of the message, not counting the line termination
11179 character(s).
11180
11181 .vitem &$message_age$&
11182 .cindex "message" "age of"
11183 .vindex "&$message_age$&"
11184 This variable is set at the start of a delivery attempt to contain the number
11185 of seconds since the message was received. It does not change during a single
11186 delivery attempt.
11187
11188 .vitem &$message_body$&
11189 .cindex "body of message" "expansion variable"
11190 .cindex "message body" "in expansion"
11191 .cindex "binary zero" "in message body"
11192 .vindex "&$message_body$&"
11193 .oindex "&%message_body_visible%&"
11194 This variable contains the initial portion of a message's body while it is
11195 being delivered, and is intended mainly for use in filter files. The maximum
11196 number of characters of the body that are put into the variable is set by the
11197 &%message_body_visible%& configuration option; the default is 500.
11198
11199 .oindex "&%message_body_newlines%&"
11200 By default, newlines are converted into spaces in &$message_body$&, to make it
11201 easier to search for phrases that might be split over a line break. However,
11202 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11203 zeros are always converted into spaces.
11204
11205 .vitem &$message_body_end$&
11206 .cindex "body of message" "expansion variable"
11207 .cindex "message body" "in expansion"
11208 .vindex "&$message_body_end$&"
11209 This variable contains the final portion of a message's
11210 body while it is being delivered. The format and maximum size are as for
11211 &$message_body$&.
11212
11213 .vitem &$message_body_size$&
11214 .cindex "body of message" "size"
11215 .cindex "message body" "size"
11216 .vindex "&$message_body_size$&"
11217 When a message is being delivered, this variable contains the size of the body
11218 in bytes. The count starts from the character after the blank line that
11219 separates the body from the header. Newlines are included in the count. See
11220 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11221
11222 .vitem &$message_exim_id$&
11223 .vindex "&$message_exim_id$&"
11224 When a message is being received or delivered, this variable contains the
11225 unique message id that is generated and used by Exim to identify the message.
11226 An id is not created for a message until after its header has been successfully
11227 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11228 line; it is the local id that Exim assigns to the message, for example:
11229 &`1BXTIK-0001yO-VA`&.
11230
11231 .vitem &$message_headers$&
11232 .vindex &$message_headers$&
11233 This variable contains a concatenation of all the header lines when a message
11234 is being processed, except for lines added by routers or transports. The header
11235 lines are separated by newline characters. Their contents are decoded in the
11236 same way as a header line that is inserted by &%bheader%&.
11237
11238 .vitem &$message_headers_raw$&
11239 .vindex &$message_headers_raw$&
11240 This variable is like &$message_headers$& except that no processing of the
11241 contents of header lines is done.
11242
11243 .vitem &$message_id$&
11244 This is an old name for &$message_exim_id$&, which is now deprecated.
11245
11246 .vitem &$message_linecount$&
11247 .vindex "&$message_linecount$&"
11248 This variable contains the total number of lines in the header and body of the
11249 message. Compare &$body_linecount$&, which is the count for the body only.
11250 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11251 number of lines received. Before delivery happens (that is, before filters,
11252 routers, and transports run) the count is increased to include the
11253 &'Received:'& header line that Exim standardly adds, and also any other header
11254 lines that are added by ACLs. The blank line that separates the message header
11255 from the body is not counted.
11256
11257 As with the special case of &$message_size$&, during the expansion of the
11258 appendfile transport's maildir_tag option in maildir format, the value of
11259 &$message_linecount$& is the precise size of the number of newlines in the
11260 file that has been written (minus one for the blank line between the
11261 header and the body).
11262
11263 Here is an example of the use of this variable in a DATA ACL:
11264 .code
11265 deny message   = Too many lines in message header
11266      condition = \
11267       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11268 .endd
11269 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11270 message has not yet been received.
11271
11272 .vitem &$message_size$&
11273 .cindex "size" "of message"
11274 .cindex "message" "size"
11275 .vindex "&$message_size$&"
11276 When a message is being processed, this variable contains its size in bytes. In
11277 most cases, the size includes those headers that were received with the
11278 message, but not those (such as &'Envelope-to:'&) that are added to individual
11279 deliveries as they are written. However, there is one special case: during the
11280 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11281 doing a delivery in maildir format, the value of &$message_size$& is the
11282 precise size of the file that has been written. See also
11283 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11284
11285 .cindex "RCPT" "value of &$message_size$&"
11286 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11287 contains the size supplied on the MAIL command, or -1 if no size was given. The
11288 value may not, of course, be truthful.
11289
11290 .vitem &$mime_$&&'xxx'&
11291 A number of variables whose names start with &$mime$& are
11292 available when Exim is compiled with the content-scanning extension. For
11293 details, see section &<<SECTscanmimepart>>&.
11294
11295 .vitem "&$n0$& &-- &$n9$&"
11296 These variables are counters that can be incremented by means
11297 of the &%add%& command in filter files.
11298
11299 .vitem &$original_domain$&
11300 .vindex "&$domain$&"
11301 .vindex "&$original_domain$&"
11302 When a top-level address is being processed for delivery, this contains the
11303 same value as &$domain$&. However, if a &"child"& address (for example,
11304 generated by an alias, forward, or filter file) is being processed, this
11305 variable contains the domain of the original address (lower cased). This
11306 differs from &$parent_domain$& only when there is more than one level of
11307 aliasing or forwarding. When more than one address is being delivered in a
11308 single transport run, &$original_domain$& is not set.
11309
11310 If a new address is created by means of a &%deliver%& command in a system
11311 filter, it is set up with an artificial &"parent"& address. This has the local
11312 part &'system-filter'& and the default qualify domain.
11313
11314 .vitem &$original_local_part$&
11315 .vindex "&$local_part$&"
11316 .vindex "&$original_local_part$&"
11317 When a top-level address is being processed for delivery, this contains the
11318 same value as &$local_part$&, unless a prefix or suffix was removed from the
11319 local part, because &$original_local_part$& always contains the full local
11320 part. When a &"child"& address (for example, generated by an alias, forward, or
11321 filter file) is being processed, this variable contains the full local part of
11322 the original address.
11323
11324 If the router that did the redirection processed the local part
11325 case-insensitively, the value in &$original_local_part$& is in lower case.
11326 This variable differs from &$parent_local_part$& only when there is more than
11327 one level of aliasing or forwarding. When more than one address is being
11328 delivered in a single transport run, &$original_local_part$& is not set.
11329
11330 If a new address is created by means of a &%deliver%& command in a system
11331 filter, it is set up with an artificial &"parent"& address. This has the local
11332 part &'system-filter'& and the default qualify domain.
11333
11334 .vitem &$originator_gid$&
11335 .cindex "gid (group id)" "of originating user"
11336 .cindex "sender" "gid"
11337 .vindex "&$caller_gid$&"
11338 .vindex "&$originator_gid$&"
11339 This variable contains the value of &$caller_gid$& that was set when the
11340 message was received. For messages received via the command line, this is the
11341 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11342 normally the gid of the Exim user.
11343
11344 .vitem &$originator_uid$&
11345 .cindex "uid (user id)" "of originating user"
11346 .cindex "sender" "uid"
11347 .vindex "&$caller_uid$&"
11348 .vindex "&$originaltor_uid$&"
11349 The value of &$caller_uid$& that was set when the message was received. For
11350 messages received via the command line, this is the uid of the sending user.
11351 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11352 user.
11353
11354 .vitem &$parent_domain$&
11355 .vindex "&$parent_domain$&"
11356 This variable is similar to &$original_domain$& (see
11357 above), except that it refers to the immediately preceding parent address.
11358
11359 .vitem &$parent_local_part$&
11360 .vindex "&$parent_local_part$&"
11361 This variable is similar to &$original_local_part$&
11362 (see above), except that it refers to the immediately preceding parent address.
11363
11364 .vitem &$pid$&
11365 .cindex "pid (process id)" "of current process"
11366 .vindex "&$pid$&"
11367 This variable contains the current process id.
11368
11369 .vitem &$pipe_addresses$&
11370 .cindex "filter" "transport filter"
11371 .cindex "transport" "filter"
11372 .vindex "&$pipe_addresses$&"
11373 This is not an expansion variable, but is mentioned here because the string
11374 &`$pipe_addresses`& is handled specially in the command specification for the
11375 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11376 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11377 It cannot be used in general expansion strings, and provokes an &"unknown
11378 variable"& error if encountered.
11379
11380 .vitem &$primary_hostname$&
11381 .vindex "&$primary_hostname$&"
11382 This variable contains the value set by &%primary_hostname%& in the
11383 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11384 a single-component name, Exim calls &[gethostbyname()]& (or
11385 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11386 qualified host name. See also &$smtp_active_hostname$&.
11387
11388
11389 .vitem &$prvscheck_address$&
11390 This variable is used in conjunction with the &%prvscheck%& expansion item,
11391 which is described in sections &<<SECTexpansionitems>>& and
11392 &<<SECTverifyPRVS>>&.
11393
11394 .vitem &$prvscheck_keynum$&
11395 This variable is used in conjunction with the &%prvscheck%& expansion item,
11396 which is described in sections &<<SECTexpansionitems>>& and
11397 &<<SECTverifyPRVS>>&.
11398
11399 .vitem &$prvscheck_result$&
11400 This variable is used in conjunction with the &%prvscheck%& expansion item,
11401 which is described in sections &<<SECTexpansionitems>>& and
11402 &<<SECTverifyPRVS>>&.
11403
11404 .vitem &$qualify_domain$&
11405 .vindex "&$qualify_domain$&"
11406 The value set for the &%qualify_domain%& option in the configuration file.
11407
11408 .vitem &$qualify_recipient$&
11409 .vindex "&$qualify_recipient$&"
11410 The value set for the &%qualify_recipient%& option in the configuration file,
11411 or if not set, the value of &$qualify_domain$&.
11412
11413 .vitem &$rcpt_count$&
11414 .vindex "&$rcpt_count$&"
11415 When a message is being received by SMTP, this variable contains the number of
11416 RCPT commands received for the current message. If this variable is used in a
11417 RCPT ACL, its value includes the current command.
11418
11419 .vitem &$rcpt_defer_count$&
11420 .vindex "&$rcpt_defer_count$&"
11421 .cindex "4&'xx'& responses" "count of"
11422 When a message is being received by SMTP, this variable contains the number of
11423 RCPT commands in the current message that have previously been rejected with a
11424 temporary (4&'xx'&) response.
11425
11426 .vitem &$rcpt_fail_count$&
11427 .vindex "&$rcpt_fail_count$&"
11428 When a message is being received by SMTP, this variable contains the number of
11429 RCPT commands in the current message that have previously been rejected with a
11430 permanent (5&'xx'&) response.
11431
11432 .vitem &$received_count$&
11433 .vindex "&$received_count$&"
11434 This variable contains the number of &'Received:'& header lines in the message,
11435 including the one added by Exim (so its value is always greater than zero). It
11436 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11437 delivering.
11438
11439 .vitem &$received_for$&
11440 .vindex "&$received_for$&"
11441 If there is only a single recipient address in an incoming message, this
11442 variable contains that address when the &'Received:'& header line is being
11443 built. The value is copied after recipient rewriting has happened, but before
11444 the &[local_scan()]& function is run.
11445
11446 .vitem &$received_ip_address$&
11447 .vindex "&$received_ip_address$&"
11448 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11449 variable is set to the address of the local IP interface, and &$received_port$&
11450 is set to the local port number. (The remote IP address and port are in
11451 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11452 the port value is -1 unless it has been set using the &%-oMi%& command line
11453 option.
11454
11455 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11456 could be used, for example, to make the file name for a TLS certificate depend
11457 on which interface and/or port is being used for the incoming connection. The
11458 values of &$received_ip_address$& and &$received_port$& are saved with any
11459 messages that are received, thus making these variables available at delivery
11460 time.
11461
11462 &*Note:*& There are no equivalent variables for outgoing connections, because
11463 the values are unknown (unless they are explicitly set by options of the
11464 &(smtp)& transport).
11465
11466 .vitem &$received_port$&
11467 .vindex "&$received_port$&"
11468 See &$received_ip_address$&.
11469
11470 .vitem &$received_protocol$&
11471 .vindex "&$received_protocol$&"
11472 When a message is being processed, this variable contains the name of the
11473 protocol by which it was received. Most of the names used by Exim are defined
11474 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11475 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11476 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11477 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11478 connection and the client was successfully authenticated.
11479
11480 Exim uses the protocol name &"smtps"& for the case when encryption is
11481 automatically set up on connection without the use of STARTTLS (see
11482 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11483 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11484 where the client initially uses EHLO, sets up an encrypted connection using
11485 STARTTLS, and then uses HELO afterwards.
11486
11487 The &%-oMr%& option provides a way of specifying a custom protocol name for
11488 messages that are injected locally by trusted callers. This is commonly used to
11489 identify messages that are being re-injected after some kind of scanning.
11490
11491 .vitem &$received_time$&
11492 .vindex "&$received_time$&"
11493 This variable contains the date and time when the current message was received,
11494 as a number of seconds since the start of the Unix epoch.
11495
11496 .vitem &$recipient_data$&
11497 .vindex "&$recipient_data$&"
11498 This variable is set after an indexing lookup success in an ACL &%recipients%&
11499 condition. It contains the data from the lookup, and the value remains set
11500 until the next &%recipients%& test. Thus, you can do things like this:
11501 .display
11502 &`require recipients  = cdb*@;/some/file`&
11503 &`deny    `&&'some further test involving'& &`$recipient_data`&
11504 .endd
11505 &*Warning*&: This variable is set only when a lookup is used as an indexing
11506 method in the address list, using the semicolon syntax as in the example above.
11507 The variable is not set for a lookup that is used as part of the string
11508 expansion that all such lists undergo before being interpreted.
11509
11510 .vitem &$recipient_verify_failure$&
11511 .vindex "&$recipient_verify_failure$&"
11512 In an ACL, when a recipient verification fails, this variable contains
11513 information about the failure. It is set to one of the following words:
11514
11515 .ilist
11516 &"qualify"&: The address was unqualified (no domain), and the message
11517 was neither local nor came from an exempted host.
11518
11519 .next
11520 &"route"&: Routing failed.
11521
11522 .next
11523 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11524 or before the MAIL command (that is, on initial connection, HELO, or
11525 MAIL).
11526
11527 .next
11528 &"recipient"&: The RCPT command in a callout was rejected.
11529 .next
11530
11531 &"postmaster"&: The postmaster check in a callout was rejected.
11532 .endlist
11533
11534 The main use of this variable is expected to be to distinguish between
11535 rejections of MAIL and rejections of RCPT.
11536
11537 .vitem &$recipients$&
11538 .vindex "&$recipients$&"
11539 This variable contains a list of envelope recipients for a message. A comma and
11540 a space separate the addresses in the replacement text. However, the variable
11541 is not generally available, to prevent exposure of Bcc recipients in
11542 unprivileged users' filter files. You can use &$recipients$& only in these
11543 cases:
11544
11545 .olist
11546 In a system filter file.
11547 .next
11548 In the ACLs associated with the DATA command and with non-SMTP messages, that
11549 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11550 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11551 &%acl_not_smtp_mime%&.
11552 .next
11553 From within a &[local_scan()]& function.
11554 .endlist
11555
11556
11557 .vitem &$recipients_count$&
11558 .vindex "&$recipients_count$&"
11559 When a message is being processed, this variable contains the number of
11560 envelope recipients that came with the message. Duplicates are not excluded
11561 from the count. While a message is being received over SMTP, the number
11562 increases for each accepted recipient. It can be referenced in an ACL.
11563
11564
11565 .vitem &$regex_match_string$&
11566 .vindex "&$regex_match_string$&"
11567 This variable is set to contain the matching regular expression after a
11568 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11569
11570
11571 .vitem &$reply_address$&
11572 .vindex "&$reply_address$&"
11573 When a message is being processed, this variable contains the contents of the
11574 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11575 contents of the &'From:'& header line. Apart from the removal of leading
11576 white space, the value is not processed in any way. In particular, no RFC 2047
11577 decoding or character code translation takes place.
11578
11579 .vitem &$return_path$&
11580 .vindex "&$return_path$&"
11581 When a message is being delivered, this variable contains the return path &--
11582 the sender field that will be sent as part of the envelope. It is not enclosed
11583 in <> characters. At the start of routing an address, &$return_path$& has the
11584 same value as &$sender_address$&, but if, for example, an incoming message to a
11585 mailing list has been expanded by a router which specifies a different address
11586 for bounce messages, &$return_path$& subsequently contains the new bounce
11587 address, whereas &$sender_address$& always contains the original sender address
11588 that was received with the message. In other words, &$sender_address$& contains
11589 the incoming envelope sender, and &$return_path$& contains the outgoing
11590 envelope sender.
11591
11592 .vitem &$return_size_limit$&
11593 .vindex "&$return_size_limit$&"
11594 This is an obsolete name for &$bounce_return_size_limit$&.
11595
11596 .vitem &$runrc$&
11597 .cindex "return code" "from &%run%& expansion"
11598 .vindex "&$runrc$&"
11599 This variable contains the return code from a command that is run by the
11600 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11601 assume the order in which option values are expanded, except for those
11602 preconditions whose order of testing is documented. Therefore, you cannot
11603 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11604 another.
11605
11606 .vitem &$self_hostname$&
11607 .oindex "&%self%&" "value of host name"
11608 .vindex "&$self_hostname$&"
11609 When an address is routed to a supposedly remote host that turns out to be the
11610 local host, what happens is controlled by the &%self%& generic router option.
11611 One of its values causes the address to be passed to another router. When this
11612 happens, &$self_hostname$& is set to the name of the local host that the
11613 original router encountered. In other circumstances its contents are null.
11614
11615 .vitem &$sender_address$&
11616 .vindex "&$sender_address$&"
11617 When a message is being processed, this variable contains the sender's address
11618 that was received in the message's envelope. The case of letters in the address
11619 is retained, in both the local part and the domain. For bounce messages, the
11620 value of this variable is the empty string. See also &$return_path$&.
11621
11622 .vitem &$sender_address_data$&
11623 .vindex "&$address_data$&"
11624 .vindex "&$sender_address_data$&"
11625 If &$address_data$& is set when the routers are called from an ACL to verify a
11626 sender address, the final value is preserved in &$sender_address_data$&, to
11627 distinguish it from data from a recipient address. The value does not persist
11628 after the end of the current ACL statement. If you want to preserve it for
11629 longer, you can save it in an ACL variable.
11630
11631 .vitem &$sender_address_domain$&
11632 .vindex "&$sender_address_domain$&"
11633 The domain portion of &$sender_address$&.
11634
11635 .vitem &$sender_address_local_part$&
11636 .vindex "&$sender_address_local_part$&"
11637 The local part portion of &$sender_address$&.
11638
11639 .vitem &$sender_data$&
11640 .vindex "&$sender_data$&"
11641 This variable is set after a lookup success in an ACL &%senders%& condition or
11642 in a router &%senders%& option. It contains the data from the lookup, and the
11643 value remains set until the next &%senders%& test. Thus, you can do things like
11644 this:
11645 .display
11646 &`require senders      = cdb*@;/some/file`&
11647 &`deny    `&&'some further test involving'& &`$sender_data`&
11648 .endd
11649 &*Warning*&: This variable is set only when a lookup is used as an indexing
11650 method in the address list, using the semicolon syntax as in the example above.
11651 The variable is not set for a lookup that is used as part of the string
11652 expansion that all such lists undergo before being interpreted.
11653
11654 .vitem &$sender_fullhost$&
11655 .vindex "&$sender_fullhost$&"
11656 When a message is received from a remote host, this variable contains the host
11657 name and IP address in a single string. It ends with the IP address in square
11658 brackets, followed by a colon and a port number if the logging of ports is
11659 enabled. The format of the rest of the string depends on whether the host
11660 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11661 looking up its IP address. (Looking up the IP address can be forced by the
11662 &%host_lookup%& option, independent of verification.) A plain host name at the
11663 start of the string is a verified host name; if this is not present,
11664 verification either failed or was not requested. A host name in parentheses is
11665 the argument of a HELO or EHLO command. This is omitted if it is identical to
11666 the verified host name or to the host's IP address in square brackets.
11667
11668 .vitem &$sender_helo_name$&
11669 .vindex "&$sender_helo_name$&"
11670 When a message is received from a remote host that has issued a HELO or EHLO
11671 command, the argument of that command is placed in this variable. It is also
11672 set if HELO or EHLO is used when a message is received using SMTP locally via
11673 the &%-bs%& or &%-bS%& options.
11674
11675 .vitem &$sender_host_address$&
11676 .vindex "&$sender_host_address$&"
11677 When a message is received from a remote host, this variable contains that
11678 host's IP address. For locally submitted messages, it is empty.
11679
11680 .vitem &$sender_host_authenticated$&
11681 .vindex "&$sender_host_authenticated$&"
11682 This variable contains the name (not the public name) of the authenticator
11683 driver that successfully authenticated the client from which the message was
11684 received. It is empty if there was no successful authentication. See also
11685 &$authenticated_id$&.
11686
11687 .vitem &$sender_host_name$&
11688 .vindex "&$sender_host_name$&"
11689 When a message is received from a remote host, this variable contains the
11690 host's name as obtained by looking up its IP address. For messages received by
11691 other means, this variable is empty.
11692
11693 .vindex "&$host_lookup_failed$&"
11694 If the host name has not previously been looked up, a reference to
11695 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11696 A looked up name is accepted only if it leads back to the original IP address
11697 via a forward lookup. If either the reverse or the forward lookup fails to find
11698 any data, or if the forward lookup does not yield the original IP address,
11699 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11700
11701 .vindex "&$host_lookup_deferred$&"
11702 However, if either of the lookups cannot be completed (for example, there is a
11703 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11704 &$host_lookup_failed$& remains set to &"0"&.
11705
11706 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11707 host name again if there is a subsequent reference to &$sender_host_name$&
11708 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11709 is set to &"1"&.
11710
11711 Exim does not automatically look up every calling host's name. If you want
11712 maximum efficiency, you should arrange your configuration so that it avoids
11713 these lookups altogether. The lookup happens only if one or more of the
11714 following are true:
11715
11716 .ilist
11717 A string containing &$sender_host_name$& is expanded.
11718 .next
11719 The calling host matches the list in &%host_lookup%&. In the default
11720 configuration, this option is set to *, so it must be changed if lookups are
11721 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11722 .next
11723 Exim needs the host name in order to test an item in a host list. The items
11724 that require this are described in sections &<<SECThoslispatnam>>& and
11725 &<<SECThoslispatnamsk>>&.
11726 .next
11727 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11728 In this case, the host name is required to compare with the name quoted in any
11729 EHLO or HELO commands that the client issues.
11730 .next
11731 The remote host issues a EHLO or HELO command that quotes one of the
11732 domains in &%helo_lookup_domains%&. The default value of this option is
11733 . ==== As this is a nested list, any displays it contains must be indented
11734 . ==== as otherwise they are too far to the left.
11735 .code
11736   helo_lookup_domains = @ : @[]
11737 .endd
11738 which causes a lookup if a remote host (incorrectly) gives the server's name or
11739 IP address in an EHLO or HELO command.
11740 .endlist
11741
11742
11743 .vitem &$sender_host_port$&
11744 .vindex "&$sender_host_port$&"
11745 When a message is received from a remote host, this variable contains the port
11746 number that was used on the remote host.
11747
11748 .vitem &$sender_ident$&
11749 .vindex "&$sender_ident$&"
11750 When a message is received from a remote host, this variable contains the
11751 identification received in response to an RFC 1413 request. When a message has
11752 been received locally, this variable contains the login name of the user that
11753 called Exim.
11754
11755 .vitem &$sender_rate_$&&'xxx'&
11756 A number of variables whose names begin &$sender_rate_$& are set as part of the
11757 &%ratelimit%& ACL condition. Details are given in section
11758 &<<SECTratelimiting>>&.
11759
11760 .vitem &$sender_rcvhost$&
11761 .cindex "DNS" "reverse lookup"
11762 .cindex "reverse DNS lookup"
11763 .vindex "&$sender_rcvhost$&"
11764 This is provided specifically for use in &'Received:'& headers. It starts with
11765 either the verified host name (as obtained from a reverse DNS lookup) or, if
11766 there is no verified host name, the IP address in square brackets. After that
11767 there may be text in parentheses. When the first item is a verified host name,
11768 the first thing in the parentheses is the IP address in square brackets,
11769 followed by a colon and a port number if port logging is enabled. When the
11770 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11771 the parentheses.
11772
11773 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11774 was used and its argument was not identical to the real host name or IP
11775 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11776 all three items are present in the parentheses, a newline and tab are inserted
11777 into the string, to improve the formatting of the &'Received:'& header.
11778
11779 .vitem &$sender_verify_failure$&
11780 .vindex "&$sender_verify_failure$&"
11781 In an ACL, when a sender verification fails, this variable contains information
11782 about the failure. The details are the same as for
11783 &$recipient_verify_failure$&.
11784
11785 .vitem &$sending_ip_address$&
11786 .vindex "&$sending_ip_address$&"
11787 This variable is set whenever an outgoing SMTP connection to another host has
11788 been set up. It contains the IP address of the local interface that is being
11789 used. This is useful if a host that has more than one IP address wants to take
11790 on different personalities depending on which one is being used. For incoming
11791 connections, see &$received_ip_address$&.
11792
11793 .vitem &$sending_port$&
11794 .vindex "&$sending_port$&"
11795 This variable is set whenever an outgoing SMTP connection to another host has
11796 been set up. It contains the local port that is being used. For incoming
11797 connections, see &$received_port$&.
11798
11799 .vitem &$smtp_active_hostname$&
11800 .vindex "&$smtp_active_hostname$&"
11801 During an incoming SMTP session, this variable contains the value of the active
11802 host name, as specified by the &%smtp_active_hostname%& option. The value of
11803 &$smtp_active_hostname$& is saved with any message that is received, so its
11804 value can be consulted during routing and delivery.
11805
11806 .vitem &$smtp_command$&
11807 .vindex "&$smtp_command$&"
11808 During the processing of an incoming SMTP command, this variable contains the
11809 entire command. This makes it possible to distinguish between HELO and EHLO in
11810 the HELO ACL, and also to distinguish between commands such as these:
11811 .code
11812 MAIL FROM:<>
11813 MAIL FROM: <>
11814 .endd
11815 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11816 command, the address in &$smtp_command$& is the original address before any
11817 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11818 the address after SMTP-time rewriting.
11819
11820 .vitem &$smtp_command_argument$&
11821 .cindex "SMTP" "command, argument for"
11822 .vindex "&$smtp_command_argument$&"
11823 While an ACL is running to check an SMTP command, this variable contains the
11824 argument, that is, the text that follows the command name, with leading white
11825 space removed. Following the introduction of &$smtp_command$&, this variable is
11826 somewhat redundant, but is retained for backwards compatibility.
11827
11828 .vitem &$smtp_count_at_connection_start$&
11829 .vindex "&$smtp_count_at_connection_start$&"
11830 This variable is set greater than zero only in processes spawned by the Exim
11831 daemon for handling incoming SMTP connections. The name is deliberately long,
11832 in order to emphasize what the contents are. When the daemon accepts a new
11833 connection, it increments this variable. A copy of the variable is passed to
11834 the child process that handles the connection, but its value is fixed, and
11835 never changes. It is only an approximation of how many incoming connections
11836 there actually are, because many other connections may come and go while a
11837 single connection is being processed. When a child process terminates, the
11838 daemon decrements its copy of the variable.
11839
11840 .vitem "&$sn0$& &-- &$sn9$&"
11841 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11842 that were current at the end of the system filter file. This allows a system
11843 filter file to set values that can be tested in users' filter files. For
11844 example, a system filter could set a value indicating how likely it is that a
11845 message is junk mail.
11846
11847 .vitem &$spam_$&&'xxx'&
11848 A number of variables whose names start with &$spam$& are available when Exim
11849 is compiled with the content-scanning extension. For details, see section
11850 &<<SECTscanspamass>>&.
11851
11852
11853 .vitem &$spool_directory$&
11854 .vindex "&$spool_directory$&"
11855 The name of Exim's spool directory.
11856
11857 .vitem &$spool_inodes$&
11858 .vindex "&$spool_inodes$&"
11859 The number of free inodes in the disk partition where Exim's spool files are
11860 being written. The value is recalculated whenever the variable is referenced.
11861 If the relevant file system does not have the concept of inodes, the value of
11862 is -1. See also the &%check_spool_inodes%& option.
11863
11864 .vitem &$spool_space$&
11865 .vindex "&$spool_space$&"
11866 The amount of free space (as a number of kilobytes) in the disk partition where
11867 Exim's spool files are being written. The value is recalculated whenever the
11868 variable is referenced. If the operating system does not have the ability to
11869 find the amount of free space (only true for experimental systems), the space
11870 value is -1. For example, to check in an ACL that there is at least 50
11871 megabytes free on the spool, you could write:
11872 .code
11873 condition = ${if > {$spool_space}{50000}}
11874 .endd
11875 See also the &%check_spool_space%& option.
11876
11877
11878 .vitem &$thisaddress$&
11879 .vindex "&$thisaddress$&"
11880 This variable is set only during the processing of the &%foranyaddress%&
11881 command in a filter file. Its use is explained in the description of that
11882 command, which can be found in the separate document entitled &'Exim's
11883 interfaces to mail filtering'&.
11884
11885 .new
11886 .vitem &$tls_bits$&
11887 .vindex "&$tls_bits$&"
11888 Contains an approximation of the TLS cipher's bit-strength; the meaning of
11889 this depends upon the TLS implementation used.
11890 If TLS has not been negotiated, the value will be 0.
11891 The value of this is automatically fed into the Cyrus SASL authenticator
11892 when acting as a server, to specify the "external SSF" (a SASL term).
11893 .wen
11894
11895 .vitem &$tls_certificate_verified$&
11896 .vindex "&$tls_certificate_verified$&"
11897 This variable is set to &"1"& if a TLS certificate was verified when the
11898 message was received, and &"0"& otherwise.
11899
11900 .vitem &$tls_cipher$&
11901 .vindex "&$tls_cipher$&"
11902 When a message is received from a remote host over an encrypted SMTP
11903 connection, this variable is set to the cipher suite that was negotiated, for
11904 example DES-CBC3-SHA. In other circumstances, in particular, for message
11905 received over unencrypted connections, the variable is empty. Testing
11906 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11907 non-encrypted connections during ACL processing.
11908
11909 The &$tls_cipher$& variable retains its value during message delivery, except
11910 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11911 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11912 and then set to the outgoing cipher suite if one is negotiated. See chapter
11913 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11914 details of the &(smtp)& transport.
11915
11916 .vitem &$tls_peerdn$&
11917 .vindex "&$tls_peerdn$&"
11918 When a message is received from a remote host over an encrypted SMTP
11919 connection, and Exim is configured to request a certificate from the client,
11920 the value of the Distinguished Name of the certificate is made available in the
11921 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11922 value is retained during message delivery, except during outbound SMTP
11923 deliveries.
11924
11925 .new
11926 .vitem &$tls_sni$&
11927 .vindex "&$tls_sni$&"
11928 .cindex "TLS" "Server Name Indication"
11929 When a TLS session is being established, if the client sends the Server
11930 Name Indication extension, the value will be placed in this variable.
11931 If the variable appears in &%tls_certificate%& then this option and
11932 some others, described in &<<SECTtlssni>>&,
11933 will be re-expanded early in the TLS session, to permit
11934 a different certificate to be presented (and optionally a different key to be
11935 used) to the client, based upon the value of the SNI extension.
11936
11937 The value will be retained for the lifetime of the message.  During outbound
11938 SMTP deliveries, it reflects the value of the &%tls_sni%& option on
11939 the transport.
11940 .wen
11941
11942 .vitem &$tod_bsdinbox$&
11943 .vindex "&$tod_bsdinbox$&"
11944 The time of day and the date, in the format required for BSD-style mailbox
11945 files, for example: Thu Oct 17 17:14:09 1995.
11946
11947 .vitem &$tod_epoch$&
11948 .vindex "&$tod_epoch$&"
11949 The time and date as a number of seconds since the start of the Unix epoch.
11950
11951 .vitem &$tod_full$&
11952 .vindex "&$tod_full$&"
11953 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11954 +0100. The timezone is always given as a numerical offset from UTC, with
11955 positive values used for timezones that are ahead (east) of UTC, and negative
11956 values for those that are behind (west).
11957
11958 .vitem &$tod_log$&
11959 .vindex "&$tod_log$&"
11960 The time and date in the format used for writing Exim's log files, for example:
11961 1995-10-12 15:32:29, but without a timezone.
11962
11963 .vitem &$tod_logfile$&
11964 .vindex "&$tod_logfile$&"
11965 This variable contains the date in the format yyyymmdd. This is the format that
11966 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11967 flag.
11968
11969 .vitem &$tod_zone$&
11970 .vindex "&$tod_zone$&"
11971 This variable contains the numerical value of the local timezone, for example:
11972 -0500.
11973
11974 .vitem &$tod_zulu$&
11975 .vindex "&$tod_zulu$&"
11976 This variable contains the UTC date and time in &"Zulu"& format, as specified
11977 by ISO 8601, for example: 20030221154023Z.
11978
11979 .vitem &$value$&
11980 .vindex "&$value$&"
11981 This variable contains the result of an expansion lookup, extraction operation,
11982 or external command, as described above. It is also used during a
11983 &*reduce*& expansion.
11984
11985 .vitem &$version_number$&
11986 .vindex "&$version_number$&"
11987 The version number of Exim.
11988
11989 .vitem &$warn_message_delay$&
11990 .vindex "&$warn_message_delay$&"
11991 This variable is set only during the creation of a message warning about a
11992 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11993
11994 .vitem &$warn_message_recipients$&
11995 .vindex "&$warn_message_recipients$&"
11996 This variable is set only during the creation of a message warning about a
11997 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11998 .endlist
11999 .ecindex IIDstrexp
12000
12001
12002
12003 . ////////////////////////////////////////////////////////////////////////////
12004 . ////////////////////////////////////////////////////////////////////////////
12005
12006 .chapter "Embedded Perl" "CHAPperl"
12007 .scindex IIDperl "Perl" "calling from Exim"
12008 Exim can be built to include an embedded Perl interpreter. When this is done,
12009 Perl subroutines can be called as part of the string expansion process. To make
12010 use of the Perl support, you need version 5.004 or later of Perl installed on
12011 your system. To include the embedded interpreter in the Exim binary, include
12012 the line
12013 .code
12014 EXIM_PERL = perl.o
12015 .endd
12016 in your &_Local/Makefile_& and then build Exim in the normal way.
12017
12018
12019 .section "Setting up so Perl can be used" "SECID85"
12020 .oindex "&%perl_startup%&"
12021 Access to Perl subroutines is via a global configuration option called
12022 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12023 no &%perl_startup%& option in the Exim configuration file then no Perl
12024 interpreter is started and there is almost no overhead for Exim (since none of
12025 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12026 option then the associated value is taken to be Perl code which is executed in
12027 a newly created Perl interpreter.
12028
12029 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12030 need backslashes before any characters to escape special meanings. The option
12031 should usually be something like
12032 .code
12033 perl_startup = do '/etc/exim.pl'
12034 .endd
12035 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12036 use from Exim. Exim can be configured either to start up a Perl interpreter as
12037 soon as it is entered, or to wait until the first time it is needed. Starting
12038 the interpreter at the beginning ensures that it is done while Exim still has
12039 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12040 fact used in a particular run. Also, note that this does not mean that Exim is
12041 necessarily running as root when Perl is called at a later time. By default,
12042 the interpreter is started only when it is needed, but this can be changed in
12043 two ways:
12044
12045 .ilist
12046 .oindex "&%perl_at_start%&"
12047 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12048 a startup when Exim is entered.
12049 .next
12050 The command line option &%-ps%& also requests a startup when Exim is entered,
12051 overriding the setting of &%perl_at_start%&.
12052 .endlist
12053
12054 There is also a command line option &%-pd%& (for delay) which suppresses the
12055 initial startup, even if &%perl_at_start%& is set.
12056
12057
12058 .section "Calling Perl subroutines" "SECID86"
12059 When the configuration file includes a &%perl_startup%& option you can make use
12060 of the string expansion item to call the Perl subroutines that are defined
12061 by the &%perl_startup%& code. The operator is used in any of the following
12062 forms:
12063 .code
12064 ${perl{foo}}
12065 ${perl{foo}{argument}}
12066 ${perl{foo}{argument1}{argument2} ... }
12067 .endd
12068 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12069 arguments may be passed. Passing more than this results in an expansion failure
12070 with an error message of the form
12071 .code
12072 Too many arguments passed to Perl subroutine "foo" (max is 8)
12073 .endd
12074 The return value of the Perl subroutine is evaluated in a scalar context before
12075 it is passed back to Exim to be inserted into the expanded string. If the
12076 return value is &'undef'&, the expansion is forced to fail in the same way as
12077 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12078 by obeying Perl's &%die%& function, the expansion fails with the error message
12079 that was passed to &%die%&.
12080
12081
12082 .section "Calling Exim functions from Perl" "SECID87"
12083 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12084 is available to call back into Exim's string expansion function. For example,
12085 the Perl code
12086 .code
12087 my $lp = Exim::expand_string('$local_part');
12088 .endd
12089 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12090 Note those are single quotes and not double quotes to protect against
12091 &$local_part$& being interpolated as a Perl variable.
12092
12093 If the string expansion is forced to fail by a &"fail"& item, the result of
12094 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12095 expansion string, the Perl call from the original expansion string fails with
12096 an appropriate error message, in the same way as if &%die%& were used.
12097
12098 .cindex "debugging" "from embedded Perl"
12099 .cindex "log" "writing from embedded Perl"
12100 Two other Exim functions are available for use from within Perl code.
12101 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12102 debugging is enabled. If you want a newline at the end, you must supply it.
12103 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12104 timestamp. In this case, you should not supply a terminating newline.
12105
12106
12107 .section "Use of standard output and error by Perl" "SECID88"
12108 .cindex "Perl" "standard output and error"
12109 You should not write to the standard error or output streams from within your
12110 Perl code, as it is not defined how these are set up. In versions of Exim
12111 before 4.50, it is possible for the standard output or error to refer to the
12112 SMTP connection during message reception via the daemon. Writing to this stream
12113 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12114 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12115 avoided, but the output is lost.
12116
12117 .cindex "Perl" "use of &%warn%&"
12118 The Perl &%warn%& statement writes to the standard error stream by default.
12119 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12120 you have no control. When Exim starts up the Perl interpreter, it arranges for
12121 output from the &%warn%& statement to be written to the Exim main log. You can
12122 change this by including appropriate Perl magic somewhere in your Perl code.
12123 For example, to discard &%warn%& output completely, you need this:
12124 .code
12125 $SIG{__WARN__} = sub { };
12126 .endd
12127 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12128 example, the code for the subroutine is empty, so it does nothing, but you can
12129 include any Perl code that you like. The text of the &%warn%& message is passed
12130 as the first subroutine argument.
12131 .ecindex IIDperl
12132
12133
12134 . ////////////////////////////////////////////////////////////////////////////
12135 . ////////////////////////////////////////////////////////////////////////////
12136
12137 .chapter "Starting the daemon and the use of network interfaces" &&&
12138          "CHAPinterfaces" &&&
12139          "Starting the daemon"
12140 .cindex "daemon" "starting"
12141 .cindex "interface" "listening"
12142 .cindex "network interface"
12143 .cindex "interface" "network"
12144 .cindex "IP address" "for listening"
12145 .cindex "daemon" "listening IP addresses"
12146 .cindex "TCP/IP" "setting listening interfaces"
12147 .cindex "TCP/IP" "setting listening ports"
12148 A host that is connected to a TCP/IP network may have one or more physical
12149 hardware network interfaces. Each of these interfaces may be configured as one
12150 or more &"logical"& interfaces, which are the entities that a program actually
12151 works with. Each of these logical interfaces is associated with an IP address.
12152 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12153 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12154 knowledge about the host's interfaces for use in three different circumstances:
12155
12156 .olist
12157 When a listening daemon is started, Exim needs to know which interfaces
12158 and ports to listen on.
12159 .next
12160 When Exim is routing an address, it needs to know which IP addresses
12161 are associated with local interfaces. This is required for the correct
12162 processing of MX lists by removing the local host and others with the
12163 same or higher priority values. Also, Exim needs to detect cases
12164 when an address is routed to an IP address that in fact belongs to the
12165 local host. Unless the &%self%& router option or the &%allow_localhost%&
12166 option of the smtp transport is set (as appropriate), this is treated
12167 as an error situation.
12168 .next
12169 When Exim connects to a remote host, it may need to know which interface to use
12170 for the outgoing connection.
12171 .endlist
12172
12173
12174 Exim's default behaviour is likely to be appropriate in the vast majority
12175 of cases. If your host has only one interface, and you want all its IP
12176 addresses to be treated in the same way, and you are using only the
12177 standard SMTP port, you should not need to take any special action. The
12178 rest of this chapter does not apply to you.
12179
12180 In a more complicated situation you may want to listen only on certain
12181 interfaces, or on different ports, and for this reason there are a number of
12182 options that can be used to influence Exim's behaviour. The rest of this
12183 chapter describes how they operate.
12184
12185 When a message is received over TCP/IP, the interface and port that were
12186 actually used are set in &$received_ip_address$& and &$received_port$&.
12187
12188
12189
12190 .section "Starting a listening daemon" "SECID89"
12191 When a listening daemon is started (by means of the &%-bd%& command line
12192 option), the interfaces and ports on which it listens are controlled by the
12193 following options:
12194
12195 .ilist
12196 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12197 compatibility, this option can also be specified in the singular.)
12198 .next
12199 &%local_interfaces%& contains list of interface IP addresses on which to
12200 listen. Each item may optionally also specify a port.
12201 .endlist
12202
12203 The default list separator in both cases is a colon, but this can be changed as
12204 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12205 it is usually best to change the separator to avoid having to double all the
12206 colons. For example:
12207 .code
12208 local_interfaces = <; 127.0.0.1 ; \
12209                       192.168.23.65 ; \
12210                       ::1 ; \
12211                       3ffe:ffff:836f::fe86:a061
12212 .endd
12213 There are two different formats for specifying a port along with an IP address
12214 in &%local_interfaces%&:
12215
12216 .olist
12217 The port is added onto the address with a dot separator. For example, to listen
12218 on port 1234 on two different IP addresses:
12219 .code
12220 local_interfaces = <; 192.168.23.65.1234 ; \
12221                       3ffe:ffff:836f::fe86:a061.1234
12222 .endd
12223 .next
12224 The IP address is enclosed in square brackets, and the port is added
12225 with a colon separator, for example:
12226 .code
12227 local_interfaces = <; [192.168.23.65]:1234 ; \
12228                       [3ffe:ffff:836f::fe86:a061]:1234
12229 .endd
12230 .endlist
12231
12232 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12233 default setting contains just one port:
12234 .code
12235 daemon_smtp_ports = smtp
12236 .endd
12237 If more than one port is listed, each interface that does not have its own port
12238 specified listens on all of them. Ports that are listed in
12239 &%daemon_smtp_ports%& can be identified either by name (defined in
12240 &_/etc/services_&) or by number. However, when ports are given with individual
12241 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12242
12243
12244
12245 .section "Special IP listening addresses" "SECID90"
12246 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12247 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12248 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12249 instead of setting up separate listening sockets for each interface. The
12250 default value of &%local_interfaces%& is
12251 .code
12252 local_interfaces = 0.0.0.0
12253 .endd
12254 when Exim is built without IPv6 support; otherwise it is:
12255 .code
12256 local_interfaces = <; ::0 ; 0.0.0.0
12257 .endd
12258 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12259
12260
12261
12262 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12263 The &%-oX%& command line option can be used to override the values of
12264 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12265 instance. Another way of doing this would be to use macros and the &%-D%&
12266 option. However, &%-oX%& can be used by any admin user, whereas modification of
12267 the runtime configuration by &%-D%& is allowed only when the caller is root or
12268 exim.
12269
12270 The value of &%-oX%& is a list of items. The default colon separator can be
12271 changed in the usual way if required. If there are any items that do not
12272 contain dots or colons (that is, are not IP addresses), the value of
12273 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12274 items that do contain dots or colons, the value of &%local_interfaces%& is
12275 replaced by those items. Thus, for example,
12276 .code
12277 -oX 1225
12278 .endd
12279 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12280 whereas
12281 .code
12282 -oX 192.168.34.5.1125
12283 .endd
12284 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12285 (However, since &%local_interfaces%& now contains no items without ports, the
12286 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12287
12288
12289
12290 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12291 .cindex "ssmtp protocol"
12292 .cindex "smtps protocol"
12293 .cindex "SMTP" "ssmtp protocol"
12294 .cindex "SMTP" "smtps protocol"
12295 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12296 before the STARTTLS command was standardized for SMTP. Some legacy clients
12297 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12298 list of port numbers, connections to those ports must use SSMTP. The most
12299 common use of this option is expected to be
12300 .code
12301 tls_on_connect_ports = 465
12302 .endd
12303 because 465 is the usual port number used by the legacy clients. There is also
12304 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12305 this way when a daemon is started.
12306
12307 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12308 daemon to listen on those ports. You must still specify them in
12309 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12310 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12311 connections via the daemon.)
12312
12313
12314
12315
12316 .section "IPv6 address scopes" "SECID92"
12317 .cindex "IPv6" "address scopes"
12318 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12319 can, in principle, have the same link-local IPv6 address on different
12320 interfaces. Thus, additional information is needed, over and above the IP
12321 address, to distinguish individual interfaces. A convention of using a
12322 percent sign followed by something (often the interface name) has been
12323 adopted in some cases, leading to addresses like this:
12324 .code
12325 fe80::202:b3ff:fe03:45c1%eth0
12326 .endd
12327 To accommodate this usage, a percent sign followed by an arbitrary string is
12328 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12329 to convert a textual IPv6 address for actual use. This function recognizes the
12330 percent convention in operating systems that support it, and it processes the
12331 address appropriately. Unfortunately, some older libraries have problems with
12332 &[getaddrinfo()]&. If
12333 .code
12334 IPV6_USE_INET_PTON=yes
12335 .endd
12336 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12337 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12338 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12339 function.) Of course, this means that the additional functionality of
12340 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12341
12342 .section "Disabling IPv6" "SECID93"
12343 .cindex "IPv6" "disabling"
12344 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12345 run on a host whose kernel does not support IPv6. The binary will fall back to
12346 using IPv4, but it may waste resources looking up AAAA records, and trying to
12347 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12348 .oindex "&%disable_ipv6%&"
12349 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12350 activities take place. AAAA records are never looked up, and any IPv6 addresses
12351 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12352 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12353 to handle IPv6 literal addresses.
12354
12355 On the other hand, when IPv6 is in use, there may be times when you want to
12356 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12357 option to globally suppress the lookup of AAAA records for specified domains,
12358 and you can use the &%ignore_target_hosts%& generic router option to ignore
12359 IPv6 addresses in an individual router.
12360
12361
12362
12363 .section "Examples of starting a listening daemon" "SECID94"
12364 The default case in an IPv6 environment is
12365 .code
12366 daemon_smtp_ports = smtp
12367 local_interfaces = <; ::0 ; 0.0.0.0
12368 .endd
12369 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12370 Either one or two sockets may be used, depending on the characteristics of
12371 the TCP/IP stack. (This is complicated and messy; for more information,
12372 read the comments in the &_daemon.c_& source file.)
12373
12374 To specify listening on ports 25 and 26 on all interfaces:
12375 .code
12376 daemon_smtp_ports = 25 : 26
12377 .endd
12378 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12379 .code
12380 local_interfaces = <; ::0.25     ; ::0.26 \
12381                       0.0.0.0.25 ; 0.0.0.0.26
12382 .endd
12383 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12384 IPv4 loopback address only:
12385 .code
12386 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12387 .endd
12388 To specify listening on the default port on specific interfaces only:
12389 .code
12390 local_interfaces = 192.168.34.67 : 192.168.34.67
12391 .endd
12392 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12393
12394
12395
12396 .section "Recognizing the local host" "SECTreclocipadd"
12397 The &%local_interfaces%& option is also used when Exim needs to determine
12398 whether or not an IP address refers to the local host. That is, the IP
12399 addresses of all the interfaces on which a daemon is listening are always
12400 treated as local.
12401
12402 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12403 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12404 available interfaces from the operating system, and extracts the relevant
12405 (that is, IPv4 or IPv6) addresses to use for checking.
12406
12407 Some systems set up large numbers of virtual interfaces in order to provide
12408 many virtual web servers. In this situation, you may want to listen for
12409 email on only a few of the available interfaces, but nevertheless treat all
12410 interfaces as local when routing. You can do this by setting
12411 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12412 &"all"& wildcard values. These addresses are recognized as local, but are not
12413 used for listening. Consider this example:
12414 .code
12415 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12416                       192.168.53.235 ; \
12417                       3ffe:2101:12:1:a00:20ff:fe86:a061
12418
12419 extra_local_interfaces = <; ::0 ; 0.0.0.0
12420 .endd
12421 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12422 address, but all available interface addresses are treated as local when
12423 Exim is routing.
12424
12425 In some environments the local host name may be in an MX list, but with an IP
12426 address that is not assigned to any local interface. In other cases it may be
12427 desirable to treat other host names as if they referred to the local host. Both
12428 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12429 This contains host names rather than IP addresses. When a host is referenced
12430 during routing, either via an MX record or directly, it is treated as the local
12431 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12432 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12433
12434
12435
12436 .section "Delivering to a remote host" "SECID95"
12437 Delivery to a remote host is handled by the smtp transport. By default, it
12438 allows the system's TCP/IP functions to choose which interface to use (if
12439 there is more than one) when connecting to a remote host. However, the
12440 &%interface%& option can be set to specify which interface is used. See the
12441 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12442 details.
12443
12444
12445
12446
12447 . ////////////////////////////////////////////////////////////////////////////
12448 . ////////////////////////////////////////////////////////////////////////////
12449
12450 .chapter "Main configuration" "CHAPmainconfig"
12451 .scindex IIDconfima "configuration file" "main section"
12452 .scindex IIDmaiconf "main configuration"
12453 The first part of the run time configuration file contains three types of item:
12454
12455 .ilist
12456 Macro definitions: These lines start with an upper case letter. See section
12457 &<<SECTmacrodefs>>& for details of macro processing.
12458 .next
12459 Named list definitions: These lines start with one of the words &"domainlist"&,
12460 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12461 section &<<SECTnamedlists>>&.
12462 .next
12463 Main configuration settings: Each setting occupies one line of the file
12464 (with possible continuations). If any setting is preceded by the word
12465 &"hide"&, the &%-bP%& command line option displays its value to admin users
12466 only. See section &<<SECTcos>>& for a description of the syntax of these option
12467 settings.
12468 .endlist
12469
12470 This chapter specifies all the main configuration options, along with their
12471 types and default values. For ease of finding a particular option, they appear
12472 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12473 are now so many options, they are first listed briefly in functional groups, as
12474 an aid to finding the name of the option you are looking for. Some options are
12475 listed in more than one group.
12476
12477 .section "Miscellaneous" "SECID96"
12478 .table2
12479 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12480 .row &%disable_ipv6%&                "do no IPv6 processing"
12481 .row &%keep_malformed%&              "for broken files &-- should not happen"
12482 .row &%localhost_number%&            "for unique message ids in clusters"
12483 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12484 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12485 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12486 .row &%print_topbitchars%&           "top-bit characters are printing"
12487 .row &%timezone%&                    "force time zone"
12488 .endtable
12489
12490
12491 .section "Exim parameters" "SECID97"
12492 .table2
12493 .row &%exim_group%&                  "override compiled-in value"
12494 .row &%exim_path%&                   "override compiled-in value"
12495 .row &%exim_user%&                   "override compiled-in value"
12496 .row &%primary_hostname%&            "default from &[uname()]&"
12497 .row &%split_spool_directory%&       "use multiple directories"
12498 .row &%spool_directory%&             "override compiled-in value"
12499 .endtable
12500
12501
12502
12503 .section "Privilege controls" "SECID98"
12504 .table2
12505 .row &%admin_groups%&                "groups that are Exim admin users"
12506 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12507 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12508 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12509 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12510 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12511 .row &%never_users%&                 "do not run deliveries as these"
12512 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12513 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12514 .row &%trusted_groups%&              "groups that are trusted"
12515 .row &%trusted_users%&               "users that are trusted"
12516 .endtable
12517
12518
12519
12520 .section "Logging" "SECID99"
12521 .table2
12522 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12523 .row &%log_file_path%&               "override compiled-in value"
12524 .row &%log_selector%&                "set/unset optional logging"
12525 .row &%log_timezone%&                "add timezone to log lines"
12526 .row &%message_logs%&                "create per-message logs"
12527 .row &%preserve_message_logs%&       "after message completion"
12528 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12529 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12530 .row &%syslog_facility%&             "set syslog &""facility""& field"
12531 .row &%syslog_processname%&          "set syslog &""ident""& field"
12532 .row &%syslog_timestamp%&            "timestamp syslog lines"
12533 .row &%write_rejectlog%&             "control use of message log"
12534 .endtable
12535
12536
12537
12538 .section "Frozen messages" "SECID100"
12539 .table2
12540 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12541 .row &%freeze_tell%&                 "send message when freezing"
12542 .row &%move_frozen_messages%&        "to another directory"
12543 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12544 .endtable
12545
12546
12547
12548 .section "Data lookups" "SECID101"
12549 .table2
12550 .row &%ibase_servers%&               "InterBase servers"
12551 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12552 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12553 .row &%ldap_cert_file%&              "client cert file for LDAP"
12554 .row &%ldap_cert_key%&               "client key file for LDAP"
12555 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12556 .row &%ldap_default_servers%&        "used if no server in query"
12557 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12558 .row &%ldap_start_tls%&              "require TLS within LDAP"
12559 .row &%ldap_version%&                "set protocol version"
12560 .row &%lookup_open_max%&             "lookup files held open"
12561 .row &%mysql_servers%&               "default MySQL servers"
12562 .row &%oracle_servers%&              "Oracle servers"
12563 .row &%pgsql_servers%&               "default PostgreSQL servers"
12564 .row &%sqlite_lock_timeout%&         "as it says"
12565 .endtable
12566
12567
12568
12569 .section "Message ids" "SECID102"
12570 .table2
12571 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12572 .row &%message_id_header_text%&      "ditto"
12573 .endtable
12574
12575
12576
12577 .section "Embedded Perl Startup" "SECID103"
12578 .table2
12579 .row &%perl_at_start%&               "always start the interpreter"
12580 .row &%perl_startup%&                "code to obey when starting Perl"
12581 .endtable
12582
12583
12584
12585 .section "Daemon" "SECID104"
12586 .table2
12587 .row &%daemon_smtp_ports%&           "default ports"
12588 .row &%daemon_startup_retries%&      "number of times to retry"
12589 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12590 .row &%extra_local_interfaces%&      "not necessarily listened on"
12591 .row &%local_interfaces%&            "on which to listen, with optional ports"
12592 .row &%pid_file_path%&               "override compiled-in value"
12593 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12594 .endtable
12595
12596
12597
12598 .section "Resource control" "SECID105"
12599 .table2
12600 .row &%check_log_inodes%&            "before accepting a message"
12601 .row &%check_log_space%&             "before accepting a message"
12602 .row &%check_spool_inodes%&          "before accepting a message"
12603 .row &%check_spool_space%&           "before accepting a message"
12604 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12605 .row &%queue_only_load%&             "queue incoming if load high"
12606 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12607 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12608 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12609 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12610 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12611 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12612 .row &%smtp_accept_max_per_connection%& "messages per connection"
12613 .row &%smtp_accept_max_per_host%&    "connections from one host"
12614 .row &%smtp_accept_queue%&           "queue mail if more connections"
12615 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12616                                            connection"
12617 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12618 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12619 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12620 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12621 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12622 .endtable
12623
12624
12625
12626 .section "Policy controls" "SECID106"
12627 .table2
12628 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12629 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12630 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12631 .row &%acl_smtp_auth%&               "ACL for AUTH"
12632 .row &%acl_smtp_connect%&            "ACL for connection"
12633 .row &%acl_smtp_data%&               "ACL for DATA"
12634 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12635 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12636 .row &%acl_smtp_expn%&               "ACL for EXPN"
12637 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12638 .row &%acl_smtp_mail%&               "ACL for MAIL"
12639 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12640 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12641 .row &%acl_smtp_predata%&            "ACL for start of data"
12642 .row &%acl_smtp_quit%&               "ACL for QUIT"
12643 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12644 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12645 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12646 .row &%av_scanner%&                  "specify virus scanner"
12647 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12648                                       words""&"
12649 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12650 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12651 .row &%header_maxsize%&              "total size of message header"
12652 .row &%header_line_maxsize%&         "individual header line limit"
12653 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12654 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12655 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12656 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12657 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12658 .row &%host_lookup%&                 "host name looked up for these hosts"
12659 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12660 .row &%host_reject_connection%&      "reject connection from these hosts"
12661 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12662 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12663 .row &%message_size_limit%&          "for all messages"
12664 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12665 .row &%spamd_address%&               "set interface to SpamAssassin"
12666 .row &%strict_acl_vars%&             "object to unset ACL variables"
12667 .endtable
12668
12669
12670
12671 .section "Callout cache" "SECID107"
12672 .table2
12673 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12674                                          item"
12675 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12676                                          item"
12677 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12678 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12679 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12680 .endtable
12681
12682
12683
12684 .section "TLS" "SECID108"
12685 .table2
12686 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12687 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12688 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12689 .row &%tls_certificate%&             "location of server certificate"
12690 .row &%tls_crl%&                     "certificate revocation list"
12691 .row &%tls_dhparam%&                 "DH parameters for server"
12692 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12693 .row &%tls_privatekey%&              "location of server private key"
12694 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12695 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12696 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12697 .row &%tls_verify_certificates%&     "expected client certificates"
12698 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12699 .endtable
12700
12701
12702
12703 .section "Local user handling" "SECID109"
12704 .table2
12705 .row &%finduser_retries%&            "useful in NIS environments"
12706 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12707 .row &%gecos_pattern%&               "ditto"
12708 .row &%max_username_length%&         "for systems that truncate"
12709 .row &%unknown_login%&               "used when no login name found"
12710 .row &%unknown_username%&            "ditto"
12711 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12712 .row &%uucp_from_sender%&            "ditto"
12713 .endtable
12714
12715
12716
12717 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12718 .table2
12719 .row &%header_maxsize%&              "total size of message header"
12720 .row &%header_line_maxsize%&         "individual header line limit"
12721 .row &%message_size_limit%&          "applies to all messages"
12722 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12723 .row &%received_header_text%&        "expanded to make &'Received:'&"
12724 .row &%received_headers_max%&        "for mail loop detection"
12725 .row &%recipients_max%&              "limit per message"
12726 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12727 .endtable
12728
12729
12730
12731
12732 .section "Non-SMTP incoming messages" "SECID111"
12733 .table2
12734 .row &%receive_timeout%&             "for non-SMTP messages"
12735 .endtable
12736
12737
12738
12739
12740
12741 .section "Incoming SMTP messages" "SECID112"
12742 See also the &'Policy controls'& section above.
12743
12744 .table2
12745 .row &%host_lookup%&                 "host name looked up for these hosts"
12746 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12747 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12748 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12749 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12750 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12751 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12752 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12753 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12754 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12755 .row &%smtp_accept_max_per_connection%& "messages per connection"
12756 .row &%smtp_accept_max_per_host%&    "connections from one host"
12757 .row &%smtp_accept_queue%&           "queue mail if more connections"
12758 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12759                                            connection"
12760 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12761 .row &%smtp_active_hostname%&        "host name to use in messages"
12762 .row &%smtp_banner%&                 "text for welcome banner"
12763 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12764 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12765 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12766 .row &%smtp_etrn_command%&           "what to run for ETRN"
12767 .row &%smtp_etrn_serialize%&         "only one at once"
12768 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12769 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12770 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12771 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12772 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12773 .row &%smtp_receive_timeout%&        "per command or data line"
12774 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12775 .row &%smtp_return_error_details%&   "give detail on rejections"
12776 .endtable
12777
12778
12779
12780 .section "SMTP extensions" "SECID113"
12781 .table2
12782 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12783 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12784 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12785 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12786 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12787 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12788 .endtable
12789
12790
12791
12792 .section "Processing messages" "SECID114"
12793 .table2
12794 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12795 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12796 .row &%allow_utf8_domains%&          "in addresses"
12797 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12798                                       words""&"
12799 .row &%delivery_date_remove%&        "from incoming messages"
12800 .row &%envelope_to_remove%&          "from incoming messages"
12801 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12802 .row &%headers_charset%&             "default for translations"
12803 .row &%qualify_domain%&              "default for senders"
12804 .row &%qualify_recipient%&           "default for recipients"
12805 .row &%return_path_remove%&          "from incoming messages"
12806 .row &%strip_excess_angle_brackets%& "in addresses"
12807 .row &%strip_trailing_dot%&          "at end of addresses"
12808 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12809 .endtable
12810
12811
12812
12813 .section "System filter" "SECID115"
12814 .table2
12815 .row &%system_filter%&               "locate system filter"
12816 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12817                                             directory"
12818 .row &%system_filter_file_transport%& "transport for delivery to a file"
12819 .row &%system_filter_group%&         "group for filter running"
12820 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12821 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12822 .row &%system_filter_user%&          "user for filter running"
12823 .endtable
12824
12825
12826
12827 .section "Routing and delivery" "SECID116"
12828 .table2
12829 .row &%disable_ipv6%&                "do no IPv6 processing"
12830 .row &%dns_again_means_nonexist%&    "for broken domains"
12831 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12832 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12833 .row &%dns_retrans%&                 "parameter for resolver"
12834 .row &%dns_retry%&                   "parameter for resolver"
12835 .row &%dns_use_edns0%&               "parameter for resolver"
12836 .row &%hold_domains%&                "hold delivery for these domains"
12837 .row &%local_interfaces%&            "for routing checks"
12838 .row &%queue_domains%&               "no immediate delivery for these"
12839 .row &%queue_only%&                  "no immediate delivery at all"
12840 .row &%queue_only_file%&             "no immediate delivery if file exists"
12841 .row &%queue_only_load%&             "no immediate delivery if load is high"
12842 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12843 .row &%queue_only_override%&         "allow command line to override"
12844 .row &%queue_run_in_order%&          "order of arrival"
12845 .row &%queue_run_max%&               "of simultaneous queue runners"
12846 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12847 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12848 .row &%remote_sort_domains%&         "order of remote deliveries"
12849 .row &%retry_data_expire%&           "timeout for retry data"
12850 .row &%retry_interval_max%&          "safety net for retry rules"
12851 .endtable
12852
12853
12854
12855 .section "Bounce and warning messages" "SECID117"
12856 .table2
12857 .row &%bounce_message_file%&         "content of bounce"
12858 .row &%bounce_message_text%&         "content of bounce"
12859 .row &%bounce_return_body%&          "include body if returning message"
12860 .row &%bounce_return_message%&       "include original message in bounce"
12861 .row &%bounce_return_size_limit%&    "limit on returned message"
12862 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12863 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12864 .row &%errors_copy%&                 "copy bounce messages"
12865 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12866 .row &%delay_warning%&               "time schedule"
12867 .row &%delay_warning_condition%&     "condition for warning messages"
12868 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12869 .row &%smtp_return_error_details%&   "give detail on rejections"
12870 .row &%warn_message_file%&           "content of warning message"
12871 .endtable
12872
12873
12874
12875 .section "Alphabetical list of main options" "SECTalomo"
12876 Those options that undergo string expansion before use are marked with
12877 &dagger;.
12878
12879 .new
12880 .option accept_8bitmime main boolean true
12881 .cindex "8BITMIME"
12882 .cindex "8-bit characters"
12883 This option causes Exim to send 8BITMIME in its response to an SMTP
12884 EHLO command, and to accept the BODY= parameter on MAIL commands.
12885 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12886 takes no steps to do anything special with messages received by this route.
12887
12888 Historically Exim kept this option off by default, but the maintainers
12889 feel that in today's Internet, this causes more problems than it solves.
12890 It now defaults to true.
12891 A more detailed analysis of the issues is provided by Dan Bernstein:
12892 .display
12893 &url(http://cr.yp.to/smtp/8bitmime.html)
12894 .endd
12895 .wen
12896
12897 .option acl_not_smtp main string&!! unset
12898 .cindex "&ACL;" "for non-SMTP messages"
12899 .cindex "non-SMTP messages" "ACLs for"
12900 This option defines the ACL that is run when a non-SMTP message has been
12901 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12902 further details.
12903
12904 .option acl_not_smtp_mime main string&!! unset
12905 This option defines the ACL that is run for individual MIME parts of non-SMTP
12906 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12907 SMTP messages.
12908
12909 .option acl_not_smtp_start main string&!! unset
12910 .cindex "&ACL;" "at start of non-SMTP message"
12911 .cindex "non-SMTP messages" "ACLs for"
12912 This option defines the ACL that is run before Exim starts reading a
12913 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12914
12915 .option acl_smtp_auth main string&!! unset
12916 .cindex "&ACL;" "setting up for SMTP commands"
12917 .cindex "AUTH" "ACL for"
12918 This option defines the ACL that is run when an SMTP AUTH command is
12919 received. See chapter &<<CHAPACL>>& for further details.
12920
12921 .option acl_smtp_connect main string&!! unset
12922 .cindex "&ACL;" "on SMTP connection"
12923 This option defines the ACL that is run when an SMTP connection is received.
12924 See chapter &<<CHAPACL>>& for further details.
12925
12926 .option acl_smtp_data main string&!! unset
12927 .cindex "DATA" "ACL for"
12928 This option defines the ACL that is run after an SMTP DATA command has been
12929 processed and the message itself has been received, but before the final
12930 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12931
12932 .option acl_smtp_etrn main string&!! unset
12933 .cindex "ETRN" "ACL for"
12934 This option defines the ACL that is run when an SMTP ETRN command is
12935 received. See chapter &<<CHAPACL>>& for further details.
12936
12937 .option acl_smtp_expn main string&!! unset
12938 .cindex "EXPN" "ACL for"
12939 This option defines the ACL that is run when an SMTP EXPN command is
12940 received. See chapter &<<CHAPACL>>& for further details.
12941
12942 .option acl_smtp_helo main string&!! unset
12943 .cindex "EHLO" "ACL for"
12944 .cindex "HELO" "ACL for"
12945 This option defines the ACL that is run when an SMTP EHLO or HELO
12946 command is received. See chapter &<<CHAPACL>>& for further details.
12947
12948
12949 .option acl_smtp_mail main string&!! unset
12950 .cindex "MAIL" "ACL for"
12951 This option defines the ACL that is run when an SMTP MAIL command is
12952 received. See chapter &<<CHAPACL>>& for further details.
12953
12954 .option acl_smtp_mailauth main string&!! unset
12955 .cindex "AUTH" "on MAIL command"
12956 This option defines the ACL that is run when there is an AUTH parameter on
12957 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12958 &<<CHAPSMTPAUTH>>& for details of authentication.
12959
12960 .option acl_smtp_mime main string&!! unset
12961 .cindex "MIME content scanning" "ACL for"
12962 This option is available when Exim is built with the content-scanning
12963 extension. It defines the ACL that is run for each MIME part in a message. See
12964 section &<<SECTscanmimepart>>& for details.
12965
12966 .option acl_smtp_predata main string&!! unset
12967 This option defines the ACL that is run when an SMTP DATA command is
12968 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12969 further details.
12970
12971 .option acl_smtp_quit main string&!! unset
12972 .cindex "QUIT, ACL for"
12973 This option defines the ACL that is run when an SMTP QUIT command is
12974 received. See chapter &<<CHAPACL>>& for further details.
12975
12976 .option acl_smtp_rcpt main string&!! unset
12977 .cindex "RCPT" "ACL for"
12978 This option defines the ACL that is run when an SMTP RCPT command is
12979 received. See chapter &<<CHAPACL>>& for further details.
12980
12981 .option acl_smtp_starttls main string&!! unset
12982 .cindex "STARTTLS, ACL for"
12983 This option defines the ACL that is run when an SMTP STARTTLS command is
12984 received. See chapter &<<CHAPACL>>& for further details.
12985
12986 .option acl_smtp_vrfy main string&!! unset
12987 .cindex "VRFY" "ACL for"
12988 This option defines the ACL that is run when an SMTP VRFY command is
12989 received. See chapter &<<CHAPACL>>& for further details.
12990
12991 .option admin_groups main "string list&!!" unset
12992 .cindex "admin user"
12993 This option is expanded just once, at the start of Exim's processing. If the
12994 current group or any of the supplementary groups of an Exim caller is in this
12995 colon-separated list, the caller has admin privileges. If all your system
12996 programmers are in a specific group, for example, you can give them all Exim
12997 admin privileges by putting that group in &%admin_groups%&. However, this does
12998 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12999 To permit this, you have to add individuals to the Exim group.
13000
13001 .option allow_domain_literals main boolean false
13002 .cindex "domain literal"
13003 If this option is set, the RFC 2822 domain literal format is permitted in
13004 email addresses. The option is not set by default, because the domain literal
13005 format is not normally required these days, and few people know about it. It
13006 has, however, been exploited by mail abusers.
13007
13008 Unfortunately, it seems that some DNS black list maintainers are using this
13009 format to report black listing to postmasters. If you want to accept messages
13010 addressed to your hosts by IP address, you need to set
13011 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13012 domains (defined in the named domain list &%local_domains%& in the default
13013 configuration). This &"magic string"& matches the domain literal form of all
13014 the local host's IP addresses.
13015
13016
13017 .option allow_mx_to_ip main boolean false
13018 .cindex "MX record" "pointing to IP address"
13019 It appears that more and more DNS zone administrators are breaking the rules
13020 and putting domain names that look like IP addresses on the right hand side of
13021 MX records. Exim follows the rules and rejects this, giving an error message
13022 that explains the mis-configuration. However, some other MTAs support this
13023 practice, so to avoid &"Why can't Exim do this?"& complaints,
13024 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13025 recommended, except when you have no other choice.
13026
13027 .option allow_utf8_domains main boolean false
13028 .cindex "domain" "UTF-8 characters in"
13029 .cindex "UTF-8" "in domain name"
13030 Lots of discussion is going on about internationalized domain names. One
13031 camp is strongly in favour of just using UTF-8 characters, and it seems
13032 that at least two other MTAs permit this. This option allows Exim users to
13033 experiment if they wish.
13034
13035 If it is set true, Exim's domain parsing function allows valid
13036 UTF-8 multicharacters to appear in domain name components, in addition to
13037 letters, digits, and hyphens. However, just setting this option is not
13038 enough; if you want to look up these domain names in the DNS, you must also
13039 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13040 suitable setting is:
13041 .code
13042 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13043   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13044 .endd
13045 Alternatively, you can just disable this feature by setting
13046 .code
13047 dns_check_names_pattern =
13048 .endd
13049 That is, set the option to an empty string so that no check is done.
13050
13051
13052 .option auth_advertise_hosts main "host list&!!" *
13053 .cindex "authentication" "advertising"
13054 .cindex "AUTH" "advertising"
13055 If any server authentication mechanisms are configured, Exim advertises them in
13056 response to an EHLO command only if the calling host matches this list.
13057 Otherwise, Exim does not advertise AUTH.
13058 Exim does not accept AUTH commands from clients to which it has not
13059 advertised the availability of AUTH. The advertising of individual
13060 authentication mechanisms can be controlled by the use of the
13061 &%server_advertise_condition%& generic authenticator option on the individual
13062 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13063
13064 Certain mail clients (for example, Netscape) require the user to provide a name
13065 and password for authentication if AUTH is advertised, even though it may
13066 not be needed (the host may accept messages from hosts on its local LAN without
13067 authentication, for example). The &%auth_advertise_hosts%& option can be used
13068 to make these clients more friendly by excluding them from the set of hosts to
13069 which Exim advertises AUTH.
13070
13071 .cindex "AUTH" "advertising when encrypted"
13072 If you want to advertise the availability of AUTH only when the connection
13073 is encrypted using TLS, you can make use of the fact that the value of this
13074 option is expanded, with a setting like this:
13075 .code
13076 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
13077 .endd
13078 .vindex "&$tls_cipher$&"
13079 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
13080 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13081 expansion is *, which matches all hosts.
13082
13083
13084 .option auto_thaw main time 0s
13085 .cindex "thawing messages"
13086 .cindex "unfreezing messages"
13087 If this option is set to a time greater than zero, a queue runner will try a
13088 new delivery attempt on any frozen message, other than a bounce message, if
13089 this much time has passed since it was frozen. This may result in the message
13090 being re-frozen if nothing has changed since the last attempt. It is a way of
13091 saying &"keep on trying, even though there are big problems"&.
13092
13093 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13094 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13095 thought to be very useful any more, and its use should probably be avoided.
13096
13097
13098 .option av_scanner main string "see below"
13099 This option is available if Exim is built with the content-scanning extension.
13100 It specifies which anti-virus scanner to use. The default value is:
13101 .code
13102 sophie:/var/run/sophie
13103 .endd
13104 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13105 before use. See section &<<SECTscanvirus>>& for further details.
13106
13107
13108 .option bi_command main string unset
13109 .oindex "&%-bi%&"
13110 This option supplies the name of a command that is run when Exim is called with
13111 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13112 just the command name, it is not a complete command line. If an argument is
13113 required, it must come from the &%-oA%& command line option.
13114
13115
13116 .option bounce_message_file main string unset
13117 .cindex "bounce message" "customizing"
13118 .cindex "customizing" "bounce message"
13119 This option defines a template file containing paragraphs of text to be used
13120 for constructing bounce messages.  Details of the file's contents are given in
13121 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13122
13123
13124 .option bounce_message_text main string unset
13125 When this option is set, its contents are included in the default bounce
13126 message immediately after &"This message was created automatically by mail
13127 delivery software."& It is not used if &%bounce_message_file%& is set.
13128
13129 .option bounce_return_body main boolean true
13130 .cindex "bounce message" "including body"
13131 This option controls whether the body of an incoming message is included in a
13132 bounce message when &%bounce_return_message%& is true. The default setting
13133 causes the entire message, both header and body, to be returned (subject to the
13134 value of &%bounce_return_size_limit%&). If this option is false, only the
13135 message header is included. In the case of a non-SMTP message containing an
13136 error that is detected during reception, only those header lines preceding the
13137 point at which the error was detected are returned.
13138 .cindex "bounce message" "including original"
13139
13140 .option bounce_return_message main boolean true
13141 If this option is set false, none of the original message is included in
13142 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13143 &%bounce_return_body%&.
13144
13145
13146 .option bounce_return_size_limit main integer 100K
13147 .cindex "size" "of bounce, limit"
13148 .cindex "bounce message" "size limit"
13149 .cindex "limit" "bounce message size"
13150 This option sets a limit in bytes on the size of messages that are returned to
13151 senders as part of bounce messages when &%bounce_return_message%& is true. The
13152 limit should be less than the value of the global &%message_size_limit%& and of
13153 any &%message_size_limit%& settings on transports, to allow for the bounce text
13154 that Exim generates. If this option is set to zero there is no limit.
13155
13156 When the body of any message that is to be included in a bounce message is
13157 greater than the limit, it is truncated, and a comment pointing this out is
13158 added at the top. The actual cutoff may be greater than the value given, owing
13159 to the use of buffering for transferring the message in chunks (typically 8K in
13160 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13161 messages.
13162
13163 .option bounce_sender_authentication main string unset
13164 .cindex "bounce message" "sender authentication"
13165 .cindex "authentication" "bounce message"
13166 .cindex "AUTH" "on bounce message"
13167 This option provides an authenticated sender address that is sent with any
13168 bounce messages generated by Exim that are sent over an authenticated SMTP
13169 connection. A typical setting might be:
13170 .code
13171 bounce_sender_authentication = mailer-daemon@my.domain.example
13172 .endd
13173 which would cause bounce messages to be sent using the SMTP command:
13174 .code
13175 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13176 .endd
13177 The value of &%bounce_sender_authentication%& must always be a complete email
13178 address.
13179
13180 .option callout_domain_negative_expire main time 3h
13181 .cindex "caching" "callout timeouts"
13182 .cindex "callout" "caching timeouts"
13183 This option specifies the expiry time for negative callout cache data for a
13184 domain. See section &<<SECTcallver>>& for details of callout verification, and
13185 section &<<SECTcallvercache>>& for details of the caching.
13186
13187
13188 .option callout_domain_positive_expire main time 7d
13189 This option specifies the expiry time for positive callout cache data for a
13190 domain. See section &<<SECTcallver>>& for details of callout verification, and
13191 section &<<SECTcallvercache>>& for details of the caching.
13192
13193
13194 .option callout_negative_expire main time 2h
13195 This option specifies the expiry time for negative callout cache data for an
13196 address. See section &<<SECTcallver>>& for details of callout verification, and
13197 section &<<SECTcallvercache>>& for details of the caching.
13198
13199
13200 .option callout_positive_expire main time 24h
13201 This option specifies the expiry time for positive callout cache data for an
13202 address. See section &<<SECTcallver>>& for details of callout verification, and
13203 section &<<SECTcallvercache>>& for details of the caching.
13204
13205
13206 .option callout_random_local_part main string&!! "see below"
13207 This option defines the &"random"& local part that can be used as part of
13208 callout verification. The default value is
13209 .code
13210 $primary_hostname-$tod_epoch-testing
13211 .endd
13212 See section &<<CALLaddparcall>>& for details of how this value is used.
13213
13214
13215 .option check_log_inodes main integer 0
13216 See &%check_spool_space%& below.
13217
13218
13219 .option check_log_space main integer 0
13220 See &%check_spool_space%& below.
13221
13222 .oindex "&%check_rfc2047_length%&"
13223 .cindex "RFC 2047" "disabling length check"
13224 .option check_rfc2047_length main boolean true
13225 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13226 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13227 word; strings to be encoded that exceed this length are supposed to use
13228 multiple encoded words. By default, Exim does not recognize encoded words that
13229 exceed the maximum length. However, it seems that some software, in violation
13230 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13231 set false, Exim recognizes encoded words of any length.
13232
13233
13234 .option check_spool_inodes main integer 0
13235 See &%check_spool_space%& below.
13236
13237
13238 .option check_spool_space main integer 0
13239 .cindex "checking disk space"
13240 .cindex "disk space, checking"
13241 .cindex "spool directory" "checking space"
13242 The four &%check_...%& options allow for checking of disk resources before a
13243 message is accepted.
13244
13245 .vindex "&$log_inodes$&"
13246 .vindex "&$log_space$&"
13247 .vindex "&$spool_inodes$&"
13248 .vindex "&$spool_space$&"
13249 When any of these options are set, they apply to all incoming messages. If you
13250 want to apply different checks to different kinds of message, you can do so by
13251 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13252 &$spool_space$& in an ACL with appropriate additional conditions.
13253
13254
13255 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13256 either value is greater than zero, for example:
13257 .code
13258 check_spool_space = 10M
13259 check_spool_inodes = 100
13260 .endd
13261 The spool partition is the one that contains the directory defined by
13262 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13263 transit.
13264
13265 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13266 files are written if either is greater than zero. These should be set only if
13267 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13268
13269 If there is less space or fewer inodes than requested, Exim refuses to accept
13270 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13271 error response to the MAIL command. If ESMTP is in use and there was a
13272 SIZE parameter on the MAIL command, its value is added to the
13273 &%check_spool_space%& value, and the check is performed even if
13274 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13275
13276 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13277 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13278
13279 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13280 failure a message is written to stderr and Exim exits with a non-zero code, as
13281 it obviously cannot send an error message of any kind.
13282
13283 .option daemon_smtp_ports main string &`smtp`&
13284 .cindex "port" "for daemon"
13285 .cindex "TCP/IP" "setting listening ports"
13286 This option specifies one or more default SMTP ports on which the Exim daemon
13287 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13288 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13289
13290 .option daemon_startup_retries main integer 9
13291 .cindex "daemon startup, retrying"
13292 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13293 the daemon at startup when it cannot immediately bind a listening socket
13294 (typically because the socket is already in use): &%daemon_startup_retries%&
13295 defines the number of retries after the first failure, and
13296 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13297
13298 .option daemon_startup_sleep main time 30s
13299 See &%daemon_startup_retries%&.
13300
13301 .option delay_warning main "time list" 24h
13302 .cindex "warning of delay"
13303 .cindex "delay warning, specifying"
13304 When a message is delayed, Exim sends a warning message to the sender at
13305 intervals specified by this option. The data is a colon-separated list of times
13306 after which to send warning messages. If the value of the option is an empty
13307 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13308 message has been on the queue for longer than the last time, the last interval
13309 between the times is used to compute subsequent warning times. For example,
13310 with
13311 .code
13312 delay_warning = 4h:8h:24h
13313 .endd
13314 the first message is sent after 4 hours, the second after 8 hours, and
13315 the third one after 24 hours. After that, messages are sent every 16 hours,
13316 because that is the interval between the last two times on the list. If you set
13317 just one time, it specifies the repeat interval. For example, with:
13318 .code
13319 delay_warning = 6h
13320 .endd
13321 messages are repeated every six hours. To stop warnings after a given time, set
13322 a very large time at the end of the list. For example:
13323 .code
13324 delay_warning = 2h:12h:99d
13325 .endd
13326
13327 .option delay_warning_condition main string&!! "see below"
13328 .vindex "&$domain$&"
13329 The string is expanded at the time a warning message might be sent. If all the
13330 deferred addresses have the same domain, it is set in &$domain$& during the
13331 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13332 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13333 &"false"& (the comparison being done caselessly) then the warning message is
13334 not sent. The default is:
13335 .code
13336 delay_warning_condition = ${if or {\
13337   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13338   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13339   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13340   } {no}{yes}}
13341 .endd
13342 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13343 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13344 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13345 &"auto-replied"& in an &'Auto-Submitted:'& header.
13346
13347 .option deliver_drop_privilege main boolean false
13348 .cindex "unprivileged delivery"
13349 .cindex "delivery" "unprivileged"
13350 If this option is set true, Exim drops its root privilege at the start of a
13351 delivery process, and runs as the Exim user throughout. This severely restricts
13352 the kinds of local delivery that are possible, but is viable in certain types
13353 of configuration. There is a discussion about the use of root privilege in
13354 chapter &<<CHAPsecurity>>&.
13355
13356 .option deliver_queue_load_max main fixed-point unset
13357 .cindex "load average"
13358 .cindex "queue runner" "abandoning"
13359 When this option is set, a queue run is abandoned if the system load average
13360 becomes greater than the value of the option. The option has no effect on
13361 ancient operating systems on which Exim cannot determine the load average.
13362 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13363
13364
13365 .option delivery_date_remove main boolean true
13366 .cindex "&'Delivery-date:'& header line"
13367 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13368 message when it is delivered, in exactly the same way as &'Return-path:'& is
13369 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13370 should not be present in incoming messages, and this option causes them to be
13371 removed at the time the message is received, to avoid any problems that might
13372 occur when a delivered message is subsequently sent on to some other recipient.
13373
13374 .option disable_fsync main boolean false
13375 .cindex "&[fsync()]&, disabling"
13376 This option is available only if Exim was built with the compile-time option
13377 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13378 a runtime configuration generates an &"unknown option"& error. You should not
13379 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13380 really, really, really understand what you are doing. &'No pre-compiled
13381 distributions of Exim should ever make this option available.'&
13382
13383 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13384 updated files' data to be written to disc before continuing. Unexpected events
13385 such as crashes and power outages may cause data to be lost or scrambled.
13386 Here be Dragons. &*Beware.*&
13387
13388
13389 .option disable_ipv6 main boolean false
13390 .cindex "IPv6" "disabling"
13391 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13392 activities take place. AAAA records are never looked up, and any IPv6 addresses
13393 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13394 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13395 to handle IPv6 literal addresses.
13396
13397
13398 .option dns_again_means_nonexist main "domain list&!!" unset
13399 .cindex "DNS" "&""try again""& response; overriding"
13400 DNS lookups give a &"try again"& response for the DNS errors
13401 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13402 keep trying to deliver a message, or to give repeated temporary errors to
13403 incoming mail. Sometimes the effect is caused by a badly set up name server and
13404 may persist for a long time. If a domain which exhibits this problem matches
13405 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13406 This option should be used with care. You can make it apply to reverse lookups
13407 by a setting such as this:
13408 .code
13409 dns_again_means_nonexist = *.in-addr.arpa
13410 .endd
13411 This option applies to all DNS lookups that Exim does. It also applies when the
13412 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13413 since these are most likely to be caused by DNS lookup problems. The
13414 &(dnslookup)& router has some options of its own for controlling what happens
13415 when lookups for MX or SRV records give temporary errors. These more specific
13416 options are applied after this global option.
13417
13418 .option dns_check_names_pattern main string "see below"
13419 .cindex "DNS" "pre-check of name syntax"
13420 When this option is set to a non-empty string, it causes Exim to check domain
13421 names for characters that are not allowed in host names before handing them to
13422 the DNS resolver, because some resolvers give temporary errors for names that
13423 contain unusual characters. If a domain name contains any unwanted characters,
13424 a &"not found"& result is forced, and the resolver is not called. The check is
13425 done by matching the domain name against a regular expression, which is the
13426 value of this option. The default pattern is
13427 .code
13428 dns_check_names_pattern = \
13429   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13430 .endd
13431 which permits only letters, digits, slashes, and hyphens in components, but
13432 they must start and end with a letter or digit. Slashes are not, in fact,
13433 permitted in host names, but they are found in certain NS records (which can be
13434 accessed in Exim by using a &%dnsdb%& lookup). If you set
13435 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13436 empty string.
13437
13438 .option dns_csa_search_limit main integer 5
13439 This option controls the depth of parental searching for CSA SRV records in the
13440 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13441
13442 .option dns_csa_use_reverse main boolean true
13443 This option controls whether or not an IP address, given as a CSA domain, is
13444 reversed and looked up in the reverse DNS, as described in more detail in
13445 section &<<SECTverifyCSA>>&.
13446
13447 .option dns_ipv4_lookup main "domain list&!!" unset
13448 .cindex "IPv6" "DNS lookup for AAAA records"
13449 .cindex "DNS" "IPv6 lookup for AAAA records"
13450 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13451 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13452 (A records) when trying to find IP addresses for hosts, unless the host's
13453 domain matches this list.
13454
13455 This is a fudge to help with name servers that give big delays or otherwise do
13456 not work for the AAAA record type. In due course, when the world's name
13457 servers have all been upgraded, there should be no need for this option.
13458
13459
13460 .option dns_retrans main time 0s
13461 .cindex "DNS" "resolver options"
13462 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13463 retransmission and retry parameters for DNS lookups. Values of zero (the
13464 defaults) leave the system default settings unchanged. The first value is the
13465 time between retries, and the second is the number of retries. It isn't
13466 totally clear exactly how these settings affect the total time a DNS lookup may
13467 take. I haven't found any documentation about timeouts on DNS lookups; these
13468 parameter values are available in the external resolver interface structure,
13469 but nowhere does it seem to describe how they are used or what you might want
13470 to set in them.
13471
13472
13473 .option dns_retry main integer 0
13474 See &%dns_retrans%& above.
13475
13476
13477 .new
13478 .option dns_use_edns0 main integer -1
13479 .cindex "DNS" "resolver options"
13480 .cindex "DNS" "EDNS0"
13481 If this option is set to a non-negative number then Exim will initialise the
13482 DNS resolver library to either use or not use EDNS0 extensions, overriding
13483 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13484 on.
13485
13486 If the resolver library does not support EDNS0 then this option has no effect.
13487 .wen
13488
13489
13490 .option drop_cr main boolean false
13491 This is an obsolete option that is now a no-op. It used to affect the way Exim
13492 handled CR and LF characters in incoming messages. What happens now is
13493 described in section &<<SECTlineendings>>&.
13494
13495 .option dsn_from main "string&!!" "see below"
13496 .cindex "&'From:'& header line" "in bounces"
13497 .cindex "bounce messages" "&'From:'& line, specifying"
13498 This option can be used to vary the contents of &'From:'& header lines in
13499 bounces and other automatically generated messages (&"Delivery Status
13500 Notifications"& &-- hence the name of the option). The default setting is:
13501 .code
13502 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13503 .endd
13504 The value is expanded every time it is needed. If the expansion fails, a
13505 panic is logged, and the default value is used.
13506
13507 .option envelope_to_remove main boolean true
13508 .cindex "&'Envelope-to:'& header line"
13509 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13510 message when it is delivered, in exactly the same way as &'Return-path:'& is
13511 handled. &'Envelope-to:'& records the original recipient address from the
13512 messages's envelope that caused the delivery to happen. Such headers should not
13513 be present in incoming messages, and this option causes them to be removed at
13514 the time the message is received, to avoid any problems that might occur when a
13515 delivered message is subsequently sent on to some other recipient.
13516
13517
13518 .option errors_copy main "string list&!!" unset
13519 .cindex "bounce message" "copy to other address"
13520 .cindex "copy of bounce message"
13521 Setting this option causes Exim to send bcc copies of bounce messages that it
13522 generates to other addresses. &*Note*&: This does not apply to bounce messages
13523 coming from elsewhere. The value of the option is a colon-separated list of
13524 items. Each item consists of a pattern, terminated by white space, followed by
13525 a comma-separated list of email addresses. If a pattern contains spaces, it
13526 must be enclosed in double quotes.
13527
13528 Each pattern is processed in the same way as a single item in an address list
13529 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13530 the bounce message, the message is copied to the addresses on the list. The
13531 items are scanned in order, and once a matching one is found, no further items
13532 are examined. For example:
13533 .code
13534 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13535               rqps@mydomain   hostmaster@mydomain.example,\
13536                               postmaster@mydomain.example
13537 .endd
13538 .vindex "&$domain$&"
13539 .vindex "&$local_part$&"
13540 The address list is expanded before use. The expansion variables &$local_part$&
13541 and &$domain$& are set from the original recipient of the error message, and if
13542 there was any wildcard matching in the pattern, the expansion
13543 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13544 variables &$0$&, &$1$&, etc. are set in the normal way.
13545
13546
13547 .option errors_reply_to main string unset
13548 .cindex "bounce message" "&'Reply-to:'& in"
13549 By default, Exim's bounce and delivery warning messages contain the header line
13550 .display
13551 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13552 .endd
13553 .oindex &%quota_warn_message%&
13554 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13555 A warning message that is generated by the &%quota_warn_message%& option in an
13556 &(appendfile)& transport may contain its own &'From:'& header line that
13557 overrides the default.
13558
13559 Experience shows that people reply to bounce messages. If the
13560 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13561 and warning messages. For example:
13562 .code
13563 errors_reply_to = postmaster@my.domain.example
13564 .endd
13565 The value of the option is not expanded. It must specify a valid RFC 2822
13566 address. However, if a warning message that is generated by the
13567 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13568 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13569 not used.
13570
13571
13572 .option exim_group main string "compile-time configured"
13573 .cindex "gid (group id)" "Exim's own"
13574 .cindex "Exim group"
13575 This option changes the gid under which Exim runs when it gives up root
13576 privilege. The default value is compiled into the binary. The value of this
13577 option is used only when &%exim_user%& is also set. Unless it consists entirely
13578 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13579 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13580 security issues.
13581
13582
13583 .option exim_path main string "see below"
13584 .cindex "Exim binary, path name"
13585 This option specifies the path name of the Exim binary, which is used when Exim
13586 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13587 the directory configured at compile time by the BIN_DIRECTORY setting. It
13588 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13589 other place.
13590 &*Warning*&: Do not use a macro to define the value of this option, because
13591 you will break those Exim utilities that scan the configuration file to find
13592 where the binary is. (They then use the &%-bP%& option to extract option
13593 settings such as the value of &%spool_directory%&.)
13594
13595
13596 .option exim_user main string "compile-time configured"
13597 .cindex "uid (user id)" "Exim's own"
13598 .cindex "Exim user"
13599 This option changes the uid under which Exim runs when it gives up root
13600 privilege. The default value is compiled into the binary. Ownership of the run
13601 time configuration file and the use of the &%-C%& and &%-D%& command line
13602 options is checked against the values in the binary, not what is set here.
13603
13604 Unless it consists entirely of digits, the string is looked up using
13605 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13606 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13607 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13608
13609
13610 .option extra_local_interfaces main "string list" unset
13611 This option defines network interfaces that are to be considered local when
13612 routing, but which are not used for listening by the daemon. See section
13613 &<<SECTreclocipadd>>& for details.
13614
13615
13616 . Allow this long option name to split; give it unsplit as a fifth argument
13617 . for the automatic .oindex that is generated by .option.
13618
13619 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13620          extract_addresses_remove_arguments
13621 .oindex "&%-t%&"
13622 .cindex "command line" "addresses with &%-t%&"
13623 .cindex "Sendmail compatibility" "&%-t%& option"
13624 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13625 are present on the command line when the &%-t%& option is used to build an
13626 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13627 line addresses are removed from the recipients list. This is also how Smail
13628 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13629 command line addresses are added to those obtained from the header lines. When
13630 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13631 argument headers. If it is set false, Exim adds rather than removes argument
13632 addresses.
13633
13634
13635 .option finduser_retries main integer 0
13636 .cindex "NIS, retrying user lookups"
13637 On systems running NIS or other schemes in which user and group information is
13638 distributed from a remote system, there can be times when &[getpwnam()]& and
13639 related functions fail, even when given valid data, because things time out.
13640 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13641 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13642 many extra times to find a user or a group, waiting for one second between
13643 retries.
13644
13645 .cindex "&_/etc/passwd_&" "multiple reading of"
13646 You should not set this option greater than zero if your user information is in
13647 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13648 search the file multiple times for non-existent users, and also cause delay.
13649
13650
13651
13652 .option freeze_tell main "string list, comma separated" unset
13653 .cindex "freezing messages" "sending a message when freezing"
13654 On encountering certain errors, or when configured to do so in a system filter,
13655 ACL, or special router, Exim freezes a message. This means that no further
13656 delivery attempts take place until an administrator thaws the message, or the
13657 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13658 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13659 warning message whenever it freezes something, unless the message it is
13660 freezing is a locally-generated bounce message. (Without this exception there
13661 is the possibility of looping.) The warning message is sent to the addresses
13662 supplied as the comma-separated value of this option. If several of the
13663 message's addresses cause freezing, only a single message is sent. If the
13664 freezing was automatic, the reason(s) for freezing can be found in the message
13665 log. If you configure freezing in a filter or ACL, you must arrange for any
13666 logging that you require.
13667
13668
13669 .option gecos_name main string&!! unset
13670 .cindex "HP-UX"
13671 .cindex "&""gecos""& field, parsing"
13672 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13673 password file to hold other information in addition to users' real names. Exim
13674 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13675 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13676 of the field are used unchanged, except that, if an ampersand is encountered,
13677 it is replaced by the user's login name with the first character forced to
13678 upper case, since this is a convention that is observed on many systems.
13679
13680 When these options are set, &%gecos_pattern%& is treated as a regular
13681 expression that is to be applied to the field (again with && replaced by the
13682 login name), and if it matches, &%gecos_name%& is expanded and used as the
13683 user's name.
13684
13685 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13686 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13687 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13688 name terminates at the first comma, the following can be used:
13689 .code
13690 gecos_pattern = ([^,]*)
13691 gecos_name = $1
13692 .endd
13693
13694 .option gecos_pattern main string unset
13695 See &%gecos_name%& above.
13696
13697
13698 .option gnutls_compat_mode main boolean unset
13699 This option controls whether GnuTLS is used in compatibility mode in an Exim
13700 server. This reduces security slightly, but improves interworking with older
13701 implementations of TLS.
13702
13703 .option headers_charset main string "see below"
13704 This option sets a default character set for translating from encoded MIME
13705 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13706 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13707 ultimate default is ISO-8859-1. For more details see the description of header
13708 insertions in section &<<SECTexpansionitems>>&.
13709
13710
13711
13712 .option header_maxsize main integer "see below"
13713 .cindex "header section" "maximum size of"
13714 .cindex "limit" "size of message header section"
13715 This option controls the overall maximum size of a message's header
13716 section. The default is the value of HEADER_MAXSIZE in
13717 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13718 sections are rejected.
13719
13720
13721 .option header_line_maxsize main integer 0
13722 .cindex "header lines" "maximum size of"
13723 .cindex "limit" "size of one header line"
13724 This option limits the length of any individual header line in a message, after
13725 all the continuations have been joined together. Messages with individual
13726 header lines that are longer than the limit are rejected. The default value of
13727 zero means &"no limit"&.
13728
13729
13730
13731
13732 .option helo_accept_junk_hosts main "host list&!!" unset
13733 .cindex "HELO" "accepting junk data"
13734 .cindex "EHLO" "accepting junk data"
13735 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13736 mail, and gives an error response for invalid data. Unfortunately, there are
13737 some SMTP clients that send syntactic junk. They can be accommodated by setting
13738 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13739 if you want to do semantic checking.
13740 See also &%helo_allow_chars%& for a way of extending the permitted character
13741 set.
13742
13743
13744 .option helo_allow_chars main string unset
13745 .cindex "HELO" "underscores in"
13746 .cindex "EHLO" "underscores in"
13747 .cindex "underscore in EHLO/HELO"
13748 This option can be set to a string of rogue characters that are permitted in
13749 all EHLO and HELO names in addition to the standard letters, digits,
13750 hyphens, and dots. If you really must allow underscores, you can set
13751 .code
13752 helo_allow_chars = _
13753 .endd
13754 Note that the value is one string, not a list.
13755
13756
13757 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13758 .cindex "HELO" "forcing reverse lookup"
13759 .cindex "EHLO" "forcing reverse lookup"
13760 If the domain given by a client in a HELO or EHLO command matches this
13761 list, a reverse lookup is done in order to establish the host's true name. The
13762 default forces a lookup if the client host gives the server's name or any of
13763 its IP addresses (in brackets), something that broken clients have been seen to
13764 do.
13765
13766
13767 .option helo_try_verify_hosts main "host list&!!" unset
13768 .cindex "HELO verifying" "optional"
13769 .cindex "EHLO" "verifying, optional"
13770 By default, Exim just checks the syntax of HELO and EHLO commands (see
13771 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13772 to do more extensive checking of the data supplied by these commands. The ACL
13773 condition &`verify = helo`& is provided to make this possible.
13774 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13775 to force the check to occur. From release 4.53 onwards, this is no longer
13776 necessary. If the check has not been done before &`verify = helo`& is
13777 encountered, it is done at that time. Consequently, this option is obsolete.
13778 Its specification is retained here for backwards compatibility.
13779
13780 When an EHLO or HELO command is received, if the calling host matches
13781 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13782 EHLO command either:
13783
13784 .ilist
13785 is an IP literal matching the calling address of the host, or
13786 .next
13787 .cindex "DNS" "reverse lookup"
13788 .cindex "reverse DNS lookup"
13789 matches the host name that Exim obtains by doing a reverse lookup of the
13790 calling host address, or
13791 .next
13792 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13793 available) yields the calling host address.
13794 .endlist
13795
13796 However, the EHLO or HELO command is not rejected if any of the checks
13797 fail. Processing continues, but the result of the check is remembered, and can
13798 be detected later in an ACL by the &`verify = helo`& condition.
13799
13800 .option helo_verify_hosts main "host list&!!" unset
13801 .cindex "HELO verifying" "mandatory"
13802 .cindex "EHLO" "verifying, mandatory"
13803 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13804 backwards compatibility. For hosts that match this option, Exim checks the host
13805 name given in the HELO or EHLO in the same way as for
13806 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13807 rejected with a 550 error, and entries are written to the main and reject logs.
13808 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13809 error.
13810
13811 .option hold_domains main "domain list&!!" unset
13812 .cindex "domain" "delaying delivery"
13813 .cindex "delivery" "delaying certain domains"
13814 This option allows mail for particular domains to be held on the queue
13815 manually. The option is overridden if a message delivery is forced with the
13816 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13817 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13818 item in &%hold_domains%&, no routing or delivery for that address is done, and
13819 it is deferred every time the message is looked at.
13820
13821 This option is intended as a temporary operational measure for delaying the
13822 delivery of mail while some problem is being sorted out, or some new
13823 configuration tested. If you just want to delay the processing of some
13824 domains until a queue run occurs, you should use &%queue_domains%& or
13825 &%queue_smtp_domains%&, not &%hold_domains%&.
13826
13827 A setting of &%hold_domains%& does not override Exim's code for removing
13828 messages from the queue if they have been there longer than the longest retry
13829 time in any retry rule. If you want to hold messages for longer than the normal
13830 retry times, insert a dummy retry rule with a long retry time.
13831
13832
13833 .option host_lookup main "host list&!!" unset
13834 .cindex "host name" "lookup, forcing"
13835 Exim does not look up the name of a calling host from its IP address unless it
13836 is required to compare against some host list, or the host matches
13837 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13838 option (which normally contains IP addresses rather than host names). The
13839 default configuration file contains
13840 .code
13841 host_lookup = *
13842 .endd
13843 which causes a lookup to happen for all hosts. If the expense of these lookups
13844 is felt to be too great, the setting can be changed or removed.
13845
13846 After a successful reverse lookup, Exim does a forward lookup on the name it
13847 has obtained, to verify that it yields the IP address that it started with. If
13848 this check fails, Exim behaves as if the name lookup failed.
13849
13850 .vindex "&$host_lookup_failed$&"
13851 .vindex "&$sender_host_name$&"
13852 After any kind of failure, the host name (in &$sender_host_name$&) remains
13853 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13854 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13855 &`verify = reverse_host_lookup`& in ACLs.
13856
13857
13858 .option host_lookup_order main "string list" &`bydns:byaddr`&
13859 This option specifies the order of different lookup methods when Exim is trying
13860 to find a host name from an IP address. The default is to do a DNS lookup
13861 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13862 if that fails. You can change the order of these lookups, or omit one entirely,
13863 if you want.
13864
13865 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13866 multiple PTR records in the DNS and the IP address is not listed in
13867 &_/etc/hosts_&. Different operating systems give different results in this
13868 case. That is why the default tries a DNS lookup first.
13869
13870
13871
13872 .option host_reject_connection main "host list&!!" unset
13873 .cindex "host" "rejecting connections from"
13874 If this option is set, incoming SMTP calls from the hosts listed are rejected
13875 as soon as the connection is made.
13876 This option is obsolete, and retained only for backward compatibility, because
13877 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13878 connections immediately.
13879
13880 The ability to give an immediate rejection (either by this option or using an
13881 ACL) is provided for use in unusual cases. Many hosts will just try again,
13882 sometimes without much delay. Normally, it is better to use an ACL to reject
13883 incoming messages at a later stage, such as after RCPT commands. See
13884 chapter &<<CHAPACL>>&.
13885
13886
13887 .option hosts_connection_nolog main "host list&!!" unset
13888 .cindex "host" "not logging connections from"
13889 This option defines a list of hosts for which connection logging does not
13890 happen, even though the &%smtp_connection%& log selector is set. For example,
13891 you might want not to log SMTP connections from local processes, or from
13892 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13893 the daemon; you should therefore strive to restrict its value to a short inline
13894 list of IP addresses and networks. To disable logging SMTP connections from
13895 local processes, you must create a host list with an empty item. For example:
13896 .code
13897 hosts_connection_nolog = :
13898 .endd
13899 If the &%smtp_connection%& log selector is not set, this option has no effect.
13900
13901
13902
13903 .option hosts_treat_as_local main "domain list&!!" unset
13904 .cindex "local host" "domains treated as"
13905 .cindex "host" "treated as local"
13906 If this option is set, any host names that match the domain list are treated as
13907 if they were the local host when Exim is scanning host lists obtained from MX
13908 records
13909 or other sources. Note that the value of this option is a domain list, not a
13910 host list, because it is always used to check host names, not IP addresses.
13911
13912 This option also applies when Exim is matching the special items
13913 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13914 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13915 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13916 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13917 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13918 interfaces and recognizing the local host.
13919
13920
13921 .option ibase_servers main "string list" unset
13922 .cindex "InterBase" "server list"
13923 This option provides a list of InterBase servers and associated connection data,
13924 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13925 The option is available only if Exim has been built with InterBase support.
13926
13927
13928
13929 .option ignore_bounce_errors_after main time 10w
13930 .cindex "bounce message" "discarding"
13931 .cindex "discarding bounce message"
13932 This option affects the processing of bounce messages that cannot be delivered,
13933 that is, those that suffer a permanent delivery failure. (Bounce messages that
13934 suffer temporary delivery failures are of course retried in the usual way.)
13935
13936 After a permanent delivery failure, bounce messages are frozen,
13937 because there is no sender to whom they can be returned. When a frozen bounce
13938 message has been on the queue for more than the given time, it is unfrozen at
13939 the next queue run, and a further delivery is attempted. If delivery fails
13940 again, the bounce message is discarded. This makes it possible to keep failed
13941 bounce messages around for a shorter time than the normal maximum retry time
13942 for frozen messages. For example,
13943 .code
13944 ignore_bounce_errors_after = 12h
13945 .endd
13946 retries failed bounce message deliveries after 12 hours, discarding any further
13947 failures. If the value of this option is set to a zero time period, bounce
13948 failures are discarded immediately. Setting a very long time (as in the default
13949 value) has the effect of disabling this option. For ways of automatically
13950 dealing with other kinds of frozen message, see &%auto_thaw%& and
13951 &%timeout_frozen_after%&.
13952
13953
13954 .option ignore_fromline_hosts main "host list&!!" unset
13955 .cindex "&""From""& line"
13956 .cindex "UUCP" "&""From""& line"
13957 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13958 the headers of a message. By default this is treated as the start of the
13959 message's body, which means that any following headers are not recognized as
13960 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13961 match those hosts that insist on sending it. If the sender is actually a local
13962 process rather than a remote host, and is using &%-bs%& to inject the messages,
13963 &%ignore_fromline_local%& must be set to achieve this effect.
13964
13965
13966 .option ignore_fromline_local main boolean false
13967 See &%ignore_fromline_hosts%& above.
13968
13969
13970 .option keep_malformed main time 4d
13971 This option specifies the length of time to keep messages whose spool files
13972 have been corrupted in some way. This should, of course, never happen. At the
13973 next attempt to deliver such a message, it gets removed. The incident is
13974 logged.
13975
13976
13977 .option ldap_ca_cert_dir main string unset
13978 .cindex "LDAP", "TLS CA certificate directory"
13979 This option indicates which directory contains CA certificates for verifying
13980 a TLS certificate presented by an LDAP server.
13981 While Exim does not provide a default value, your SSL library may.
13982 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13983 and constrained to be a directory.
13984
13985
13986 .option ldap_ca_cert_file main string unset
13987 .cindex "LDAP", "TLS CA certificate file"
13988 This option indicates which file contains CA certificates for verifying
13989 a TLS certificate presented by an LDAP server.
13990 While Exim does not provide a default value, your SSL library may.
13991 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13992 and constrained to be a file.
13993
13994
13995 .option ldap_cert_file main string unset
13996 .cindex "LDAP" "TLS client certificate file"
13997 This option indicates which file contains an TLS client certificate which
13998 Exim should present to the LDAP server during TLS negotiation.
13999 Should be used together with &%ldap_cert_key%&.
14000
14001
14002 .option ldap_cert_key main string unset
14003 .cindex "LDAP" "TLS client key file"
14004 This option indicates which file contains the secret/private key to use
14005 to prove identity to the LDAP server during TLS negotiation.
14006 Should be used together with &%ldap_cert_file%&, which contains the
14007 identity to be proven.
14008
14009
14010 .option ldap_cipher_suite main string unset
14011 .cindex "LDAP" "TLS cipher suite"
14012 This controls the TLS cipher-suite negotiation during TLS negotiation with
14013 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14014 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14015
14016
14017 .option ldap_default_servers main "string list" unset
14018 .cindex "LDAP" "default servers"
14019 This option provides a list of LDAP servers which are tried in turn when an
14020 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14021 details of LDAP queries. This option is available only when Exim has been built
14022 with LDAP support.
14023
14024
14025 .option ldap_require_cert main string unset.
14026 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14027 This should be one of the values "hard", "demand", "allow", "try" or "never".
14028 A value other than one of these is interpreted as "never".
14029 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14030 Although Exim does not set a default, the LDAP library probably defaults
14031 to hard/demand.
14032
14033
14034 .option ldap_start_tls main boolean false
14035 .cindex "LDAP" "whether or not to negotiate TLS"
14036 If set, Exim will attempt to negotiate TLS with the LDAP server when
14037 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14038 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14039 of SSL-on-connect.
14040 In the event of failure to negotiate TLS, the action taken is controlled
14041 by &%ldap_require_cert%&.
14042
14043
14044 .option ldap_version main integer unset
14045 .cindex "LDAP" "protocol version, forcing"
14046 This option can be used to force Exim to set a specific protocol version for
14047 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14048 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14049 the LDAP headers; otherwise it is 2. This option is available only when Exim
14050 has been built with LDAP support.
14051
14052
14053
14054 .option local_from_check main boolean true
14055 .cindex "&'Sender:'& header line" "disabling addition of"
14056 .cindex "&'From:'& header line" "disabling checking of"
14057 When a message is submitted locally (that is, not over a TCP/IP connection) by
14058 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14059 checks that the &'From:'& header line matches the login of the calling user and
14060 the domain specified by &%qualify_domain%&.
14061
14062 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14063 locally submitted message is automatically qualified by Exim, unless the
14064 &%-bnq%& command line option is used.
14065
14066 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14067 on the local part. If the &'From:'& header line does not match, Exim adds a
14068 &'Sender:'& header with an address constructed from the calling user's login
14069 and the default qualify domain.
14070
14071 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14072 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14073 &'Sender:'& header lines supplied by untrusted users, you must also set
14074 &%local_sender_retain%& to be true.
14075
14076 .cindex "envelope sender"
14077 These options affect only the header lines in the message. The envelope sender
14078 is still forced to be the login id at the qualify domain unless
14079 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14080
14081 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14082 request similar header line checking. See section &<<SECTthesenhea>>&, which
14083 has more details about &'Sender:'& processing.
14084
14085
14086
14087
14088 .option local_from_prefix main string unset
14089 When Exim checks the &'From:'& header line of locally submitted messages for
14090 matching the login id (see &%local_from_check%& above), it can be configured to
14091 ignore certain prefixes and suffixes in the local part of the address. This is
14092 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14093 appropriate lists, in the same form as the &%local_part_prefix%& and
14094 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14095 example, if
14096 .code
14097 local_from_prefix = *-
14098 .endd
14099 is set, a &'From:'& line containing
14100 .code
14101 From: anything-user@your.domain.example
14102 .endd
14103 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14104 matches the actual sender address that is constructed from the login name and
14105 qualify domain.
14106
14107
14108 .option local_from_suffix main string unset
14109 See &%local_from_prefix%& above.
14110
14111
14112 .option local_interfaces main "string list" "see below"
14113 This option controls which network interfaces are used by the daemon for
14114 listening; they are also used to identify the local host when routing. Chapter
14115 &<<CHAPinterfaces>>& contains a full description of this option and the related
14116 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14117 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14118 &%local_interfaces%& is
14119 .code
14120 local_interfaces = 0.0.0.0
14121 .endd
14122 when Exim is built without IPv6 support; otherwise it is
14123 .code
14124 local_interfaces = <; ::0 ; 0.0.0.0
14125 .endd
14126
14127 .option local_scan_timeout main time 5m
14128 .cindex "timeout" "for &[local_scan()]& function"
14129 .cindex "&[local_scan()]& function" "timeout"
14130 This timeout applies to the &[local_scan()]& function (see chapter
14131 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14132 the incoming message is rejected with a temporary error if it is an SMTP
14133 message. For a non-SMTP message, the message is dropped and Exim ends with a
14134 non-zero code. The incident is logged on the main and reject logs.
14135
14136
14137
14138 .option local_sender_retain main boolean false
14139 .cindex "&'Sender:'& header line" "retaining from local submission"
14140 When a message is submitted locally (that is, not over a TCP/IP connection) by
14141 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14142 do not want this to happen, you must set &%local_sender_retain%&, and you must
14143 also set &%local_from_check%& to be false (Exim will complain if you do not).
14144 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14145 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14146
14147
14148
14149
14150 .option localhost_number main string&!! unset
14151 .cindex "host" "locally unique number for"
14152 .cindex "message ids" "with multiple hosts"
14153 .vindex "&$localhost_number$&"
14154 Exim's message ids are normally unique only within the local host. If
14155 uniqueness among a set of hosts is required, each host must set a different
14156 value for the &%localhost_number%& option. The string is expanded immediately
14157 after reading the configuration file (so that a number can be computed from the
14158 host name, for example) and the result of the expansion must be a number in the
14159 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14160 systems). This is available in subsequent string expansions via the variable
14161 &$localhost_number$&. When &%localhost_number is set%&, the final two
14162 characters of the message id, instead of just being a fractional part of the
14163 time, are computed from the time and the local host number as described in
14164 section &<<SECTmessiden>>&.
14165
14166
14167
14168 .option log_file_path main "string list&!!" "set at compile time"
14169 .cindex "log" "file path for"
14170 This option sets the path which is used to determine the names of Exim's log
14171 files, or indicates that logging is to be to syslog, or both. It is expanded
14172 when Exim is entered, so it can, for example, contain a reference to the host
14173 name. If no specific path is set for the log files at compile or run time, they
14174 are written in a sub-directory called &_log_& in Exim's spool directory.
14175 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14176 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14177 used. If this string is fixed at your installation (contains no expansion
14178 variables) it is recommended that you do not set this option in the
14179 configuration file, but instead supply the path using LOG_FILE_PATH in
14180 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14181 early on &-- in particular, failure to read the configuration file.
14182
14183
14184 .option log_selector main string unset
14185 .cindex "log" "selectors"
14186 This option can be used to reduce or increase the number of things that Exim
14187 writes to its log files. Its argument is made up of names preceded by plus or
14188 minus characters. For example:
14189 .code
14190 log_selector = +arguments -retry_defer
14191 .endd
14192 A list of possible names and what they control is given in the chapter on
14193 logging, in section &<<SECTlogselector>>&.
14194
14195
14196 .option log_timezone main boolean false
14197 .cindex "log" "timezone for entries"
14198 .vindex "&$tod_log$&"
14199 .vindex "&$tod_zone$&"
14200 By default, the timestamps on log lines are in local time without the
14201 timezone. This means that if your timezone changes twice a year, the timestamps
14202 in log lines are ambiguous for an hour when the clocks go back. One way of
14203 avoiding this problem is to set the timezone to UTC. An alternative is to set
14204 &%log_timezone%& true. This turns on the addition of the timezone offset to
14205 timestamps in log lines. Turning on this option can add quite a lot to the size
14206 of log files because each line is extended by 6 characters. Note that the
14207 &$tod_log$& variable contains the log timestamp without the zone, but there is
14208 another variable called &$tod_zone$& that contains just the timezone offset.
14209
14210
14211 .option lookup_open_max main integer 25
14212 .cindex "too many open files"
14213 .cindex "open files, too many"
14214 .cindex "file" "too many open"
14215 .cindex "lookup" "maximum open files"
14216 .cindex "limit" "open files for lookups"
14217 This option limits the number of simultaneously open files for single-key
14218 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14219 Exim normally keeps these files open during routing, because often the same
14220 file is required several times. If the limit is reached, Exim closes the least
14221 recently used file. Note that if you are using the &'ndbm'& library, it
14222 actually opens two files for each logical DBM database, though it still counts
14223 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14224 open files"& errors with NDBM, you need to reduce the value of
14225 &%lookup_open_max%&.
14226
14227
14228 .option max_username_length main integer 0
14229 .cindex "length of login name"
14230 .cindex "user name" "maximum length"
14231 .cindex "limit" "user name length"
14232 Some operating systems are broken in that they truncate long arguments to
14233 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14234 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14235 an argument that is longer behaves as if &[getpwnam()]& failed.
14236
14237
14238 .option message_body_newlines main bool false
14239 .cindex "message body" "newlines in variables"
14240 .cindex "newline" "in message body variables"
14241 .vindex "&$message_body$&"
14242 .vindex "&$message_body_end$&"
14243 By default, newlines in the message body are replaced by spaces when setting
14244 the &$message_body$& and &$message_body_end$& expansion variables. If this
14245 option is set true, this no longer happens.
14246
14247
14248 .option message_body_visible main integer 500
14249 .cindex "body of message" "visible size"
14250 .cindex "message body" "visible size"
14251 .vindex "&$message_body$&"
14252 .vindex "&$message_body_end$&"
14253 This option specifies how much of a message's body is to be included in the
14254 &$message_body$& and &$message_body_end$& expansion variables.
14255
14256
14257 .option message_id_header_domain main string&!! unset
14258 .cindex "&'Message-ID:'& header line"
14259 If this option is set, the string is expanded and used as the right hand side
14260 (domain) of the &'Message-ID:'& header that Exim creates if a
14261 locally-originated incoming message does not have one. &"Locally-originated"&
14262 means &"not received over TCP/IP."&
14263 Otherwise, the primary host name is used.
14264 Only letters, digits, dot and hyphen are accepted; any other characters are
14265 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14266 empty string, the option is ignored.
14267
14268
14269 .option message_id_header_text main string&!! unset
14270 If this variable is set, the string is expanded and used to augment the text of
14271 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14272 message does not have one. The text of this header is required by RFC 2822 to
14273 take the form of an address. By default, Exim uses its internal message id as
14274 the local part, and the primary host name as the domain. If this option is set,
14275 it is expanded, and provided the expansion is not forced to fail, and does not
14276 yield an empty string, the result is inserted into the header immediately
14277 before the @, separated from the internal message id by a dot. Any characters
14278 that are illegal in an address are automatically converted into hyphens. This
14279 means that variables such as &$tod_log$& can be used, because the spaces and
14280 colons will become hyphens.
14281
14282
14283 .option message_logs main boolean true
14284 .cindex "message logs" "disabling"
14285 .cindex "log" "message log; disabling"
14286 If this option is turned off, per-message log files are not created in the
14287 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14288 Exim, by reducing the number of files involved in handling a message from a
14289 minimum of four (header spool file, body spool file, delivery journal, and
14290 per-message log) to three. The other major I/O activity is Exim's main log,
14291 which is not affected by this option.
14292
14293
14294 .option message_size_limit main string&!! 50M
14295 .cindex "message" "size limit"
14296 .cindex "limit" "message size"
14297 .cindex "size" "of message, limit"
14298 This option limits the maximum size of message that Exim will process. The
14299 value is expanded for each incoming connection so, for example, it can be made
14300 to depend on the IP address of the remote host for messages arriving via
14301 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14302 optionally followed by K or M.
14303
14304 &*Note*&: This limit cannot be made to depend on a message's sender or any
14305 other properties of an individual message, because it has to be advertised in
14306 the server's response to EHLO. String expansion failure causes a temporary
14307 error. A value of zero means no limit, but its use is not recommended. See also
14308 &%bounce_return_size_limit%&.
14309
14310 Incoming SMTP messages are failed with a 552 error if the limit is
14311 exceeded; locally-generated messages either get a stderr message or a delivery
14312 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14313 an oversized message is logged in both the main and the reject logs. See also
14314 the generic transport option &%message_size_limit%&, which limits the size of
14315 message that an individual transport can process.
14316
14317 If you use a virus-scanner and set this option to to a value larger than the
14318 maximum size that your virus-scanner is configured to support, you may get
14319 failures triggered by large mails.  The right size to configure for the
14320 virus-scanner depends upon what data is passed and the options in use but it's
14321 probably safest to just set it to a little larger than this value.  Eg, with a
14322 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14323 some problems may result.
14324
14325 A value of 0 will disable size limit checking; Exim will still advertise the
14326 SIZE extension in an EHLO response, but without a limit, so as to permit
14327 SMTP clients to still indicate the message size along with the MAIL verb.
14328
14329
14330 .option move_frozen_messages main boolean false
14331 .cindex "frozen messages" "moving"
14332 This option, which is available only if Exim has been built with the setting
14333 .code
14334 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14335 .endd
14336 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14337 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14338 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14339 standard utilities for handling such moved messages, and they do not show up in
14340 lists generated by &%-bp%& or by the Exim monitor.
14341
14342
14343 .option mua_wrapper main boolean false
14344 Setting this option true causes Exim to run in a very restrictive mode in which
14345 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14346 contains a full description of this facility.
14347
14348
14349
14350 .option mysql_servers main "string list" unset
14351 .cindex "MySQL" "server list"
14352 This option provides a list of MySQL servers and associated connection data, to
14353 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14354 option is available only if Exim has been built with MySQL support.
14355
14356
14357 .option never_users main "string list&!!" unset
14358 This option is expanded just once, at the start of Exim's processing. Local
14359 message deliveries are normally run in processes that are setuid to the
14360 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14361 It is usually desirable to prevent any deliveries from running as root, as a
14362 safety precaution.
14363
14364 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14365 list of users that must not be used for local deliveries. This list is fixed in
14366 the binary and cannot be overridden by the configuration file. By default, it
14367 contains just the single user name &"root"&. The &%never_users%& runtime option
14368 can be used to add more users to the fixed list.
14369
14370 If a message is to be delivered as one of the users on the fixed list or the
14371 &%never_users%& list, an error occurs, and delivery is deferred. A common
14372 example is
14373 .code
14374 never_users = root:daemon:bin
14375 .endd
14376 Including root is redundant if it is also on the fixed list, but it does no
14377 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14378 transport driver.
14379
14380
14381 .option openssl_options main "string list" unset
14382 .cindex "OpenSSL "compatibility options"
14383 This option allows an administrator to adjust the SSL options applied
14384 by OpenSSL to connections.  It is given as a space-separated list of items,
14385 each one to be +added or -subtracted from the current value.
14386
14387 This option is only available if Exim is built against OpenSSL.  The values
14388 available for this option vary according to the age of your OpenSSL install.
14389 The &"all"& value controls a subset of flags which are available, typically
14390 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14391 list the values known on your system and Exim should support all the
14392 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14393 names lose the leading &"SSL_OP_"& and are lower-cased.
14394
14395 Note that adjusting the options can have severe impact upon the security of
14396 SSL as used by Exim.  It is possible to disable safety checks and shoot
14397 yourself in the foot in various unpleasant ways.  This option should not be
14398 adjusted lightly.  An unrecognised item will be detected at startup, by
14399 invoking Exim with the &%-bV%& flag.
14400
14401 .new
14402 Historical note: prior to release 4.78, Exim defaulted this value to
14403 "+dont_insert_empty_fragments", which may still be needed for compatibility
14404 with some clients, but which lowers security by increasing exposure to
14405 some now infamous attacks.
14406 .wen
14407
14408 An example:
14409 .code
14410 # Make both old MS and old Eudora happy:
14411 openssl_options = -all +microsoft_big_sslv3_buffer \
14412                        +dont_insert_empty_fragments
14413 .endd
14414
14415 Possible options may include:
14416 .ilist
14417 &`all`&
14418 .next
14419 &`allow_unsafe_legacy_renegotiation`&
14420 .next
14421 &`cipher_server_preference`&
14422 .next
14423 &`dont_insert_empty_fragments`&
14424 .next
14425 &`ephemeral_rsa`&
14426 .next
14427 &`legacy_server_connect`&
14428 .next
14429 &`microsoft_big_sslv3_buffer`&
14430 .next
14431 &`microsoft_sess_id_bug`&
14432 .next
14433 &`msie_sslv2_rsa_padding`&
14434 .next
14435 &`netscape_challenge_bug`&
14436 .next
14437 &`netscape_reuse_cipher_change_bug`&
14438 .next
14439 &`no_compression`&
14440 .next
14441 &`no_session_resumption_on_renegotiation`&
14442 .next
14443 &`no_sslv2`&
14444 .next
14445 &`no_sslv3`&
14446 .next
14447 &`no_ticket`&
14448 .next
14449 &`no_tlsv1`&
14450 .next
14451 &`no_tlsv1_1`&
14452 .next
14453 &`no_tlsv1_2`&
14454 .next
14455 &`single_dh_use`&
14456 .next
14457 &`single_ecdh_use`&
14458 .next
14459 &`ssleay_080_client_dh_bug`&
14460 .next
14461 &`sslref2_reuse_cert_type_bug`&
14462 .next
14463 &`tls_block_padding_bug`&
14464 .next
14465 &`tls_d5_bug`&
14466 .next
14467 &`tls_rollback_bug`&
14468 .endlist
14469
14470
14471 .option oracle_servers main "string list" unset
14472 .cindex "Oracle" "server list"
14473 This option provides a list of Oracle servers and associated connection data,
14474 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14475 The option is available only if Exim has been built with Oracle support.
14476
14477
14478 .option percent_hack_domains main "domain list&!!" unset
14479 .cindex "&""percent hack""&"
14480 .cindex "source routing" "in email address"
14481 .cindex "address" "source-routed"
14482 The &"percent hack"& is the convention whereby a local part containing a
14483 percent sign is re-interpreted as a new email address, with the percent
14484 replaced by @. This is sometimes called &"source routing"&, though that term is
14485 also applied to RFC 2822 addresses that begin with an @ character. If this
14486 option is set, Exim implements the percent facility for those domains listed,
14487 but no others. This happens before an incoming SMTP address is tested against
14488 an ACL.
14489
14490 &*Warning*&: The &"percent hack"& has often been abused by people who are
14491 trying to get round relaying restrictions. For this reason, it is best avoided
14492 if at all possible. Unfortunately, a number of less security-conscious MTAs
14493 implement it unconditionally. If you are running Exim on a gateway host, and
14494 routing mail through to internal MTAs without processing the local parts, it is
14495 a good idea to reject recipient addresses with percent characters in their
14496 local parts. Exim's default configuration does this.
14497
14498
14499 .option perl_at_start main boolean false
14500 This option is available only when Exim is built with an embedded Perl
14501 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14502
14503
14504 .option perl_startup main string unset
14505 This option is available only when Exim is built with an embedded Perl
14506 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14507
14508
14509 .option pgsql_servers main "string list" unset
14510 .cindex "PostgreSQL lookup type" "server list"
14511 This option provides a list of PostgreSQL servers and associated connection
14512 data, to be used in conjunction with &(pgsql)& lookups (see section
14513 &<<SECID72>>&). The option is available only if Exim has been built with
14514 PostgreSQL support.
14515
14516
14517 .option pid_file_path main string&!! "set at compile time"
14518 .cindex "daemon" "pid file path"
14519 .cindex "pid file, path for"
14520 This option sets the name of the file to which the Exim daemon writes its
14521 process id. The string is expanded, so it can contain, for example, references
14522 to the host name:
14523 .code
14524 pid_file_path = /var/log/$primary_hostname/exim.pid
14525 .endd
14526 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14527 spool directory.
14528 The value set by the option can be overridden by the &%-oP%& command line
14529 option. A pid file is not written if a &"non-standard"& daemon is run by means
14530 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14531
14532
14533 .option pipelining_advertise_hosts main "host list&!!" *
14534 .cindex "PIPELINING" "suppressing advertising"
14535 This option can be used to suppress the advertisement of the SMTP
14536 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14537 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14538 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14539 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14540 that clients will use it; &"out of order"& commands that are &"expected"& do
14541 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14542
14543
14544 .option preserve_message_logs main boolean false
14545 .cindex "message logs" "preserving"
14546 If this option is set, message log files are not deleted when messages are
14547 completed. Instead, they are moved to a sub-directory of the spool directory
14548 called &_msglog.OLD_&, where they remain available for statistical or debugging
14549 purposes. This is a dangerous option to set on systems with any appreciable
14550 volume of mail. Use with care!
14551
14552
14553 .option primary_hostname main string "see below"
14554 .cindex "name" "of local host"
14555 .cindex "host" "name of local"
14556 .cindex "local host" "name of"
14557 .vindex "&$primary_hostname$&"
14558 This specifies the name of the current host. It is used in the default EHLO or
14559 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14560 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14561 The value is also used by default in some SMTP response messages from an Exim
14562 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14563
14564 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14565 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14566 contains only one component, Exim passes it to &[gethostbyname()]& (or
14567 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14568 version. The variable &$primary_hostname$& contains the host name, whether set
14569 explicitly by this option, or defaulted.
14570
14571
14572 .option print_topbitchars main boolean false
14573 .cindex "printing characters"
14574 .cindex "8-bit characters"
14575 By default, Exim considers only those characters whose codes lie in the range
14576 32&--126 to be printing characters. In a number of circumstances (for example,
14577 when writing log entries) non-printing characters are converted into escape
14578 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14579 is set, code values of 128 and above are also considered to be printing
14580 characters.
14581
14582 This option also affects the header syntax checks performed by the
14583 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14584 the user's full name when constructing From: and Sender: addresses (as
14585 described in section &<<SECTconstr>>&). Setting this option can cause
14586 Exim to generate eight bit message headers that do not conform to the
14587 standards.
14588
14589
14590 .option process_log_path main string unset
14591 .cindex "process log path"
14592 .cindex "log" "process log"
14593 .cindex "&'exiwhat'&"
14594 This option sets the name of the file to which an Exim process writes its
14595 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14596 utility script. If this option is unset, the file called &_exim-process.info_&
14597 in Exim's spool directory is used. The ability to specify the name explicitly
14598 can be useful in environments where two different Exims are running, using
14599 different spool directories.
14600
14601
14602 .option prod_requires_admin main boolean true
14603 .oindex "&%-M%&"
14604 .oindex "&%-R%&"
14605 .oindex "&%-q%&"
14606 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14607 admin user unless &%prod_requires_admin%& is set false. See also
14608 &%queue_list_requires_admin%&.
14609
14610
14611 .option qualify_domain main string "see below"
14612 .cindex "domain" "for qualifying addresses"
14613 .cindex "address" "qualification"
14614 This option specifies the domain name that is added to any envelope sender
14615 addresses that do not have a domain qualification. It also applies to
14616 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14617 are accepted by default only for locally-generated messages. Qualification is
14618 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14619 locally-generated messages, unless the &%-bnq%& command line option is used.
14620
14621 Messages from external sources must always contain fully qualified addresses,
14622 unless the sending host matches &%sender_unqualified_hosts%& or
14623 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14624 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14625 necessary. Internally, Exim always works with fully qualified envelope
14626 addresses. If &%qualify_domain%& is not set, it defaults to the
14627 &%primary_hostname%& value.
14628
14629
14630 .option qualify_recipient main string "see below"
14631 This option allows you to specify a different domain for qualifying recipient
14632 addresses to the one that is used for senders. See &%qualify_domain%& above.
14633
14634
14635
14636 .option queue_domains main "domain list&!!" unset
14637 .cindex "domain" "specifying non-immediate delivery"
14638 .cindex "queueing incoming messages"
14639 .cindex "message" "queueing certain domains"
14640 This option lists domains for which immediate delivery is not required.
14641 A delivery process is started whenever a message is received, but only those
14642 domains that do not match are processed. All other deliveries wait until the
14643 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14644
14645
14646 .option queue_list_requires_admin main boolean true
14647 .oindex "&%-bp%&"
14648 The &%-bp%& command-line option, which lists the messages that are on the
14649 queue, requires the caller to be an admin user unless
14650 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14651
14652
14653 .option queue_only main boolean false
14654 .cindex "queueing incoming messages"
14655 .cindex "message" "queueing unconditionally"
14656 If &%queue_only%& is set, a delivery process is not automatically started
14657 whenever a message is received. Instead, the message waits on the queue for the
14658 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14659 delivered immediately when certain conditions (such as heavy load) occur.
14660
14661 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14662 and &%-odi%& command line options override &%queue_only%& unless
14663 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14664 &%queue_only_load%&, and &%smtp_accept_queue%&.
14665
14666
14667 .option queue_only_file main string unset
14668 .cindex "queueing incoming messages"
14669 .cindex "message" "queueing by file existence"
14670 This option can be set to a colon-separated list of absolute path names, each
14671 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14672 it tests for the existence of each listed path using a call to &[stat()]&. For
14673 each path that exists, the corresponding queueing option is set.
14674 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14675 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14676 .code
14677 queue_only_file = smtp/some/file
14678 .endd
14679 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14680 &_/some/file_& exists.
14681
14682
14683 .option queue_only_load main fixed-point unset
14684 .cindex "load average"
14685 .cindex "queueing incoming messages"
14686 .cindex "message" "queueing by load"
14687 If the system load average is higher than this value, incoming messages from
14688 all sources are queued, and no automatic deliveries are started. If this
14689 happens during local or remote SMTP input, all subsequent messages received on
14690 the same SMTP connection are queued by default, whatever happens to the load in
14691 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14692 false.
14693
14694 Deliveries will subsequently be performed by queue runner processes. This
14695 option has no effect on ancient operating systems on which Exim cannot
14696 determine the load average. See also &%deliver_queue_load_max%& and
14697 &%smtp_load_reserve%&.
14698
14699
14700 .option queue_only_load_latch main boolean true
14701 .cindex "load average" "re-evaluating per message"
14702 When this option is true (the default), once one message has been queued
14703 because the load average is higher than the value set by &%queue_only_load%&,
14704 all subsequent messages received on the same SMTP connection are also queued.
14705 This is a deliberate choice; even though the load average may fall below the
14706 threshold, it doesn't seem right to deliver later messages on the same
14707 connection when not delivering earlier ones. However, there are special
14708 circumstances such as very long-lived connections from scanning appliances
14709 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14710 should be set false. This causes the value of the load average to be
14711 re-evaluated for each message.
14712
14713
14714 .option queue_only_override main boolean true
14715 .cindex "queueing incoming messages"
14716 When this option is true, the &%-od%&&'x'& command line options override the
14717 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14718 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14719 to override; they are accepted, but ignored.
14720
14721
14722 .option queue_run_in_order main boolean false
14723 .cindex "queue runner" "processing messages in order"
14724 If this option is set, queue runs happen in order of message arrival instead of
14725 in an arbitrary order. For this to happen, a complete list of the entire queue
14726 must be set up before the deliveries start. When the queue is all held in a
14727 single directory (the default), a single list is created for both the ordered
14728 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14729 single list is not created when &%queue_run_in_order%& is false. In this case,
14730 the sub-directories are processed one at a time (in a random order), and this
14731 avoids setting up one huge list for the whole queue. Thus, setting
14732 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14733 when the queue is large, because of the extra work in setting up the single,
14734 large list. In most situations, &%queue_run_in_order%& should not be set.
14735
14736
14737
14738 .option queue_run_max main integer 5
14739 .cindex "queue runner" "maximum number of"
14740 This controls the maximum number of queue runner processes that an Exim daemon
14741 can run simultaneously. This does not mean that it starts them all at once,
14742 but rather that if the maximum number are still running when the time comes to
14743 start another one, it refrains from starting another one. This can happen with
14744 very large queues and/or very sluggish deliveries. This option does not,
14745 however, interlock with other processes, so additional queue runners can be
14746 started by other means, or by killing and restarting the daemon.
14747
14748 Setting this option to zero does not suppress queue runs; rather, it disables
14749 the limit, allowing any number of simultaneous queue runner processes to be
14750 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14751 the daemon's command line.
14752
14753 .option queue_smtp_domains main "domain list&!!" unset
14754 .cindex "queueing incoming messages"
14755 .cindex "message" "queueing remote deliveries"
14756 When this option is set, a delivery process is started whenever a message is
14757 received, routing is performed, and local deliveries take place.
14758 However, if any SMTP deliveries are required for domains that match
14759 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14760 message waits on the queue for the next queue run. Since routing of the message
14761 has taken place, Exim knows to which remote hosts it must be delivered, and so
14762 when the queue run happens, multiple messages for the same host are delivered
14763 over a single SMTP connection. The &%-odqs%& command line option causes all
14764 SMTP deliveries to be queued in this way, and is equivalent to setting
14765 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14766 &%queue_domains%&.
14767
14768
14769 .option receive_timeout main time 0s
14770 .cindex "timeout" "for non-SMTP input"
14771 This option sets the timeout for accepting a non-SMTP message, that is, the
14772 maximum time that Exim waits when reading a message on the standard input. If
14773 the value is zero, it will wait for ever. This setting is overridden by the
14774 &%-or%& command line option. The timeout for incoming SMTP messages is
14775 controlled by &%smtp_receive_timeout%&.
14776
14777 .option received_header_text main string&!! "see below"
14778 .cindex "customizing" "&'Received:'& header"
14779 .cindex "&'Received:'& header line" "customizing"
14780 This string defines the contents of the &'Received:'& message header that is
14781 added to each message, except for the timestamp, which is automatically added
14782 on at the end (preceded by a semicolon). The string is expanded each time it is
14783 used. If the expansion yields an empty string, no &'Received:'& header line is
14784 added to the message. Otherwise, the string should start with the text
14785 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14786 header lines. The default setting is:
14787
14788 .code
14789 received_header_text = Received: \
14790   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14791   {${if def:sender_ident \
14792   {from ${quote_local_part:$sender_ident} }}\
14793   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14794   by $primary_hostname \
14795   ${if def:received_protocol {with $received_protocol}} \
14796   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14797   (Exim $version_number)\n\t\
14798   ${if def:sender_address \
14799   {(envelope-from <$sender_address>)\n\t}}\
14800   id $message_exim_id\
14801   ${if def:received_for {\n\tfor $received_for}}
14802 .endd
14803
14804 The reference to the TLS cipher is omitted when Exim is built without TLS
14805 support. The use of conditional expansions ensures that this works for both
14806 locally generated messages and messages received from remote hosts, giving
14807 header lines such as the following:
14808 .code
14809 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14810 by marley.carol.example with esmtp (Exim 4.00)
14811 (envelope-from <bob@carol.example>)
14812 id 16IOWa-00019l-00
14813 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14814 Received: by scrooge.carol.example with local (Exim 4.00)
14815 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14816 .endd
14817 Until the body of the message has been received, the timestamp is the time when
14818 the message started to be received. Once the body has arrived, and all policy
14819 checks have taken place, the timestamp is updated to the time at which the
14820 message was accepted.
14821
14822
14823 .option received_headers_max main integer 30
14824 .cindex "loop" "prevention"
14825 .cindex "mail loop prevention"
14826 .cindex "&'Received:'& header line" "counting"
14827 When a message is to be delivered, the number of &'Received:'& headers is
14828 counted, and if it is greater than this parameter, a mail loop is assumed to
14829 have occurred, the delivery is abandoned, and an error message is generated.
14830 This applies to both local and remote deliveries.
14831
14832
14833 .option recipient_unqualified_hosts main "host list&!!" unset
14834 .cindex "unqualified addresses"
14835 .cindex "host" "unqualified addresses from"
14836 This option lists those hosts from which Exim is prepared to accept unqualified
14837 recipient addresses in message envelopes. The addresses are made fully
14838 qualified by the addition of the &%qualify_recipient%& value. This option also
14839 affects message header lines. Exim does not reject unqualified recipient
14840 addresses in headers, but it qualifies them only if the message came from a
14841 host that matches &%recipient_unqualified_hosts%&,
14842 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14843 option was not set.
14844
14845
14846 .option recipients_max main integer 0
14847 .cindex "limit" "number of recipients"
14848 .cindex "recipient" "maximum number"
14849 If this option is set greater than zero, it specifies the maximum number of
14850 original recipients for any message. Additional recipients that are generated
14851 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14852 all recipients over the limit; earlier recipients are delivered as normal.
14853 Non-SMTP messages with too many recipients are failed, and no deliveries are
14854 done.
14855
14856 .cindex "RCPT" "maximum number of incoming"
14857 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14858 RCPT commands in a single message.
14859
14860
14861 .option recipients_max_reject main boolean false
14862 If this option is set true, Exim rejects SMTP messages containing too many
14863 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14864 error to the eventual DATA command. Otherwise (the default) it gives a 452
14865 error to the surplus RCPT commands and accepts the message on behalf of the
14866 initial set of recipients. The remote server should then re-send the message
14867 for the remaining recipients at a later time.
14868
14869
14870 .option remote_max_parallel main integer 2
14871 .cindex "delivery" "parallelism for remote"
14872 This option controls parallel delivery of one message to a number of remote
14873 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14874 does all the remote deliveries for a message one by one. Otherwise, if a single
14875 message has to be delivered to more than one remote host, or if several copies
14876 have to be sent to the same remote host, up to &%remote_max_parallel%&
14877 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14878 deliveries are required, the maximum number of processes are started, and as
14879 each one finishes, another is begun. The order of starting processes is the
14880 same as if sequential delivery were being done, and can be controlled by the
14881 &%remote_sort_domains%& option. If parallel delivery takes place while running
14882 with debugging turned on, the debugging output from each delivery process is
14883 tagged with its process id.
14884
14885 This option controls only the maximum number of parallel deliveries for one
14886 message in one Exim delivery process. Because Exim has no central queue
14887 manager, there is no way of controlling the total number of simultaneous
14888 deliveries if the configuration allows a delivery attempt as soon as a message
14889 is received.
14890
14891 .cindex "number of deliveries"
14892 .cindex "delivery" "maximum number of"
14893 If you want to control the total number of deliveries on the system, you
14894 need to set the &%queue_only%& option. This ensures that all incoming messages
14895 are added to the queue without starting a delivery process. Then set up an Exim
14896 daemon to start queue runner processes at appropriate intervals (probably
14897 fairly often, for example, every minute), and limit the total number of queue
14898 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14899 delivers only one message at a time, the maximum number of deliveries that can
14900 then take place at once is &%queue_run_max%& multiplied by
14901 &%remote_max_parallel%&.
14902
14903 If it is purely remote deliveries you want to control, use
14904 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14905 doing the SMTP routing before queueing, so that several messages for the same
14906 host will eventually get delivered down the same connection.
14907
14908
14909 .option remote_sort_domains main "domain list&!!" unset
14910 .cindex "sorting remote deliveries"
14911 .cindex "delivery" "sorting remote"
14912 When there are a number of remote deliveries for a message, they are sorted by
14913 domain into the order given by this list. For example,
14914 .code
14915 remote_sort_domains = *.cam.ac.uk:*.uk
14916 .endd
14917 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14918 then to those in the &%uk%& domain, then to any others.
14919
14920
14921 .option retry_data_expire main time 7d
14922 .cindex "hints database" "data expiry"
14923 This option sets a &"use before"& time on retry information in Exim's hints
14924 database. Any older retry data is ignored. This means that, for example, once a
14925 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14926 past failures.
14927
14928
14929 .option retry_interval_max main time 24h
14930 .cindex "retry" "limit on interval"
14931 .cindex "limit" "on retry interval"
14932 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14933 intervals between delivery attempts for messages that cannot be delivered
14934 straight away. This option sets an overall limit to the length of time between
14935 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14936 the default value.
14937
14938
14939 .option return_path_remove main boolean true
14940 .cindex "&'Return-path:'& header line" "removing"
14941 RFC 2821, section 4.4, states that an SMTP server must insert a
14942 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14943 The &'Return-path:'& header preserves the sender address as received in the
14944 MAIL command. This description implies that this header should not be present
14945 in an incoming message. If &%return_path_remove%& is true, any existing
14946 &'Return-path:'& headers are removed from messages at the time they are
14947 received. Exim's transports have options for adding &'Return-path:'& headers at
14948 the time of delivery. They are normally used only for final local deliveries.
14949
14950
14951 .option return_size_limit main integer 100K
14952 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14953
14954
14955 .option rfc1413_hosts main "host list&!!" *
14956 .cindex "RFC 1413"
14957 .cindex "host" "for RFC 1413 calls"
14958 RFC 1413 identification calls are made to any client host which matches an item
14959 in the list.
14960
14961 .option rfc1413_query_timeout main time 5s
14962 .cindex "RFC 1413" "query timeout"
14963 .cindex "timeout" "for RFC 1413 call"
14964 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14965 no RFC 1413 calls are ever made.
14966
14967
14968 .option sender_unqualified_hosts main "host list&!!" unset
14969 .cindex "unqualified addresses"
14970 .cindex "host" "unqualified addresses from"
14971 This option lists those hosts from which Exim is prepared to accept unqualified
14972 sender addresses. The addresses are made fully qualified by the addition of
14973 &%qualify_domain%&. This option also affects message header lines. Exim does
14974 not reject unqualified addresses in headers that contain sender addresses, but
14975 it qualifies them only if the message came from a host that matches
14976 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14977 using TCP/IP), and the &%-bnq%& option was not set.
14978
14979
14980 .option smtp_accept_keepalive main boolean true
14981 .cindex "keepalive" "on incoming connection"
14982 This option controls the setting of the SO_KEEPALIVE option on incoming
14983 TCP/IP socket connections. When set, it causes the kernel to probe idle
14984 connections periodically, by sending packets with &"old"& sequence numbers. The
14985 other end of the connection should send an acknowledgment if the connection is
14986 still okay or a reset if the connection has been aborted. The reason for doing
14987 this is that it has the beneficial effect of freeing up certain types of
14988 connection that can get stuck when the remote host is disconnected without
14989 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14990 hours to detect unreachable hosts.
14991
14992
14993
14994 .option smtp_accept_max main integer 20
14995 .cindex "limit" "incoming SMTP connections"
14996 .cindex "SMTP" "incoming connection count"
14997 .cindex "inetd"
14998 This option specifies the maximum number of simultaneous incoming SMTP calls
14999 that Exim will accept. It applies only to the listening daemon; there is no
15000 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15001 value is set to zero, no limit is applied. However, it is required to be
15002 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15003 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15004
15005 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15006 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15007 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15008 and &%smtp_load_reserve%& are then checked before accepting the connection.
15009
15010
15011 .option smtp_accept_max_nonmail main integer 10
15012 .cindex "limit" "non-mail SMTP commands"
15013 .cindex "SMTP" "limiting non-mail commands"
15014 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15015 the connection if there are too many. This option defines &"too many"&. The
15016 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15017 client looping sending EHLO, for example. The check is applied only if the
15018 client host matches &%smtp_accept_max_nonmail_hosts%&.
15019
15020 When a new message is expected, one occurrence of RSET is not counted. This
15021 allows a client to send one RSET between messages (this is not necessary,
15022 but some clients do it). Exim also allows one uncounted occurrence of HELO
15023 or EHLO, and one occurrence of STARTTLS between messages. After
15024 starting up a TLS session, another EHLO is expected, and so it too is not
15025 counted. The first occurrence of AUTH in a connection, or immediately
15026 following STARTTLS is not counted. Otherwise, all commands other than
15027 MAIL, RCPT, DATA, and QUIT are counted.
15028
15029
15030 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15031 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15032 check by setting this option. The default value makes it apply to all hosts. By
15033 changing the value, you can exclude any badly-behaved hosts that you have to
15034 live with.
15035
15036
15037 . Allow this long option name to split; give it unsplit as a fifth argument
15038 . for the automatic .oindex that is generated by .option.
15039
15040 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
15041          smtp_accept_max_per_connection
15042 .cindex "SMTP" "limiting incoming message count"
15043 .cindex "limit" "messages per SMTP connection"
15044 The value of this option limits the number of MAIL commands that Exim is
15045 prepared to accept over a single SMTP connection, whether or not each command
15046 results in the transfer of a message. After the limit is reached, a 421
15047 response is given to subsequent MAIL commands. This limit is a safety
15048 precaution against a client that goes mad (incidents of this type have been
15049 seen).
15050
15051
15052 .option smtp_accept_max_per_host main string&!! unset
15053 .cindex "limit" "SMTP connections from one host"
15054 .cindex "host" "limiting SMTP connections from"
15055 This option restricts the number of simultaneous IP connections from a single
15056 host (strictly, from a single IP address) to the Exim daemon. The option is
15057 expanded, to enable different limits to be applied to different hosts by
15058 reference to &$sender_host_address$&. Once the limit is reached, additional
15059 connection attempts from the same host are rejected with error code 421. This
15060 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15061 of zero imposes no limit. If this option is set greater than zero, it is
15062 required that &%smtp_accept_max%& be non-zero.
15063
15064 &*Warning*&: When setting this option you should not use any expansion
15065 constructions that take an appreciable amount of time. The expansion and test
15066 happen in the main daemon loop, in order to reject additional connections
15067 without forking additional processes (otherwise a denial-of-service attack
15068 could cause a vast number or processes to be created). While the daemon is
15069 doing this processing, it cannot accept any other incoming connections.
15070
15071
15072
15073 .option smtp_accept_queue main integer 0
15074 .cindex "SMTP" "incoming connection count"
15075 .cindex "queueing incoming messages"
15076 .cindex "message" "queueing by SMTP connection count"
15077 If the number of simultaneous incoming SMTP connections being handled via the
15078 listening daemon exceeds this value, messages received by SMTP are just placed
15079 on the queue; no delivery processes are started automatically. The count is
15080 fixed at the start of an SMTP connection. It cannot be updated in the
15081 subprocess that receives messages, and so the queueing or not queueing applies
15082 to all messages received in the same connection.
15083
15084 A value of zero implies no limit, and clearly any non-zero value is useful only
15085 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15086 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15087 various &%-od%&&'x'& command line options.
15088
15089
15090 . Allow this long option name to split; give it unsplit as a fifth argument
15091 . for the automatic .oindex that is generated by .option.
15092
15093 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
15094          smtp_accept_queue_per_connection
15095 .cindex "queueing incoming messages"
15096 .cindex "message" "queueing by message count"
15097 This option limits the number of delivery processes that Exim starts
15098 automatically when receiving messages via SMTP, whether via the daemon or by
15099 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15100 and the number of messages received in a single SMTP session exceeds this
15101 number, subsequent messages are placed on the queue, but no delivery processes
15102 are started. This helps to limit the number of Exim processes when a server
15103 restarts after downtime and there is a lot of mail waiting for it on other
15104 systems. On large systems, the default should probably be increased, and on
15105 dial-in client systems it should probably be set to zero (that is, disabled).
15106
15107
15108 .option smtp_accept_reserve main integer 0
15109 .cindex "SMTP" "incoming call count"
15110 .cindex "host" "reserved"
15111 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15112 number of SMTP connections that are reserved for connections from the hosts
15113 that are specified in &%smtp_reserve_hosts%&. The value set in
15114 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15115 restricted to this number of connections; the option specifies a minimum number
15116 of connection slots for them, not a maximum. It is a guarantee that this group
15117 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15118 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15119 individual host.
15120
15121 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15122 set to 5, once there are 45 active connections (from any hosts), new
15123 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15124 provided the other criteria for acceptance are met.
15125
15126
15127 .option smtp_active_hostname main string&!! unset
15128 .cindex "host" "name in SMTP responses"
15129 .cindex "SMTP" "host name in responses"
15130 .vindex "&$primary_hostname$&"
15131 This option is provided for multi-homed servers that want to masquerade as
15132 several different hosts. At the start of an incoming SMTP connection, its value
15133 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15134 responses. For example, it is used as domain name in the response to an
15135 incoming HELO or EHLO command.
15136
15137 .vindex "&$smtp_active_hostname$&"
15138 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15139 is saved with any messages that are received. It is therefore available for use
15140 in routers and transports when the message is later delivered.
15141
15142 If this option is unset, or if its expansion is forced to fail, or if the
15143 expansion results in an empty string, the value of &$primary_hostname$& is
15144 used. Other expansion failures cause a message to be written to the main and
15145 panic logs, and the SMTP command receives a temporary error. Typically, the
15146 value of &%smtp_active_hostname%& depends on the incoming interface address.
15147 For example:
15148 .code
15149 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15150   {cox.mydomain}{box.mydomain}}
15151 .endd
15152
15153 Although &$smtp_active_hostname$& is primarily concerned with incoming
15154 messages, it is also used as the default for HELO commands in callout
15155 verification if there is no remote transport from which to obtain a
15156 &%helo_data%& value.
15157
15158 .option smtp_banner main string&!! "see below"
15159 .cindex "SMTP" "welcome banner"
15160 .cindex "banner for SMTP"
15161 .cindex "welcome banner for SMTP"
15162 .cindex "customizing" "SMTP banner"
15163 This string, which is expanded every time it is used, is output as the initial
15164 positive response to an SMTP connection. The default setting is:
15165 .code
15166 smtp_banner = $smtp_active_hostname ESMTP Exim \
15167   $version_number $tod_full
15168 .endd
15169 Failure to expand the string causes a panic error. If you want to create a
15170 multiline response to the initial SMTP connection, use &"\n"& in the string at
15171 appropriate points, but not at the end. Note that the 220 code is not included
15172 in this string. Exim adds it automatically (several times in the case of a
15173 multiline response).
15174
15175
15176 .option smtp_check_spool_space main boolean true
15177 .cindex "checking disk space"
15178 .cindex "disk space, checking"
15179 .cindex "spool directory" "checking space"
15180 When this option is set, if an incoming SMTP session encounters the SIZE
15181 option on a MAIL command, it checks that there is enough space in the
15182 spool directory's partition to accept a message of that size, while still
15183 leaving free the amount specified by &%check_spool_space%& (even if that value
15184 is zero). If there isn't enough space, a temporary error code is returned.
15185
15186
15187 .option smtp_connect_backlog main integer 20
15188 .cindex "connection backlog"
15189 .cindex "SMTP" "connection backlog"
15190 .cindex "backlog of connections"
15191 This option specifies a maximum number of waiting SMTP connections. Exim passes
15192 this value to the TCP/IP system when it sets up its listener. Once this number
15193 of connections are waiting for the daemon's attention, subsequent connection
15194 attempts are refused at the TCP/IP level. At least, that is what the manuals
15195 say; in some circumstances such connection attempts have been observed to time
15196 out instead. For large systems it is probably a good idea to increase the
15197 value (to 50, say). It also gives some protection against denial-of-service
15198 attacks by SYN flooding.
15199
15200
15201 .option smtp_enforce_sync main boolean true
15202 .cindex "SMTP" "synchronization checking"
15203 .cindex "synchronization checking in SMTP"
15204 The SMTP protocol specification requires the client to wait for a response from
15205 the server at certain points in the dialogue. Without PIPELINING these
15206 synchronization points are after every command; with PIPELINING they are
15207 fewer, but they still exist.
15208
15209 Some spamming sites send out a complete set of SMTP commands without waiting
15210 for any response. Exim protects against this by rejecting a message if the
15211 client has sent further input when it should not have. The error response &"554
15212 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15213 for this error cannot be perfect because of transmission delays (unexpected
15214 input may be on its way but not yet received when Exim checks). However, it
15215 does detect many instances.
15216
15217 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15218 If you want to disable the check selectively (for example, only for certain
15219 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15220 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15221
15222
15223
15224 .option smtp_etrn_command main string&!! unset
15225 .cindex "ETRN" "command to be run"
15226 .vindex "&$domain$&"
15227 If this option is set, the given command is run whenever an SMTP ETRN
15228 command is received from a host that is permitted to issue such commands (see
15229 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15230 are independently expanded. The expansion variable &$domain$& is set to the
15231 argument of the ETRN command, and no syntax checking is done on it. For
15232 example:
15233 .code
15234 smtp_etrn_command = /etc/etrn_command $domain \
15235                     $sender_host_address
15236 .endd
15237 A new process is created to run the command, but Exim does not wait for it to
15238 complete. Consequently, its status cannot be checked. If the command cannot be
15239 run, a line is written to the panic log, but the ETRN caller still receives
15240 a 250 success response. Exim is normally running under its own uid when
15241 receiving SMTP, so it is not possible for it to change the uid before running
15242 the command.
15243
15244
15245 .option smtp_etrn_serialize main boolean true
15246 .cindex "ETRN" "serializing"
15247 When this option is set, it prevents the simultaneous execution of more than
15248 one identical command as a result of ETRN in an SMTP connection. See
15249 section &<<SECTETRN>>& for details.
15250
15251
15252 .option smtp_load_reserve main fixed-point unset
15253 .cindex "load average"
15254 If the system load average ever gets higher than this, incoming SMTP calls are
15255 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15256 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15257 the load is over the limit. The option has no effect on ancient operating
15258 systems on which Exim cannot determine the load average. See also
15259 &%deliver_queue_load_max%& and &%queue_only_load%&.
15260
15261
15262
15263 .option smtp_max_synprot_errors main integer 3
15264 .cindex "SMTP" "limiting syntax and protocol errors"
15265 .cindex "limit" "SMTP syntax and protocol errors"
15266 Exim rejects SMTP commands that contain syntax or protocol errors. In
15267 particular, a syntactically invalid email address, as in this command:
15268 .code
15269 RCPT TO:<abc xyz@a.b.c>
15270 .endd
15271 causes immediate rejection of the command, before any other tests are done.
15272 (The ACL cannot be run if there is no valid address to set up for it.) An
15273 example of a protocol error is receiving RCPT before MAIL. If there are
15274 too many syntax or protocol errors in one SMTP session, the connection is
15275 dropped. The limit is set by this option.
15276
15277 .cindex "PIPELINING" "expected errors"
15278 When the PIPELINING extension to SMTP is in use, some protocol errors are
15279 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15280 Exim assumes that PIPELINING will be used if it advertises it (see
15281 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15282 not count towards the limit.
15283
15284
15285
15286 .option smtp_max_unknown_commands main integer 3
15287 .cindex "SMTP" "limiting unknown commands"
15288 .cindex "limit" "unknown SMTP commands"
15289 If there are too many unrecognized commands in an incoming SMTP session, an
15290 Exim server drops the connection. This is a defence against some kinds of abuse
15291 that subvert web
15292 clients
15293 into making connections to SMTP ports; in these circumstances, a number of
15294 non-SMTP command lines are sent first.
15295
15296
15297
15298 .option smtp_ratelimit_hosts main "host list&!!" unset
15299 .cindex "SMTP" "rate limiting"
15300 .cindex "limit" "rate of message arrival"
15301 .cindex "RCPT" "rate limiting"
15302 Some sites find it helpful to be able to limit the rate at which certain hosts
15303 can send them messages, and the rate at which an individual message can specify
15304 recipients.
15305
15306 Exim has two rate-limiting facilities. This section describes the older
15307 facility, which can limit rates within a single connection. The newer
15308 &%ratelimit%& ACL condition can limit rates across all connections. See section
15309 &<<SECTratelimiting>>& for details of the newer facility.
15310
15311 When a host matches &%smtp_ratelimit_hosts%&, the values of
15312 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15313 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15314 respectively. Each option, if set, must contain a set of four comma-separated
15315 values:
15316
15317 .ilist
15318 A threshold, before which there is no rate limiting.
15319 .next
15320 An initial time delay. Unlike other times in Exim, numbers with decimal
15321 fractional parts are allowed here.
15322 .next
15323 A factor by which to increase the delay each time.
15324 .next
15325 A maximum value for the delay. This should normally be less than 5 minutes,
15326 because after that time, the client is liable to timeout the SMTP command.
15327 .endlist
15328
15329 For example, these settings have been used successfully at the site which
15330 first suggested this feature, for controlling mail from their customers:
15331 .code
15332 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15333 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15334 .endd
15335 The first setting specifies delays that are applied to MAIL commands after
15336 two have been received over a single connection. The initial delay is 0.5
15337 seconds, increasing by a factor of 1.05 each time. The second setting applies
15338 delays to RCPT commands when more than four occur in a single message.
15339
15340
15341 .option smtp_ratelimit_mail main string unset
15342 See &%smtp_ratelimit_hosts%& above.
15343
15344
15345 .option smtp_ratelimit_rcpt main string unset
15346 See &%smtp_ratelimit_hosts%& above.
15347
15348
15349 .option smtp_receive_timeout main time 5m
15350 .cindex "timeout" "for SMTP input"
15351 .cindex "SMTP" "input timeout"
15352 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15353 input, including batch SMTP. If a line of input (either an SMTP command or a
15354 data line) is not received within this time, the SMTP connection is dropped and
15355 the message is abandoned.
15356 A line is written to the log containing one of the following messages:
15357 .code
15358 SMTP command timeout on connection from...
15359 SMTP data timeout on connection from...
15360 .endd
15361 The former means that Exim was expecting to read an SMTP command; the latter
15362 means that it was in the DATA phase, reading the contents of a message.
15363
15364
15365 .oindex "&%-os%&"
15366 The value set by this option can be overridden by the
15367 &%-os%& command-line option. A setting of zero time disables the timeout, but
15368 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15369 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15370 timeout is controlled by &%receive_timeout%& and &%-or%&.
15371
15372
15373 .option smtp_reserve_hosts main "host list&!!" unset
15374 This option defines hosts for which SMTP connections are reserved; see
15375 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15376
15377
15378 .option smtp_return_error_details main boolean false
15379 .cindex "SMTP" "details policy failures"
15380 .cindex "policy control" "rejection, returning details"
15381 In the default state, Exim uses bland messages such as
15382 &"Administrative prohibition"& when it rejects SMTP commands for policy
15383 reasons. Many sysadmins like this because it gives away little information
15384 to spammers. However, some other sysadmins who are applying strict checking
15385 policies want to give out much fuller information about failures. Setting
15386 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15387 example, instead of &"Administrative prohibition"&, it might give:
15388 .code
15389 550-Rejected after DATA: '>' missing at end of address:
15390 550 failing address in "From" header is: <user@dom.ain
15391 .endd
15392
15393 .option spamd_address main string "see below"
15394 This option is available when Exim is compiled with the content-scanning
15395 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15396 The default value is
15397 .code
15398 127.0.0.1 783
15399 .endd
15400 See section &<<SECTscanspamass>>& for more details.
15401
15402
15403
15404 .option split_spool_directory main boolean false
15405 .cindex "multiple spool directories"
15406 .cindex "spool directory" "split"
15407 .cindex "directories, multiple"
15408 If this option is set, it causes Exim to split its input directory into 62
15409 subdirectories, each with a single alphanumeric character as its name. The
15410 sixth character of the message id is used to allocate messages to
15411 subdirectories; this is the least significant base-62 digit of the time of
15412 arrival of the message.
15413
15414 Splitting up the spool in this way may provide better performance on systems
15415 where there are long mail queues, by reducing the number of files in any one
15416 directory. The msglog directory is also split up in a similar way to the input
15417 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15418 are still placed in the single directory &_msglog.OLD_&.
15419
15420 It is not necessary to take any special action for existing messages when
15421 changing &%split_spool_directory%&. Exim notices messages that are in the
15422 &"wrong"& place, and continues to process them. If the option is turned off
15423 after a period of being on, the subdirectories will eventually empty and be
15424 automatically deleted.
15425
15426 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15427 changes. Instead of creating a list of all messages in the queue, and then
15428 trying to deliver each one in turn, it constructs a list of those in one
15429 sub-directory and tries to deliver them, before moving on to the next
15430 sub-directory. The sub-directories are processed in a random order. This
15431 spreads out the scanning of the input directories, and uses less memory. It is
15432 particularly beneficial when there are lots of messages on the queue. However,
15433 if &%queue_run_in_order%& is set, none of this new processing happens. The
15434 entire queue has to be scanned and sorted before any deliveries can start.
15435
15436
15437 .option spool_directory main string&!! "set at compile time"
15438 .cindex "spool directory" "path to"
15439 This defines the directory in which Exim keeps its spool, that is, the messages
15440 it is waiting to deliver. The default value is taken from the compile-time
15441 configuration setting, if there is one. If not, this option must be set. The
15442 string is expanded, so it can contain, for example, a reference to
15443 &$primary_hostname$&.
15444
15445 If the spool directory name is fixed on your installation, it is recommended
15446 that you set it at build time rather than from this option, particularly if the
15447 log files are being written to the spool directory (see &%log_file_path%&).
15448 Otherwise log files cannot be used for errors that are detected early on, such
15449 as failures in the configuration file.
15450
15451 By using this option to override the compiled-in path, it is possible to run
15452 tests of Exim without using the standard spool.
15453
15454 .option sqlite_lock_timeout main time 5s
15455 .cindex "sqlite lookup type" "lock timeout"
15456 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15457 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15458
15459 .option strict_acl_vars main boolean false
15460 .cindex "&ACL;" "variables, handling unset"
15461 This option controls what happens if a syntactically valid but undefined ACL
15462 variable is referenced. If it is false (the default), an empty string
15463 is substituted; if it is true, an error is generated. See section
15464 &<<SECTaclvariables>>& for details of ACL variables.
15465
15466 .option strip_excess_angle_brackets main boolean false
15467 .cindex "angle brackets, excess"
15468 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15469 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15470 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15471 passed on to another MTA, the excess angle brackets are not passed on. If this
15472 option is not set, multiple pairs of angle brackets cause a syntax error.
15473
15474
15475 .option strip_trailing_dot main boolean false
15476 .cindex "trailing dot on domain"
15477 .cindex "dot" "trailing on domain"
15478 If this option is set, a trailing dot at the end of a domain in an address is
15479 ignored. If this is in the envelope and the message is passed on to another
15480 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15481 domain causes a syntax error.
15482 However, addresses in header lines are checked only when an ACL requests header
15483 syntax checking.
15484
15485
15486 .option syslog_duplication main boolean true
15487 .cindex "syslog" "duplicate log lines; suppressing"
15488 When Exim is logging to syslog, it writes the log lines for its three
15489 separate logs at different syslog priorities so that they can in principle
15490 be separated on the logging hosts. Some installations do not require this
15491 separation, and in those cases, the duplication of certain log lines is a
15492 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15493 particular log line is written to syslog. For lines that normally go to
15494 both the main log and the reject log, the reject log version (possibly
15495 containing message header lines) is written, at LOG_NOTICE priority.
15496 Lines that normally go to both the main and the panic log are written at
15497 the LOG_ALERT priority.
15498
15499
15500 .option syslog_facility main string unset
15501 .cindex "syslog" "facility; setting"
15502 This option sets the syslog &"facility"& name, used when Exim is logging to
15503 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15504 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15505 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15506 details of Exim's logging.
15507
15508
15509
15510 .option syslog_processname main string &`exim`&
15511 .cindex "syslog" "process name; setting"
15512 This option sets the syslog &"ident"& name, used when Exim is logging to
15513 syslog. The value must be no longer than 32 characters. See chapter
15514 &<<CHAPlog>>& for details of Exim's logging.
15515
15516
15517
15518 .option syslog_timestamp main boolean true
15519 .cindex "syslog" "timestamps"
15520 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15521 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15522 details of Exim's logging.
15523
15524
15525 .option system_filter main string&!! unset
15526 .cindex "filter" "system filter"
15527 .cindex "system filter" "specifying"
15528 .cindex "Sieve filter" "not available for system filter"
15529 This option specifies an Exim filter file that is applied to all messages at
15530 the start of each delivery attempt, before any routing is done. System filters
15531 must be Exim filters; they cannot be Sieve filters. If the system filter
15532 generates any deliveries to files or pipes, or any new mail messages, the
15533 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15534 which transports are to be used. Details of this facility are given in chapter
15535 &<<CHAPsystemfilter>>&.
15536
15537
15538 .option system_filter_directory_transport main string&!! unset
15539 .vindex "&$address_file$&"
15540 This sets the name of the transport driver that is to be used when the
15541 &%save%& command in a system message filter specifies a path ending in &"/"&,
15542 implying delivery of each message into a separate file in some directory.
15543 During the delivery, the variable &$address_file$& contains the path name.
15544
15545
15546 .option system_filter_file_transport main string&!! unset
15547 .cindex "file" "transport for system filter"
15548 This sets the name of the transport driver that is to be used when the &%save%&
15549 command in a system message filter specifies a path not ending in &"/"&. During
15550 the delivery, the variable &$address_file$& contains the path name.
15551
15552 .option system_filter_group main string unset
15553 .cindex "gid (group id)" "system filter"
15554 This option is used only when &%system_filter_user%& is also set. It sets the
15555 gid under which the system filter is run, overriding any gid that is associated
15556 with the user. The value may be numerical or symbolic.
15557
15558 .option system_filter_pipe_transport main string&!! unset
15559 .cindex "&(pipe)& transport" "for system filter"
15560 .vindex "&$address_pipe$&"
15561 This specifies the transport driver that is to be used when a &%pipe%& command
15562 is used in a system filter. During the delivery, the variable &$address_pipe$&
15563 contains the pipe command.
15564
15565
15566 .option system_filter_reply_transport main string&!! unset
15567 .cindex "&(autoreply)& transport" "for system filter"
15568 This specifies the transport driver that is to be used when a &%mail%& command
15569 is used in a system filter.
15570
15571
15572 .option system_filter_user main string unset
15573 .cindex "uid (user id)" "system filter"
15574 If this option is set to root, the system filter is run in the main Exim
15575 delivery process, as root.  Otherwise, the system filter runs in a separate
15576 process, as the given user, defaulting to the Exim run-time user.
15577 Unless the string consists entirely of digits, it
15578 is looked up in the password data. Failure to find the named user causes a
15579 configuration error. The gid is either taken from the password data, or
15580 specified by &%system_filter_group%&. When the uid is specified numerically,
15581 &%system_filter_group%& is required to be set.
15582
15583 If the system filter generates any pipe, file, or reply deliveries, the uid
15584 under which the filter is run is used when transporting them, unless a
15585 transport option overrides.
15586
15587
15588 .option tcp_nodelay main boolean true
15589 .cindex "daemon" "TCP_NODELAY on sockets"
15590 .cindex "Nagle algorithm"
15591 .cindex "TCP_NODELAY on listening sockets"
15592 If this option is set false, it stops the Exim daemon setting the
15593 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15594 turns off the &"Nagle algorithm"&, which is a way of improving network
15595 performance in interactive (character-by-character) situations. Turning it off
15596 should improve Exim's performance a bit, so that is what happens by default.
15597 However, it appears that some broken clients cannot cope, and time out. Hence
15598 this option. It affects only those sockets that are set up for listening by the
15599 daemon. Sockets created by the smtp transport for delivering mail always set
15600 TCP_NODELAY.
15601
15602
15603 .option timeout_frozen_after main time 0s
15604 .cindex "frozen messages" "timing out"
15605 .cindex "timeout" "frozen messages"
15606 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15607 message of any kind that has been on the queue for longer than the given time
15608 is automatically cancelled at the next queue run. If the frozen message is a
15609 bounce message, it is just discarded; otherwise, a bounce is sent to the
15610 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15611 If you want to timeout frozen bounce messages earlier than other kinds of
15612 frozen message, see &%ignore_bounce_errors_after%&.
15613
15614 &*Note:*& the default value of zero means no timeouts; with this setting,
15615 frozen messages remain on the queue forever (except for any frozen bounce
15616 messages that are released by &%ignore_bounce_errors_after%&).
15617
15618
15619 .option timezone main string unset
15620 .cindex "timezone, setting"
15621 The value of &%timezone%& is used to set the environment variable TZ while
15622 running Exim (if it is different on entry). This ensures that all timestamps
15623 created by Exim are in the required timezone. If you want all your timestamps
15624 to be in UTC (aka GMT) you should set
15625 .code
15626 timezone = UTC
15627 .endd
15628 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15629 or, if that is not set, from the value of the TZ environment variable when Exim
15630 is built. If &%timezone%& is set to the empty string, either at build or run
15631 time, any existing TZ variable is removed from the environment when Exim
15632 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15633 unfortunately not all, operating systems.
15634
15635
15636 .option tls_advertise_hosts main "host list&!!" unset
15637 .cindex "TLS" "advertising"
15638 .cindex "encryption" "on SMTP connection"
15639 .cindex "SMTP" "encrypted connection"
15640 When Exim is built with support for TLS encrypted connections, the availability
15641 of the STARTTLS command to set up an encrypted session is advertised in
15642 response to EHLO only to those client hosts that match this option. See
15643 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15644
15645
15646 .option tls_certificate main string&!! unset
15647 .cindex "TLS" "server certificate; location of"
15648 .cindex "certificate" "server, location of"
15649 The value of this option is expanded, and must then be the absolute path to a
15650 file which contains the server's certificates. The server's private key is also
15651 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15652 &<<CHAPTLS>>& for further details.
15653
15654 &*Note*&: The certificates defined by this option are used only when Exim is
15655 receiving incoming messages as a server. If you want to supply certificates for
15656 use when sending messages as a client, you must set the &%tls_certificate%&
15657 option in the relevant &(smtp)& transport.
15658
15659 .new
15660 If the option contains &$tls_sni$& and Exim is built against OpenSSL, then
15661 if the OpenSSL build supports TLS extensions and the TLS client sends the
15662 Server Name Indication extension, then this option and others documented in
15663 &<<SECTtlssni>>& will be re-expanded.
15664 .wen
15665
15666 .option tls_crl main string&!! unset
15667 .cindex "TLS" "server certificate revocation list"
15668 .cindex "certificate" "revocation list for server"
15669 This option specifies a certificate revocation list. The expanded value must
15670 be the name of a file that contains a CRL in PEM format.
15671
15672 .new
15673 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15674 .wen
15675
15676
15677 .option tls_dhparam main string&!! unset
15678 .cindex "TLS" "D-H parameters for server"
15679 The value of this option is expanded, and must then be the absolute path to
15680 a file which contains the server's DH parameter values.
15681 This is used only for OpenSSL. When Exim is linked with GnuTLS, this option is
15682 ignored. See section &<<SECTopenvsgnu>>& for further details.
15683
15684
15685 .option tls_on_connect_ports main "string list" unset
15686 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15687 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15688 set up without waiting for the client to issue a STARTTLS command. For
15689 further details, see section &<<SECTsupobssmt>>&.
15690
15691
15692
15693 .option tls_privatekey main string&!! unset
15694 .cindex "TLS" "server private key; location of"
15695 The value of this option is expanded, and must then be the absolute path to a
15696 file which contains the server's private key. If this option is unset, or if
15697 the expansion is forced to fail, or the result is an empty string, the private
15698 key is assumed to be in the same file as the server's certificates. See chapter
15699 &<<CHAPTLS>>& for further details.
15700
15701 .new
15702 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15703 .wen
15704
15705
15706 .option tls_remember_esmtp main boolean false
15707 .cindex "TLS" "esmtp state; remembering"
15708 .cindex "TLS" "broken clients"
15709 If this option is set true, Exim violates the RFCs by remembering that it is in
15710 &"esmtp"& state after successfully negotiating a TLS session. This provides
15711 support for broken clients that fail to send a new EHLO after starting a
15712 TLS session.
15713
15714
15715 .option tls_require_ciphers main string&!! unset
15716 .cindex "TLS" "requiring specific ciphers"
15717 .cindex "cipher" "requiring specific"
15718 This option controls which ciphers can be used for incoming TLS connections.
15719 The &(smtp)& transport has an option of the same name for controlling outgoing
15720 connections. This option is expanded for each connection, so can be varied for
15721 different clients if required. The value of this option must be a list of
15722 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15723 in somewhat different ways. If GnuTLS is being used, the client controls the
15724 preference order of the available ciphers. Details are given in sections
15725 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15726
15727
15728 .option tls_try_verify_hosts main "host list&!!" unset
15729 .cindex "TLS" "client certificate verification"
15730 .cindex "certificate" "verification of client"
15731 See &%tls_verify_hosts%& below.
15732
15733
15734 .option tls_verify_certificates main string&!! unset
15735 .cindex "TLS" "client certificate verification"
15736 .cindex "certificate" "verification of client"
15737 The value of this option is expanded, and must then be the absolute path to
15738 a file containing permitted certificates for clients that
15739 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15740 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15741 directory containing certificate files. This does not work with GnuTLS; the
15742 option must be set to the name of a single file if you are using GnuTLS.
15743
15744 These certificates should be for the certificate authorities trusted, rather
15745 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
15746 the value is a file then the certificates are sent by Exim as a server to
15747 connecting clients, defining the list of accepted certificate authorities.
15748 Thus the values defined should be considered public data.  To avoid this,
15749 use OpenSSL with a directory.
15750
15751 .new
15752 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15753 .wen
15754
15755
15756 .option tls_verify_hosts main "host list&!!" unset
15757 .cindex "TLS" "client certificate verification"
15758 .cindex "certificate" "verification of client"
15759 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15760 certificates from clients. The expected certificates are defined by
15761 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15762 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15763 &%tls_verify_certificates%& is not set.
15764
15765 Any client that matches &%tls_verify_hosts%& is constrained by
15766 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15767 present one of the listed certificates. If it does not, the connection is
15768 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15769 the host to use TLS. It can still send SMTP commands through unencrypted
15770 connections. Forcing a client to use TLS has to be done separately using an
15771 ACL to reject inappropriate commands when the connection is not encrypted.
15772
15773 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15774 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15775 certificate and checks it against &%tls_verify_certificates%&, but does not
15776 abort the connection if there is no certificate or if it does not match. This
15777 state can be detected in an ACL, which makes it possible to implement policies
15778 such as &"accept for relay only if a verified certificate has been received,
15779 but accept for local delivery if encrypted, even without a verified
15780 certificate"&.
15781
15782 Client hosts that match neither of these lists are not asked to present
15783 certificates.
15784
15785
15786 .option trusted_groups main "string list&!!" unset
15787 .cindex "trusted groups"
15788 .cindex "groups" "trusted"
15789 This option is expanded just once, at the start of Exim's processing. If this
15790 option is set, any process that is running in one of the listed groups, or
15791 which has one of them as a supplementary group, is trusted. The groups can be
15792 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15793 details of what trusted callers are permitted to do. If neither
15794 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15795 are trusted.
15796
15797 .option trusted_users main "string list&!!" unset
15798 .cindex "trusted users"
15799 .cindex "user" "trusted"
15800 This option is expanded just once, at the start of Exim's processing. If this
15801 option is set, any process that is running as one of the listed users is
15802 trusted. The users can be specified numerically or by name. See section
15803 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15804 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15805 Exim user are trusted.
15806
15807 .option unknown_login main string&!! unset
15808 .cindex "uid (user id)" "unknown caller"
15809 .vindex "&$caller_uid$&"
15810 This is a specialized feature for use in unusual configurations. By default, if
15811 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15812 gives up. The &%unknown_login%& option can be used to set a login name to be
15813 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15814 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15815 is used for the user's real name (gecos field), unless this has been set by the
15816 &%-F%& option.
15817
15818 .option unknown_username main string unset
15819 See &%unknown_login%&.
15820
15821 .option untrusted_set_sender main "address list&!!" unset
15822 .cindex "trusted users"
15823 .cindex "sender" "setting by untrusted user"
15824 .cindex "untrusted user setting sender"
15825 .cindex "user" "untrusted setting sender"
15826 .cindex "envelope sender"
15827 When an untrusted user submits a message to Exim using the standard input, Exim
15828 normally creates an envelope sender address from the user's login and the
15829 default qualification domain. Data from the &%-f%& option (for setting envelope
15830 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15831 is used) is ignored.
15832
15833 However, untrusted users are permitted to set an empty envelope sender address,
15834 to declare that a message should never generate any bounces. For example:
15835 .code
15836 exim -f '<>' user@domain.example
15837 .endd
15838 .vindex "&$sender_ident$&"
15839 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15840 other envelope sender addresses in a controlled way. When it is set, untrusted
15841 users are allowed to set envelope sender addresses that match any of the
15842 patterns in the list. Like all address lists, the string is expanded. The
15843 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15844 users to setting senders that start with their login ids
15845 followed by a hyphen
15846 by a setting like this:
15847 .code
15848 untrusted_set_sender = ^$sender_ident-
15849 .endd
15850 If you want to allow untrusted users to set envelope sender addresses without
15851 restriction, you can use
15852 .code
15853 untrusted_set_sender = *
15854 .endd
15855 The &%untrusted_set_sender%& option applies to all forms of local input, but
15856 only to the setting of the envelope sender. It does not permit untrusted users
15857 to use the other options which trusted user can use to override message
15858 parameters. Furthermore, it does not stop Exim from removing an existing
15859 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15860 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15861 overriding these actions. The handling of the &'Sender:'& header is also
15862 described in section &<<SECTthesenhea>>&.
15863
15864 The log line for a message's arrival shows the envelope sender following
15865 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15866 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15867 envelope sender address, the user's login is shown in parentheses after the
15868 sender address.
15869
15870
15871 .option uucp_from_pattern main string "see below"
15872 .cindex "&""From""& line"
15873 .cindex "UUCP" "&""From""& line"
15874 Some applications that pass messages to an MTA via a command line interface use
15875 an initial line starting with &"From&~"& to pass the envelope sender. In
15876 particular, this is used by UUCP software. Exim recognizes such a line by means
15877 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15878 matches, the sender address is constructed by expanding the contents of
15879 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15880 default pattern recognizes lines in the following two forms:
15881 .code
15882 From ph10 Fri Jan  5 12:35 GMT 1996
15883 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15884 .endd
15885 The pattern can be seen by running
15886 .code
15887 exim -bP uucp_from_pattern
15888 .endd
15889 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15890 year in the second case. The first word after &"From&~"& is matched in the
15891 regular expression by a parenthesized subpattern. The default value for
15892 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15893 (&"ph10"& in the example above) as the message's sender. See also
15894 &%ignore_fromline_hosts%&.
15895
15896
15897 .option uucp_from_sender main string&!! &`$1`&
15898 See &%uucp_from_pattern%& above.
15899
15900
15901 .option warn_message_file main string unset
15902 .cindex "warning of delay" "customizing the message"
15903 .cindex "customizing" "warning message"
15904 This option defines a template file containing paragraphs of text to be used
15905 for constructing the warning message which is sent by Exim when a message has
15906 been on the queue for a specified amount of time, as specified by
15907 &%delay_warning%&. Details of the file's contents are given in chapter
15908 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15909
15910
15911 .option write_rejectlog main boolean true
15912 .cindex "reject log" "disabling"
15913 If this option is set false, Exim no longer writes anything to the reject log.
15914 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15915 .ecindex IIDconfima
15916 .ecindex IIDmaiconf
15917
15918
15919
15920
15921 . ////////////////////////////////////////////////////////////////////////////
15922 . ////////////////////////////////////////////////////////////////////////////
15923
15924 .chapter "Generic options for routers" "CHAProutergeneric"
15925 .scindex IIDgenoprou1 "options" "generic; for routers"
15926 .scindex IIDgenoprou2 "generic options" "router"
15927 This chapter describes the generic options that apply to all routers.
15928 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15929
15930 For a general description of how a router operates, see sections
15931 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15932 which the preconditions are tested. The order of expansion of the options that
15933 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15934 &%headers_remove%&, &%transport%&.
15935
15936
15937
15938 .option address_data routers string&!! unset
15939 .cindex "router" "data attached to address"
15940 The string is expanded just before the router is run, that is, after all the
15941 precondition tests have succeeded. If the expansion is forced to fail, the
15942 router declines, the value of &%address_data%& remains unchanged, and the
15943 &%more%& option controls what happens next. Other expansion failures cause
15944 delivery of the address to be deferred.
15945
15946 .vindex "&$address_data$&"
15947 When the expansion succeeds, the value is retained with the address, and can be
15948 accessed using the variable &$address_data$& in the current router, subsequent
15949 routers, and the eventual transport.
15950
15951 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15952 that runs a user's filter file, the contents of &$address_data$& are accessible
15953 in the filter. This is not normally a problem, because such data is usually
15954 either not confidential or it &"belongs"& to the current user, but if you do
15955 put confidential data into &$address_data$& you need to remember this point.
15956
15957 Even if the router declines or passes, the value of &$address_data$& remains
15958 with the address, though it can be changed by another &%address_data%& setting
15959 on a subsequent router. If a router generates child addresses, the value of
15960 &$address_data$& propagates to them. This also applies to the special kind of
15961 &"child"& that is generated by a router with the &%unseen%& option.
15962
15963 The idea of &%address_data%& is that you can use it to look up a lot of data
15964 for the address once, and then pick out parts of the data later. For example,
15965 you could use a single LDAP lookup to return a string of the form
15966 .code
15967 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15968 .endd
15969 In the transport you could pick out the mailbox by a setting such as
15970 .code
15971 file = ${extract{mailbox}{$address_data}}
15972 .endd
15973 This makes the configuration file less messy, and also reduces the number of
15974 lookups (though Exim does cache lookups).
15975
15976 .vindex "&$sender_address_data$&"
15977 .vindex "&$address_data$&"
15978 The &%address_data%& facility is also useful as a means of passing information
15979 from one router to another, and from a router to a transport. In addition, if
15980 &$address_data$& is set by a router when verifying a recipient address from an
15981 ACL, it remains available for use in the rest of the ACL statement. After
15982 verifying a sender, the value is transferred to &$sender_address_data$&.
15983
15984
15985
15986 .option address_test routers&!? boolean true
15987 .oindex "&%-bt%&"
15988 .cindex "router" "skipping when address testing"
15989 If this option is set false, the router is skipped when routing is being tested
15990 by means of the &%-bt%& command line option. This can be a convenience when
15991 your first router sends messages to an external scanner, because it saves you
15992 having to set the &"already scanned"& indicator when testing real address
15993 routing.
15994
15995
15996
15997 .option cannot_route_message routers string&!! unset
15998 .cindex "router" "customizing &""cannot route""& message"
15999 .cindex "customizing" "&""cannot route""& message"
16000 This option specifies a text message that is used when an address cannot be
16001 routed because Exim has run out of routers. The default message is
16002 &"Unrouteable address"&. This option is useful only on routers that have
16003 &%more%& set false, or on the very last router in a configuration, because the
16004 value that is used is taken from the last router that is considered. This
16005 includes a router that is skipped because its preconditions are not met, as
16006 well as a router that declines. For example, using the default configuration,
16007 you could put:
16008 .code
16009 cannot_route_message = Remote domain not found in DNS
16010 .endd
16011 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16012 and
16013 .code
16014 cannot_route_message = Unknown local user
16015 .endd
16016 on the final router that checks for local users. If string expansion fails for
16017 this option, the default message is used. Unless the expansion failure was
16018 explicitly forced, a message about the failure is written to the main and panic
16019 logs, in addition to the normal message about the routing failure.
16020
16021
16022 .option caseful_local_part routers boolean false
16023 .cindex "case of local parts"
16024 .cindex "router" "case of local parts"
16025 By default, routers handle the local parts of addresses in a case-insensitive
16026 manner, though the actual case is preserved for transmission with the message.
16027 If you want the case of letters to be significant in a router, you must set
16028 this option true. For individual router options that contain address or local
16029 part lists (for example, &%local_parts%&), case-sensitive matching can be
16030 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16031 more details.
16032
16033 .vindex "&$local_part$&"
16034 .vindex "&$original_local_part$&"
16035 .vindex "&$parent_local_part$&"
16036 The value of the &$local_part$& variable is forced to lower case while a
16037 router is running unless &%caseful_local_part%& is set. When a router assigns
16038 an address to a transport, the value of &$local_part$& when the transport runs
16039 is the same as it was in the router. Similarly, when a router generates child
16040 addresses by aliasing or forwarding, the values of &$original_local_part$&
16041 and &$parent_local_part$& are those that were used by the redirecting router.
16042
16043 This option applies to the processing of an address by a router. When a
16044 recipient address is being processed in an ACL, there is a separate &%control%&
16045 modifier that can be used to specify case-sensitive processing within the ACL
16046 (see section &<<SECTcontrols>>&).
16047
16048
16049
16050 .option check_local_user routers&!? boolean false
16051 .cindex "local user, checking in router"
16052 .cindex "router" "checking for local user"
16053 .cindex "&_/etc/passwd_&"
16054 .vindex "&$home$&"
16055 When this option is true, Exim checks that the local part of the recipient
16056 address (with affixes removed if relevant) is the name of an account on the
16057 local system. The check is done by calling the &[getpwnam()]& function rather
16058 than trying to read &_/etc/passwd_& directly. This means that other methods of
16059 holding password data (such as NIS) are supported. If the local part is a local
16060 user, &$home$& is set from the password data, and can be tested in other
16061 preconditions that are evaluated after this one (the order of evaluation is
16062 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16063 overridden by &%router_home_directory%&. If the local part is not a local user,
16064 the router is skipped.
16065
16066 If you want to check that the local part is either the name of a local user
16067 or matches something else, you cannot combine &%check_local_user%& with a
16068 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16069 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16070 setting to achieve this. For example:
16071 .code
16072 local_parts = passwd;$local_part : lsearch;/etc/other/users
16073 .endd
16074 Note, however, that the side effects of &%check_local_user%& (such as setting
16075 up a home directory) do not occur when a &(passwd)& lookup is used in a
16076 &%local_parts%& (or any other) precondition.
16077
16078
16079
16080 .option condition routers&!? string&!! unset
16081 .cindex "router" "customized precondition"
16082 This option specifies a general precondition test that has to succeed for the
16083 router to be called. The &%condition%& option is the last precondition to be
16084 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16085 result is a forced failure, or an empty string, or one of the strings &"0"& or
16086 &"no"& or &"false"& (checked without regard to the case of the letters), the
16087 router is skipped, and the address is offered to the next one.
16088
16089 If the result is any other value, the router is run (as this is the last
16090 precondition to be evaluated, all the other preconditions must be true).
16091
16092 This option is unique in that multiple &%condition%& options may be present.
16093 All &%condition%& options must succeed.
16094
16095 The &%condition%& option provides a means of applying custom conditions to the
16096 running of routers. Note that in the case of a simple conditional expansion,
16097 the default expansion values are exactly what is wanted. For example:
16098 .code
16099 condition = ${if >{$message_age}{600}}
16100 .endd
16101 Because of the default behaviour of the string expansion, this is equivalent to
16102 .code
16103 condition = ${if >{$message_age}{600}{true}{}}
16104 .endd
16105
16106 A multiple condition example, which succeeds:
16107 .code
16108 condition = ${if >{$message_age}{600}}
16109 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16110 condition = foobar
16111 .endd
16112
16113 If the expansion fails (other than forced failure) delivery is deferred. Some
16114 of the other precondition options are common special cases that could in fact
16115 be specified using &%condition%&.
16116
16117
16118 .option debug_print routers string&!! unset
16119 .cindex "testing" "variables in drivers"
16120 If this option is set and debugging is enabled (see the &%-d%& command line
16121 option), the string is expanded and included in the debugging output.
16122 If expansion of the string fails, the error message is written to the debugging
16123 output, and Exim carries on processing.
16124 This option is provided to help with checking out the values of variables and
16125 so on when debugging router configurations. For example, if a &%condition%&
16126 option appears not to be working, &%debug_print%& can be used to output the
16127 variables it references. The output happens after checks for &%domains%&,
16128 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16129 are tested. A newline is added to the text if it does not end with one.
16130
16131
16132
16133 .option disable_logging routers boolean false
16134 If this option is set true, nothing is logged for any routing errors
16135 or for any deliveries caused by this router. You should not set this option
16136 unless you really, really know what you are doing. See also the generic
16137 transport option of the same name.
16138
16139
16140 .option domains routers&!? "domain list&!!" unset
16141 .cindex "router" "restricting to specific domains"
16142 .vindex "&$domain_data$&"
16143 If this option is set, the router is skipped unless the current domain matches
16144 the list. If the match is achieved by means of a file lookup, the data that the
16145 lookup returned for the domain is placed in &$domain_data$& for use in string
16146 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16147 a list of the order in which preconditions are evaluated.
16148
16149
16150
16151 .option driver routers string unset
16152 This option must always be set. It specifies which of the available routers is
16153 to be used.
16154
16155
16156
16157 .option errors_to routers string&!! unset
16158 .cindex "envelope sender"
16159 .cindex "router" "changing address for errors"
16160 If a router successfully handles an address, it may assign the address to a
16161 transport for delivery or it may generate child addresses. In both cases, if
16162 there is a delivery problem during later processing, the resulting bounce
16163 message is sent to the address that results from expanding this string,
16164 provided that the address verifies successfully. The &%errors_to%& option is
16165 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16166
16167 The &%errors_to%& setting associated with an address can be overridden if it
16168 subsequently passes through other routers that have their own &%errors_to%&
16169 settings, or if the message is delivered by a transport with a &%return_path%&
16170 setting.
16171
16172 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16173 the expansion fails to verify, the errors address associated with the incoming
16174 address is used. At top level, this is the envelope sender. A non-forced
16175 expansion failure causes delivery to be deferred.
16176
16177 If an address for which &%errors_to%& has been set ends up being delivered over
16178 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16179 any bounces that are generated by other MTAs on the delivery route are also
16180 sent there. You can set &%errors_to%& to the empty string by either of these
16181 settings:
16182 .code
16183 errors_to =
16184 errors_to = ""
16185 .endd
16186 An expansion item that yields an empty string has the same effect. If you do
16187 this, a locally detected delivery error for addresses processed by this router
16188 no longer gives rise to a bounce message; the error is discarded. If the
16189 address is delivered to a remote host, the return path is set to &`<>`&, unless
16190 overridden by the &%return_path%& option on the transport.
16191
16192 .vindex "&$address_data$&"
16193 If for some reason you want to discard local errors, but use a non-empty
16194 MAIL command for remote delivery, you can preserve the original return
16195 path in &$address_data$& in the router, and reinstate it in the transport by
16196 setting &%return_path%&.
16197
16198 The most common use of &%errors_to%& is to direct mailing list bounces to the
16199 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16200 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16201
16202
16203
16204 .option expn routers&!? boolean true
16205 .cindex "address" "testing"
16206 .cindex "testing" "addresses"
16207 .cindex "EXPN" "router skipping"
16208 .cindex "router" "skipping for EXPN"
16209 If this option is turned off, the router is skipped when testing an address
16210 as a result of processing an SMTP EXPN command. You might, for example,
16211 want to turn it off on a router for users' &_.forward_& files, while leaving it
16212 on for the system alias file.
16213 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16214 are evaluated.
16215
16216 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16217 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16218 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16219
16220
16221
16222 .option fail_verify routers boolean false
16223 .cindex "router" "forcing verification failure"
16224 Setting this option has the effect of setting both &%fail_verify_sender%& and
16225 &%fail_verify_recipient%& to the same value.
16226
16227
16228
16229 .option fail_verify_recipient routers boolean false
16230 If this option is true and an address is accepted by this router when
16231 verifying a recipient, verification fails.
16232
16233
16234
16235 .option fail_verify_sender routers boolean false
16236 If this option is true and an address is accepted by this router when
16237 verifying a sender, verification fails.
16238
16239
16240
16241 .option fallback_hosts routers "string list" unset
16242 .cindex "router" "fallback hosts"
16243 .cindex "fallback" "hosts specified on router"
16244 String expansion is not applied to this option. The argument must be a
16245 colon-separated list of host names or IP addresses. The list separator can be
16246 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16247 each name or address. In fact, the format of each item is exactly the same as
16248 defined for the list of hosts in a &(manualroute)& router (see section
16249 &<<SECTformatonehostitem>>&).
16250
16251 If a router queues an address for a remote transport, this host list is
16252 associated with the address, and used instead of the transport's fallback host
16253 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16254 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16255 transport for further details.
16256
16257
16258 .option group routers string&!! "see below"
16259 .cindex "gid (group id)" "local delivery"
16260 .cindex "local transports" "uid and gid"
16261 .cindex "transport" "local"
16262 .cindex "router" "setting group"
16263 When a router queues an address for a transport, and the transport does not
16264 specify a group, the group given here is used when running the delivery
16265 process.
16266 The group may be specified numerically or by name. If expansion fails, the
16267 error is logged and delivery is deferred.
16268 The default is unset, unless &%check_local_user%& is set, when the default
16269 is taken from the password information. See also &%initgroups%& and &%user%&
16270 and the discussion in chapter &<<CHAPenvironment>>&.
16271
16272
16273
16274 .option headers_add routers string&!! unset
16275 .cindex "header lines" "adding"
16276 .cindex "router" "adding header lines"
16277 This option specifies a string of text that is expanded at routing time, and
16278 associated with any addresses that are accepted by the router. However, this
16279 option has no effect when an address is just being verified. The way in which
16280 the text is used to add header lines at transport time is described in section
16281 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16282 message is in the process of being transported. This means that references to
16283 header lines in string expansions in the transport's configuration do not
16284 &"see"& the added header lines.
16285
16286 The &%headers_add%& option is expanded after &%errors_to%&, but before
16287 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16288 the expansion is forced to fail, the option has no effect. Other expansion
16289 failures are treated as configuration errors.
16290
16291 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16292 router that has the &%one_time%& option set.
16293
16294 .cindex "duplicate addresses"
16295 .oindex "&%unseen%&"
16296 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16297 additions are deleted when the address is passed on to subsequent routers.
16298 For a &%redirect%& router, if a generated address is the same as the incoming
16299 address, this can lead to duplicate addresses with different header
16300 modifications. Exim does not do duplicate deliveries (except, in certain
16301 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16302 which of the duplicates is discarded, so this ambiguous situation should be
16303 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16304
16305
16306
16307 .option headers_remove routers string&!! unset
16308 .cindex "header lines" "removing"
16309 .cindex "router" "removing header lines"
16310 This option specifies a string of text that is expanded at routing time, and
16311 associated with any addresses that are accepted by the router. However, this
16312 option has no effect when an address is just being verified. The way in which
16313 the text is used to remove header lines at transport time is described in
16314 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16315 the message is in the process of being transported. This means that references
16316 to header lines in string expansions in the transport's configuration still
16317 &"see"& the original header lines.
16318
16319 The &%headers_remove%& option is expanded after &%errors_to%& and
16320 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16321 the option has no effect. Other expansion failures are treated as configuration
16322 errors.
16323
16324 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16325 router that has the &%one_time%& option set.
16326
16327 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16328 removal requests are deleted when the address is passed on to subsequent
16329 routers, and this can lead to problems with duplicates -- see the similar
16330 warning for &%headers_add%& above.
16331
16332
16333 .option ignore_target_hosts routers "host list&!!" unset
16334 .cindex "IP address" "discarding"
16335 .cindex "router" "discarding IP addresses"
16336 Although this option is a host list, it should normally contain IP address
16337 entries rather than names. If any host that is looked up by the router has an
16338 IP address that matches an item in this list, Exim behaves as if that IP
16339 address did not exist. This option allows you to cope with rogue DNS entries
16340 like
16341 .code
16342 remote.domain.example.  A  127.0.0.1
16343 .endd
16344 by setting
16345 .code
16346 ignore_target_hosts = 127.0.0.1
16347 .endd
16348 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16349 discarded in this way, the router declines. In a conventional configuration, an
16350 attempt to mail to such a domain would normally provoke the &"unrouteable
16351 domain"& error, and an attempt to verify an address in the domain would fail.
16352 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16353 router declines if presented with one of the listed addresses.
16354
16355 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16356 means of the first or the second of the following settings, respectively:
16357 .code
16358 ignore_target_hosts = 0.0.0.0/0
16359 ignore_target_hosts = <; 0::0/0
16360 .endd
16361 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16362 in the second line matches all IPv6 addresses.
16363
16364 This option may also be useful for ignoring link-local and site-local IPv6
16365 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16366 is expanded before use as a list, it is possible to make it dependent on the
16367 domain that is being routed.
16368
16369 .vindex "&$host_address$&"
16370 During its expansion, &$host_address$& is set to the IP address that is being
16371 checked.
16372
16373 .option initgroups routers boolean false
16374 .cindex "additional groups"
16375 .cindex "groups" "additional"
16376 .cindex "local transports" "uid and gid"
16377 .cindex "transport" "local"
16378 If the router queues an address for a transport, and this option is true, and
16379 the uid supplied by the router is not overridden by the transport, the
16380 &[initgroups()]& function is called when running the transport to ensure that
16381 any additional groups associated with the uid are set up. See also &%group%&
16382 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16383
16384
16385
16386 .option local_part_prefix routers&!? "string list" unset
16387 .cindex "router" "prefix for local part"
16388 .cindex "prefix" "for local part, used in router"
16389 If this option is set, the router is skipped unless the local part starts with
16390 one of the given strings, or &%local_part_prefix_optional%& is true. See
16391 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16392 evaluated.
16393
16394 The list is scanned from left to right, and the first prefix that matches is
16395 used. A limited form of wildcard is available; if the prefix begins with an
16396 asterisk, it matches the longest possible sequence of arbitrary characters at
16397 the start of the local part. An asterisk should therefore always be followed by
16398 some character that does not occur in normal local parts.
16399 .cindex "multiple mailboxes"
16400 .cindex "mailbox" "multiple"
16401 Wildcarding can be used to set up multiple user mailboxes, as described in
16402 section &<<SECTmulbox>>&.
16403
16404 .vindex "&$local_part$&"
16405 .vindex "&$local_part_prefix$&"
16406 During the testing of the &%local_parts%& option, and while the router is
16407 running, the prefix is removed from the local part, and is available in the
16408 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16409 the router accepts the address, this remains true during subsequent delivery by
16410 a transport. In particular, the local part that is transmitted in the RCPT
16411 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16412 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16413 the relevant transport.
16414
16415 When an address is being verified, &%local_part_prefix%& affects only the
16416 behaviour of the router. If the callout feature of verification is in use, this
16417 means that the full address, including the prefix, will be used during the
16418 callout.
16419
16420 The prefix facility is commonly used to handle local parts of the form
16421 &%owner-something%&. Another common use is to support local parts of the form
16422 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16423 to tell a user their forwarding is broken &-- by placing a router like this one
16424 immediately before the router that handles &_.forward_& files:
16425 .code
16426 real_localuser:
16427   driver = accept
16428   local_part_prefix = real-
16429   check_local_user
16430   transport = local_delivery
16431 .endd
16432 For security, it would probably be a good idea to restrict the use of this
16433 router to locally-generated messages, using a condition such as this:
16434 .code
16435   condition = ${if match {$sender_host_address}\
16436                          {\N^(|127\.0\.0\.1)$\N}}
16437 .endd
16438
16439 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16440 both conditions must be met if not optional. Care must be taken if wildcards
16441 are used in both a prefix and a suffix on the same router. Different
16442 separator characters must be used to avoid ambiguity.
16443
16444
16445 .option local_part_prefix_optional routers boolean false
16446 See &%local_part_prefix%& above.
16447
16448
16449
16450 .option local_part_suffix routers&!? "string list" unset
16451 .cindex "router" "suffix for local part"
16452 .cindex "suffix for local part" "used in router"
16453 This option operates in the same way as &%local_part_prefix%&, except that the
16454 local part must end (rather than start) with the given string, the
16455 &%local_part_suffix_optional%& option determines whether the suffix is
16456 mandatory, and the wildcard * character, if present, must be the last
16457 character of the suffix. This option facility is commonly used to handle local
16458 parts of the form &%something-request%& and multiple user mailboxes of the form
16459 &%username-foo%&.
16460
16461
16462 .option local_part_suffix_optional routers boolean false
16463 See &%local_part_suffix%& above.
16464
16465
16466
16467 .option local_parts routers&!? "local part list&!!" unset
16468 .cindex "router" "restricting to specific local parts"
16469 .cindex "local part" "checking in router"
16470 The router is run only if the local part of the address matches the list.
16471 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16472 are evaluated, and
16473 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16474 string is expanded, it is possible to make it depend on the domain, for
16475 example:
16476 .code
16477 local_parts = dbm;/usr/local/specials/$domain
16478 .endd
16479 .vindex "&$local_part_data$&"
16480 If the match is achieved by a lookup, the data that the lookup returned
16481 for the local part is placed in the variable &$local_part_data$& for use in
16482 expansions of the router's private options. You might use this option, for
16483 example, if you have a large number of local virtual domains, and you want to
16484 send all postmaster mail to the same place without having to set up an alias in
16485 each virtual domain:
16486 .code
16487 postmaster:
16488   driver = redirect
16489   local_parts = postmaster
16490   data = postmaster@real.domain.example
16491 .endd
16492
16493
16494 .option log_as_local routers boolean "see below"
16495 .cindex "log" "delivery line"
16496 .cindex "delivery" "log line format"
16497 Exim has two logging styles for delivery, the idea being to make local
16498 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16499 recipient address is given just as the local part, without a domain. The use of
16500 this style is controlled by this option. It defaults to true for the &(accept)&
16501 router, and false for all the others. This option applies only when a
16502 router assigns an address to a transport. It has no effect on routers that
16503 redirect addresses.
16504
16505
16506
16507 .option more routers boolean&!! true
16508 The result of string expansion for this option must be a valid boolean value,
16509 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16510 result causes an error, and delivery is deferred. If the expansion is forced to
16511 fail, the default value for the option (true) is used. Other failures cause
16512 delivery to be deferred.
16513
16514 If this option is set false, and the router declines to handle the address, no
16515 further routers are tried, routing fails, and the address is bounced.
16516 .oindex "&%self%&"
16517 However, if the router explicitly passes an address to the following router by
16518 means of the setting
16519 .code
16520 self = pass
16521 .endd
16522 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16523 does not affect the behaviour if one of the precondition tests fails. In that
16524 case, the address is always passed to the next router.
16525
16526 Note that &%address_data%& is not considered to be a precondition. If its
16527 expansion is forced to fail, the router declines, and the value of &%more%&
16528 controls what happens next.
16529
16530
16531 .option pass_on_timeout routers boolean false
16532 .cindex "timeout" "of router"
16533 .cindex "router" "timeout"
16534 If a router times out during a host lookup, it normally causes deferral of the
16535 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16536 router, overriding &%no_more%&. This may be helpful for systems that are
16537 intermittently connected to the Internet, or those that want to pass to a smart
16538 host any messages that cannot immediately be delivered.
16539
16540 There are occasional other temporary errors that can occur while doing DNS
16541 lookups. They are treated in the same way as a timeout, and this option
16542 applies to all of them.
16543
16544
16545
16546 .option pass_router routers string unset
16547 .cindex "router" "go to after &""pass""&"
16548 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16549 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16550 routing to continue, and overriding a false setting of &%more%&. When one of
16551 these routers returns &"pass"&, the address is normally handed on to the next
16552 router in sequence. This can be changed by setting &%pass_router%& to the name
16553 of another router. However (unlike &%redirect_router%&) the named router must
16554 be below the current router, to avoid loops. Note that this option applies only
16555 to the special case of &"pass"&. It does not apply when a router returns
16556 &"decline"& because it cannot handle an address.
16557
16558
16559
16560 .option redirect_router routers string unset
16561 .cindex "router" "start at after redirection"
16562 Sometimes an administrator knows that it is pointless to reprocess addresses
16563 generated from alias or forward files with the same router again. For
16564 example, if an alias file translates real names into login ids there is no
16565 point searching the alias file a second time, especially if it is a large file.
16566
16567 The &%redirect_router%& option can be set to the name of any router instance.
16568 It causes the routing of any generated addresses to start at the named router
16569 instead of at the first router. This option has no effect if the router in
16570 which it is set does not generate new addresses.
16571
16572
16573
16574 .option require_files routers&!? "string list&!!" unset
16575 .cindex "file" "requiring for router"
16576 .cindex "router" "requiring file existence"
16577 This option provides a general mechanism for predicating the running of a
16578 router on the existence or non-existence of certain files or directories.
16579 Before running a router, as one of its precondition tests, Exim works its way
16580 through the &%require_files%& list, expanding each item separately.
16581
16582 Because the list is split before expansion, any colons in expansion items must
16583 be doubled, or the facility for using a different list separator must be used.
16584 If any expansion is forced to fail, the item is ignored. Other expansion
16585 failures cause routing of the address to be deferred.
16586
16587 If any expanded string is empty, it is ignored. Otherwise, except as described
16588 below, each string must be a fully qualified file path, optionally preceded by
16589 &"!"&. The paths are passed to the &[stat()]& function to test for the
16590 existence of the files or directories. The router is skipped if any paths not
16591 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16592
16593 .cindex "NFS"
16594 If &[stat()]& cannot determine whether a file exists or not, delivery of
16595 the message is deferred. This can happen when NFS-mounted filesystems are
16596 unavailable.
16597
16598 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16599 options, so you cannot use it to check for the existence of a file in which to
16600 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16601 full list of the order in which preconditions are evaluated.) However, as
16602 these options are all expanded, you can use the &%exists%& expansion condition
16603 to make such tests. The &%require_files%& option is intended for checking files
16604 that the router may be going to use internally, or which are needed by a
16605 transport (for example &_.procmailrc_&).
16606
16607 During delivery, the &[stat()]& function is run as root, but there is a
16608 facility for some checking of the accessibility of a file by another user.
16609 This is not a proper permissions check, but just a &"rough"& check that
16610 operates as follows:
16611
16612 If an item in a &%require_files%& list does not contain any forward slash
16613 characters, it is taken to be the user (and optional group, separated by a
16614 comma) to be checked for subsequent files in the list. If no group is specified
16615 but the user is specified symbolically, the gid associated with the uid is
16616 used. For example:
16617 .code
16618 require_files = mail:/some/file
16619 require_files = $local_part:$home/.procmailrc
16620 .endd
16621 If a user or group name in a &%require_files%& list does not exist, the
16622 &%require_files%& condition fails.
16623
16624 Exim performs the check by scanning along the components of the file path, and
16625 checking the access for the given uid and gid. It checks for &"x"& access on
16626 directories, and &"r"& access on the final file. Note that this means that file
16627 access control lists, if the operating system has them, are ignored.
16628
16629 &*Warning 1*&: When the router is being run to verify addresses for an
16630 incoming SMTP message, Exim is not running as root, but under its own uid. This
16631 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16632 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16633 user is not permitted to read one of the directories on the file's path.
16634
16635 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16636 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16637 without root access. In this case, if a check for access by a particular user
16638 is requested, Exim creates a subprocess that runs as that user, and tries the
16639 check again in that process.
16640
16641 The default action for handling an unresolved EACCES is to consider it to
16642 be caused by a configuration error, and routing is deferred because the
16643 existence or non-existence of the file cannot be determined. However, in some
16644 circumstances it may be desirable to treat this condition as if the file did
16645 not exist. If the file name (or the exclamation mark that precedes the file
16646 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16647 as if the file did not exist. For example:
16648 .code
16649 require_files = +/some/file
16650 .endd
16651 If the router is not an essential part of verification (for example, it
16652 handles users' &_.forward_& files), another solution is to set the &%verify%&
16653 option false so that the router is skipped when verifying.
16654
16655
16656
16657 .option retry_use_local_part routers boolean "see below"
16658 .cindex "hints database" "retry keys"
16659 .cindex "local part" "in retry keys"
16660 When a delivery suffers a temporary routing failure, a retry record is created
16661 in Exim's hints database. For addresses whose routing depends only on the
16662 domain, the key for the retry record should not involve the local part, but for
16663 other addresses, both the domain and the local part should be included.
16664 Usually, remote routing is of the former kind, and local routing is of the
16665 latter kind.
16666
16667 This option controls whether the local part is used to form the key for retry
16668 hints for addresses that suffer temporary errors while being handled by this
16669 router. The default value is true for any router that has &%check_local_user%&
16670 set, and false otherwise. Note that this option does not apply to hints keys
16671 for transport delays; they are controlled by a generic transport option of the
16672 same name.
16673
16674 The setting of &%retry_use_local_part%& applies only to the router on which it
16675 appears. If the router generates child addresses, they are routed
16676 independently; this setting does not become attached to them.
16677
16678
16679
16680 .option router_home_directory routers string&!! unset
16681 .cindex "router" "home directory for"
16682 .cindex "home directory" "for router"
16683 .vindex "&$home$&"
16684 This option sets a home directory for use while the router is running. (Compare
16685 &%transport_home_directory%&, which sets a home directory for later
16686 transporting.) In particular, if used on a &(redirect)& router, this option
16687 sets a value for &$home$& while a filter is running. The value is expanded;
16688 forced expansion failure causes the option to be ignored &-- other failures
16689 cause the router to defer.
16690
16691 Expansion of &%router_home_directory%& happens immediately after the
16692 &%check_local_user%& test (if configured), before any further expansions take
16693 place.
16694 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16695 are evaluated.)
16696 While the router is running, &%router_home_directory%& overrides the value of
16697 &$home$& that came from &%check_local_user%&.
16698
16699 When a router accepts an address and assigns it to a local transport (including
16700 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16701 delivery), the home directory setting for the transport is taken from the first
16702 of these values that is set:
16703
16704 .ilist
16705 The &%home_directory%& option on the transport;
16706 .next
16707 The &%transport_home_directory%& option on the router;
16708 .next
16709 The password data if &%check_local_user%& is set on the router;
16710 .next
16711 The &%router_home_directory%& option on the router.
16712 .endlist
16713
16714 In other words, &%router_home_directory%& overrides the password data for the
16715 router, but not for the transport.
16716
16717
16718
16719 .option self routers string freeze
16720 .cindex "MX record" "pointing to local host"
16721 .cindex "local host" "MX pointing to"
16722 This option applies to those routers that use a recipient address to find a
16723 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16724 and &(manualroute)& routers.
16725 Certain configurations of the &(queryprogram)& router can also specify a list
16726 of remote hosts.
16727 Usually such routers are configured to send the message to a remote host via an
16728 &(smtp)& transport. The &%self%& option specifies what happens when the first
16729 host on the list turns out to be the local host.
16730 The way in which Exim checks for the local host is described in section
16731 &<<SECTreclocipadd>>&.
16732
16733 Normally this situation indicates either an error in Exim's configuration (for
16734 example, the router should be configured not to process this domain), or an
16735 error in the DNS (for example, the MX should not point to this host). For this
16736 reason, the default action is to log the incident, defer the address, and
16737 freeze the message. The following alternatives are provided for use in special
16738 cases:
16739
16740 .vlist
16741 .vitem &%defer%&
16742 Delivery of the message is tried again later, but the message is not frozen.
16743
16744 .vitem "&%reroute%&: <&'domain'&>"
16745 The domain is changed to the given domain, and the address is passed back to
16746 be reprocessed by the routers. No rewriting of headers takes place. This
16747 behaviour is essentially a redirection.
16748
16749 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16750 The domain is changed to the given domain, and the address is passed back to be
16751 reprocessed by the routers. Any headers that contain the original domain are
16752 rewritten.
16753
16754 .vitem &%pass%&
16755 .oindex "&%more%&"
16756 .vindex "&$self_hostname$&"
16757 The router passes the address to the next router, or to the router named in the
16758 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16759 subsequent routing and delivery, the variable &$self_hostname$& contains the
16760 name of the local host that the router encountered. This can be used to
16761 distinguish between different cases for hosts with multiple names. The
16762 combination
16763 .code
16764 self = pass
16765 no_more
16766 .endd
16767 ensures that only those addresses that routed to the local host are passed on.
16768 Without &%no_more%&, addresses that were declined for other reasons would also
16769 be passed to the next router.
16770
16771 .vitem &%fail%&
16772 Delivery fails and an error report is generated.
16773
16774 .vitem &%send%&
16775 .cindex "local host" "sending to"
16776 The anomaly is ignored and the address is queued for the transport. This
16777 setting should be used with extreme caution. For an &(smtp)& transport, it
16778 makes sense only in cases where the program that is listening on the SMTP port
16779 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16780 different configuration file that handles the domain in another way.
16781 .endlist
16782
16783
16784
16785 .option senders routers&!? "address list&!!" unset
16786 .cindex "router" "checking senders"
16787 If this option is set, the router is skipped unless the message's sender
16788 address matches something on the list.
16789 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16790 are evaluated.
16791
16792 There are issues concerning verification when the running of routers is
16793 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16794 setting, it sets the sender to the null string. When using the &%-bt%& option
16795 to check a configuration file, it is necessary also to use the &%-f%& option to
16796 set an appropriate sender. For incoming mail, the sender is unset when
16797 verifying the sender, but is available when verifying any recipients. If the
16798 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16799 matters.
16800
16801
16802 .option translate_ip_address routers string&!! unset
16803 .cindex "IP address" "translating"
16804 .cindex "packet radio"
16805 .cindex "router" "IP address translation"
16806 There exist some rare networking situations (for example, packet radio) where
16807 it is helpful to be able to translate IP addresses generated by normal routing
16808 mechanisms into other IP addresses, thus performing a kind of manual IP
16809 routing. This should be done only if the normal IP routing of the TCP/IP stack
16810 is inadequate or broken. Because this is an extremely uncommon requirement, the
16811 code to support this option is not included in the Exim binary unless
16812 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16813
16814 .vindex "&$host_address$&"
16815 The &%translate_ip_address%& string is expanded for every IP address generated
16816 by the router, with the generated address set in &$host_address$&. If the
16817 expansion is forced to fail, no action is taken.
16818 For any other expansion error, delivery of the message is deferred.
16819 If the result of the expansion is an IP address, that replaces the original
16820 address; otherwise the result is assumed to be a host name &-- this is looked
16821 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16822 produce one or more replacement IP addresses. For example, to subvert all IP
16823 addresses in some specific networks, this could be added to a router:
16824 .code
16825 translate_ip_address = \
16826   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16827     {$value}fail}}
16828 .endd
16829 The file would contain lines like
16830 .code
16831 10.2.3.128/26    some.host
16832 10.8.4.34/26     10.44.8.15
16833 .endd
16834 You should not make use of this facility unless you really understand what you
16835 are doing.
16836
16837
16838
16839 .option transport routers string&!! unset
16840 This option specifies the transport to be used when a router accepts an address
16841 and sets it up for delivery. A transport is never needed if a router is used
16842 only for verification. The value of the option is expanded at routing time,
16843 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16844 and result must be the name of one of the configured transports. If it is not,
16845 delivery is deferred.
16846
16847 The &%transport%& option is not used by the &(redirect)& router, but it does
16848 have some private options that set up transports for pipe and file deliveries
16849 (see chapter &<<CHAPredirect>>&).
16850
16851
16852
16853 .option transport_current_directory routers string&!! unset
16854 .cindex "current directory for local transport"
16855 This option associates a current directory with any address that is routed
16856 to a local transport. This can happen either because a transport is
16857 explicitly configured for the router, or because it generates a delivery to a
16858 file or a pipe. During the delivery process (that is, at transport time), this
16859 option string is expanded and is set as the current directory, unless
16860 overridden by a setting on the transport.
16861 If the expansion fails for any reason, including forced failure, an error is
16862 logged, and delivery is deferred.
16863 See chapter &<<CHAPenvironment>>& for details of the local delivery
16864 environment.
16865
16866
16867
16868
16869 .option transport_home_directory routers string&!! "see below"
16870 .cindex "home directory" "for local transport"
16871 This option associates a home directory with any address that is routed to a
16872 local transport. This can happen either because a transport is explicitly
16873 configured for the router, or because it generates a delivery to a file or a
16874 pipe. During the delivery process (that is, at transport time), the option
16875 string is expanded and is set as the home directory, unless overridden by a
16876 setting of &%home_directory%& on the transport.
16877 If the expansion fails for any reason, including forced failure, an error is
16878 logged, and delivery is deferred.
16879
16880 If the transport does not specify a home directory, and
16881 &%transport_home_directory%& is not set for the router, the home directory for
16882 the transport is taken from the password data if &%check_local_user%& is set for
16883 the router. Otherwise it is taken from &%router_home_directory%& if that option
16884 is set; if not, no home directory is set for the transport.
16885
16886 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16887 environment.
16888
16889
16890
16891
16892 .option unseen routers boolean&!! false
16893 .cindex "router" "carrying on after success"
16894 The result of string expansion for this option must be a valid boolean value,
16895 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16896 result causes an error, and delivery is deferred. If the expansion is forced to
16897 fail, the default value for the option (false) is used. Other failures cause
16898 delivery to be deferred.
16899
16900 When this option is set true, routing does not cease if the router accepts the
16901 address. Instead, a copy of the incoming address is passed to the next router,
16902 overriding a false setting of &%more%&. There is little point in setting
16903 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16904 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16905 sometimes true and sometimes false).
16906
16907 .cindex "copy of message (&%unseen%& option)"
16908 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16909 qualifier in filter files. It can be used to cause copies of messages to be
16910 delivered to some other destination, while also carrying out a normal delivery.
16911 In effect, the current address is made into a &"parent"& that has two children
16912 &-- one that is delivered as specified by this router, and a clone that goes on
16913 to be routed further. For this reason, &%unseen%& may not be combined with the
16914 &%one_time%& option in a &(redirect)& router.
16915
16916 &*Warning*&: Header lines added to the address (or specified for removal) by
16917 this router or by previous routers affect the &"unseen"& copy of the message
16918 only. The clone that continues to be processed by further routers starts with
16919 no added headers and none specified for removal. For a &%redirect%& router, if
16920 a generated address is the same as the incoming address, this can lead to
16921 duplicate addresses with different header modifications. Exim does not do
16922 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16923 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16924 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16925 &%redirect%& router may be of help.
16926
16927 Unlike the handling of header modifications, any data that was set by the
16928 &%address_data%& option in the current or previous routers &'is'& passed on to
16929 subsequent routers.
16930
16931
16932 .option user routers string&!! "see below"
16933 .cindex "uid (user id)" "local delivery"
16934 .cindex "local transports" "uid and gid"
16935 .cindex "transport" "local"
16936 .cindex "router" "user for filter processing"
16937 .cindex "filter" "user for processing"
16938 When a router queues an address for a transport, and the transport does not
16939 specify a user, the user given here is used when running the delivery process.
16940 The user may be specified numerically or by name. If expansion fails, the
16941 error is logged and delivery is deferred.
16942 This user is also used by the &(redirect)& router when running a filter file.
16943 The default is unset, except when &%check_local_user%& is set. In this case,
16944 the default is taken from the password information. If the user is specified as
16945 a name, and &%group%& is not set, the group associated with the user is used.
16946 See also &%initgroups%& and &%group%& and the discussion in chapter
16947 &<<CHAPenvironment>>&.
16948
16949
16950
16951 .option verify routers&!? boolean true
16952 Setting this option has the effect of setting &%verify_sender%& and
16953 &%verify_recipient%& to the same value.
16954
16955
16956 .option verify_only routers&!? boolean false
16957 .cindex "EXPN" "with &%verify_only%&"
16958 .oindex "&%-bv%&"
16959 .cindex "router" "used only when verifying"
16960 If this option is set, the router is used only when verifying an address or
16961 testing with the &%-bv%& option, not when actually doing a delivery, testing
16962 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16963 restricted to verifying only senders or recipients by means of
16964 &%verify_sender%& and &%verify_recipient%&.
16965
16966 &*Warning*&: When the router is being run to verify addresses for an incoming
16967 SMTP message, Exim is not running as root, but under its own uid. If the router
16968 accesses any files, you need to make sure that they are accessible to the Exim
16969 user or group.
16970
16971
16972 .option verify_recipient routers&!? boolean true
16973 If this option is false, the router is skipped when verifying recipient
16974 addresses
16975 or testing recipient verification using &%-bv%&.
16976 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16977 are evaluated.
16978
16979
16980 .option verify_sender routers&!? boolean true
16981 If this option is false, the router is skipped when verifying sender addresses
16982 or testing sender verification using &%-bvs%&.
16983 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16984 are evaluated.
16985 .ecindex IIDgenoprou1
16986 .ecindex IIDgenoprou2
16987
16988
16989
16990
16991
16992
16993 . ////////////////////////////////////////////////////////////////////////////
16994 . ////////////////////////////////////////////////////////////////////////////
16995
16996 .chapter "The accept router" "CHID4"
16997 .cindex "&(accept)& router"
16998 .cindex "routers" "&(accept)&"
16999 The &(accept)& router has no private options of its own. Unless it is being
17000 used purely for verification (see &%verify_only%&) a transport is required to
17001 be defined by the generic &%transport%& option. If the preconditions that are
17002 specified by generic options are met, the router accepts the address and queues
17003 it for the given transport. The most common use of this router is for setting
17004 up deliveries to local mailboxes. For example:
17005 .code
17006 localusers:
17007   driver = accept
17008   domains = mydomain.example
17009   check_local_user
17010   transport = local_delivery
17011 .endd
17012 The &%domains%& condition in this example checks the domain of the address, and
17013 &%check_local_user%& checks that the local part is the login of a local user.
17014 When both preconditions are met, the &(accept)& router runs, and queues the
17015 address for the &(local_delivery)& transport.
17016
17017
17018
17019
17020
17021
17022 . ////////////////////////////////////////////////////////////////////////////
17023 . ////////////////////////////////////////////////////////////////////////////
17024
17025 .chapter "The dnslookup router" "CHAPdnslookup"
17026 .scindex IIDdnsrou1 "&(dnslookup)& router"
17027 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17028 The &(dnslookup)& router looks up the hosts that handle mail for the
17029 recipient's domain in the DNS. A transport must always be set for this router,
17030 unless &%verify_only%& is set.
17031
17032 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17033 SRV records. If none are found, or if SRV support is not configured,
17034 MX records are looked up. If no MX records exist, address records are sought.
17035 However, &%mx_domains%& can be set to disable the direct use of address
17036 records.
17037
17038 MX records of equal priority are sorted by Exim into a random order. Exim then
17039 looks for address records for the host names obtained from MX or SRV records.
17040 When a host has more than one IP address, they are sorted into a random order,
17041 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17042 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17043 generic option, the router declines.
17044
17045 Unless they have the highest priority (lowest MX value), MX records that point
17046 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17047 are discarded, together with any other MX records of equal or lower priority.
17048
17049 .cindex "MX record" "pointing to local host"
17050 .cindex "local host" "MX pointing to"
17051 .oindex "&%self%&" "in &(dnslookup)& router"
17052 If the host pointed to by the highest priority MX record, or looked up as an
17053 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17054 happens is controlled by the generic &%self%& option.
17055
17056
17057 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17058 There have been problems with DNS servers when SRV records are looked up.
17059 Some mis-behaving servers return a DNS error or timeout when a non-existent
17060 SRV record is sought. Similar problems have in the past been reported for
17061 MX records. The global &%dns_again_means_nonexist%& option can help with this
17062 problem, but it is heavy-handed because it is a global option.
17063
17064 For this reason, there are two options, &%srv_fail_domains%& and
17065 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17066 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17067 an attempt to look up an SRV or MX record causes one of these results, and the
17068 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17069 such record"&. In the case of an SRV lookup, this means that the router
17070 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17071 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17072 case routing fails.
17073
17074
17075
17076
17077 .section "Private options for dnslookup" "SECID118"
17078 .cindex "options" "&(dnslookup)& router"
17079 The private options for the &(dnslookup)& router are as follows:
17080
17081 .option check_secondary_mx dnslookup boolean false
17082 .cindex "MX record" "checking for secondary"
17083 If this option is set, the router declines unless the local host is found in
17084 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17085 process domains for which the local host is a secondary mail exchanger
17086 differently to other domains. The way in which Exim decides whether a host is
17087 the local host is described in section &<<SECTreclocipadd>>&.
17088
17089
17090 .option check_srv dnslookup string&!! unset
17091 .cindex "SRV record" "enabling use of"
17092 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17093 addition to MX and address records. The support is disabled by default. To
17094 enable SRV support, set the &%check_srv%& option to the name of the service
17095 required. For example,
17096 .code
17097 check_srv = smtp
17098 .endd
17099 looks for SRV records that refer to the normal smtp service. The option is
17100 expanded, so the service name can vary from message to message or address
17101 to address. This might be helpful if SRV records are being used for a
17102 submission service. If the expansion is forced to fail, the &%check_srv%&
17103 option is ignored, and the router proceeds to look for MX records in the
17104 normal way.
17105
17106 When the expansion succeeds, the router searches first for SRV records for
17107 the given service (it assumes TCP protocol). A single SRV record with a
17108 host name that consists of just a single dot indicates &"no such service for
17109 this domain"&; if this is encountered, the router declines. If other kinds of
17110 SRV record are found, they are used to construct a host list for delivery
17111 according to the rules of RFC 2782. MX records are not sought in this case.
17112
17113 When no SRV records are found, MX records (and address records) are sought in
17114 the traditional way. In other words, SRV records take precedence over MX
17115 records, just as MX records take precedence over address records. Note that
17116 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17117 defined it. It is apparently believed that MX records are sufficient for email
17118 and that SRV records should not be used for this purpose. However, SRV records
17119 have an additional &"weight"& feature which some people might find useful when
17120 trying to split an SMTP load between hosts of different power.
17121
17122 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17123 when there is a DNS lookup error.
17124
17125
17126
17127 .option mx_domains dnslookup "domain list&!!" unset
17128 .cindex "MX record" "required to exist"
17129 .cindex "SRV record" "required to exist"
17130 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17131 record in order to be recognized. (The name of this option could be improved.)
17132 For example, if all the mail hosts in &'fict.example'& are known to have MX
17133 records, except for those in &'discworld.fict.example'&, you could use this
17134 setting:
17135 .code
17136 mx_domains = ! *.discworld.fict.example : *.fict.example
17137 .endd
17138 This specifies that messages addressed to a domain that matches the list but
17139 has no MX record should be bounced immediately instead of being routed using
17140 the address record.
17141
17142
17143 .option mx_fail_domains dnslookup "domain list&!!" unset
17144 If the DNS lookup for MX records for one of the domains in this list causes a
17145 DNS lookup error, Exim behaves as if no MX records were found. See section
17146 &<<SECTprowitdnsloo>>& for more discussion.
17147
17148
17149
17150
17151 .option qualify_single dnslookup boolean true
17152 .cindex "DNS" "resolver options"
17153 .cindex "DNS" "qualifying single-component names"
17154 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17155 lookups. Typically, but not standardly, this causes the resolver to qualify
17156 single-component names with the default domain. For example, on a machine
17157 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17158 &'thesaurus.ref.example'& inside the resolver. For details of what your
17159 resolver actually does, consult your man pages for &'resolver'& and
17160 &'resolv.conf'&.
17161
17162
17163
17164 .option rewrite_headers dnslookup boolean true
17165 .cindex "rewriting" "header lines"
17166 .cindex "header lines" "rewriting"
17167 If the domain name in the address that is being processed is not fully
17168 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17169 an address is specified as &'dormouse@teaparty'&, the domain might be
17170 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17171 occur as a result of setting the &%widen_domains%& option. If
17172 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17173 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17174 header lines of the message are rewritten with the full domain name.
17175
17176 This option should be turned off only when it is known that no message is
17177 ever going to be sent outside an environment where the abbreviation makes
17178 sense.
17179
17180 When an MX record is looked up in the DNS and matches a wildcard record, name
17181 servers normally return a record containing the name that has been looked up,
17182 making it impossible to detect whether a wildcard was present or not. However,
17183 some name servers have recently been seen to return the wildcard entry. If the
17184 name returned by a DNS lookup begins with an asterisk, it is not used for
17185 header rewriting.
17186
17187
17188 .option same_domain_copy_routing dnslookup boolean false
17189 .cindex "address" "copying routing"
17190 Addresses with the same domain are normally routed by the &(dnslookup)& router
17191 to the same list of hosts. However, this cannot be presumed, because the router
17192 options and preconditions may refer to the local part of the address. By
17193 default, therefore, Exim routes each address in a message independently. DNS
17194 servers run caches, so repeated DNS lookups are not normally expensive, and in
17195 any case, personal messages rarely have more than a few recipients.
17196
17197 If you are running mailing lists with large numbers of subscribers at the same
17198 domain, and you are using a &(dnslookup)& router which is independent of the
17199 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17200 lookups for identical domains in one message. In this case, when &(dnslookup)&
17201 routes an address to a remote transport, any other unrouted addresses in the
17202 message that have the same domain are automatically given the same routing
17203 without processing them independently,
17204 provided the following conditions are met:
17205
17206 .ilist
17207 No router that processed the address specified &%headers_add%& or
17208 &%headers_remove%&.
17209 .next
17210 The router did not change the address in any way, for example, by &"widening"&
17211 the domain.
17212 .endlist
17213
17214
17215
17216
17217 .option search_parents dnslookup boolean false
17218 .cindex "DNS" "resolver options"
17219 When this option is true, the resolver option RES_DNSRCH is set for DNS
17220 lookups. This is different from the &%qualify_single%& option in that it
17221 applies to domains containing dots. Typically, but not standardly, it causes
17222 the resolver to search for the name in the current domain and in parent
17223 domains. For example, on a machine in the &'fict.example'& domain, if looking
17224 up &'teaparty.wonderland'& failed, the resolver would try
17225 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17226 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17227
17228 Setting this option true can cause problems in domains that have a wildcard MX
17229 record, because any domain that does not have its own MX record matches the
17230 local wildcard.
17231
17232
17233
17234 .option srv_fail_domains dnslookup "domain list&!!" unset
17235 If the DNS lookup for SRV records for one of the domains in this list causes a
17236 DNS lookup error, Exim behaves as if no SRV records were found. See section
17237 &<<SECTprowitdnsloo>>& for more discussion.
17238
17239
17240
17241
17242 .option widen_domains dnslookup "string list" unset
17243 .cindex "domain" "partial; widening"
17244 If a DNS lookup fails and this option is set, each of its strings in turn is
17245 added onto the end of the domain, and the lookup is tried again. For example,
17246 if
17247 .code
17248 widen_domains = fict.example:ref.example
17249 .endd
17250 is set and a lookup of &'klingon.dictionary'& fails,
17251 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17252 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17253 and &%search_parents%& options can cause some widening to be undertaken inside
17254 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17255 when verifying, unless &%rewrite_headers%& is false (not the default).
17256
17257
17258 .section "Effect of qualify_single and search_parents" "SECID119"
17259 When a domain from an envelope recipient is changed by the resolver as a result
17260 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17261 corresponding address in the message's header lines unless &%rewrite_headers%&
17262 is set false. Exim then re-routes the address, using the full domain.
17263
17264 These two options affect only the DNS lookup that takes place inside the router
17265 for the domain of the address that is being routed. They do not affect lookups
17266 such as that implied by
17267 .code
17268 domains = @mx_any
17269 .endd
17270 that may happen while processing a router precondition before the router is
17271 entered. No widening ever takes place for these lookups.
17272 .ecindex IIDdnsrou1
17273 .ecindex IIDdnsrou2
17274
17275
17276
17277
17278
17279
17280
17281
17282
17283 . ////////////////////////////////////////////////////////////////////////////
17284 . ////////////////////////////////////////////////////////////////////////////
17285
17286 .chapter "The ipliteral router" "CHID5"
17287 .cindex "&(ipliteral)& router"
17288 .cindex "domain literal" "routing"
17289 .cindex "routers" "&(ipliteral)&"
17290 This router has no private options. Unless it is being used purely for
17291 verification (see &%verify_only%&) a transport is required to be defined by the
17292 generic &%transport%& option. The router accepts the address if its domain part
17293 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17294 router handles the address
17295 .code
17296 root@[192.168.1.1]
17297 .endd
17298 by setting up delivery to the host with that IP address. IPv4 domain literals
17299 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17300 are similar, but the address is preceded by &`ipv6:`&. For example:
17301 .code
17302 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17303 .endd
17304 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17305 grounds that sooner or later somebody will try it.
17306
17307 .oindex "&%self%&" "in &(ipliteral)& router"
17308 If the IP address matches something in &%ignore_target_hosts%&, the router
17309 declines. If an IP literal turns out to refer to the local host, the generic
17310 &%self%& option determines what happens.
17311
17312 The RFCs require support for domain literals; however, their use is
17313 controversial in today's Internet. If you want to use this router, you must
17314 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17315 Exim will not recognize the domain literal syntax in addresses.
17316
17317
17318
17319 . ////////////////////////////////////////////////////////////////////////////
17320 . ////////////////////////////////////////////////////////////////////////////
17321
17322 .chapter "The iplookup router" "CHID6"
17323 .cindex "&(iplookup)& router"
17324 .cindex "routers" "&(iplookup)&"
17325 The &(iplookup)& router was written to fulfil a specific requirement in
17326 Cambridge University (which in fact no longer exists). For this reason, it is
17327 not included in the binary of Exim by default. If you want to include it, you
17328 must set
17329 .code
17330 ROUTER_IPLOOKUP=yes
17331 .endd
17332 in your &_Local/Makefile_& configuration file.
17333
17334 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17335 connection to one or more specific hosts. The host can then return the same or
17336 a different address &-- in effect rewriting the recipient address in the
17337 message's envelope. The new address is then passed on to subsequent routers. If
17338 this process fails, the address can be passed on to other routers, or delivery
17339 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17340 must not be specified for it.
17341
17342 .cindex "options" "&(iplookup)& router"
17343 .option hosts iplookup string unset
17344 This option must be supplied. Its value is a colon-separated list of host
17345 names. The hosts are looked up using &[gethostbyname()]&
17346 (or &[getipnodebyname()]& when available)
17347 and are tried in order until one responds to the query. If none respond, what
17348 happens is controlled by &%optional%&.
17349
17350
17351 .option optional iplookup boolean false
17352 If &%optional%& is true, if no response is obtained from any host, the address
17353 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17354 delivery to the address is deferred.
17355
17356
17357 .option port iplookup integer 0
17358 .cindex "port" "&(iplookup)& router"
17359 This option must be supplied. It specifies the port number for the TCP or UDP
17360 call.
17361
17362
17363 .option protocol iplookup string udp
17364 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17365 protocols is to be used.
17366
17367
17368 .option query iplookup string&!! "see below"
17369 This defines the content of the query that is sent to the remote hosts. The
17370 default value is:
17371 .code
17372 $local_part@$domain $local_part@$domain
17373 .endd
17374 The repetition serves as a way of checking that a response is to the correct
17375 query in the default case (see &%response_pattern%& below).
17376
17377
17378 .option reroute iplookup string&!! unset
17379 If this option is not set, the rerouted address is precisely the byte string
17380 returned by the remote host, up to the first white space, if any. If set, the
17381 string is expanded to form the rerouted address. It can include parts matched
17382 in the response by &%response_pattern%& by means of numeric variables such as
17383 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17384 whether or not a pattern is in use. In all cases, the rerouted address must end
17385 up in the form &'local_part@domain'&.
17386
17387
17388 .option response_pattern iplookup string unset
17389 This option can be set to a regular expression that is applied to the string
17390 returned from the remote host. If the pattern does not match the response, the
17391 router declines. If &%response_pattern%& is not set, no checking of the
17392 response is done, unless the query was defaulted, in which case there is a
17393 check that the text returned after the first white space is the original
17394 address. This checks that the answer that has been received is in response to
17395 the correct question. For example, if the response is just a new domain, the
17396 following could be used:
17397 .code
17398 response_pattern = ^([^@]+)$
17399 reroute = $local_part@$1
17400 .endd
17401
17402 .option timeout iplookup time 5s
17403 This specifies the amount of time to wait for a response from the remote
17404 machine. The same timeout is used for the &[connect()]& function for a TCP
17405 call. It does not apply to UDP.
17406
17407
17408
17409
17410 . ////////////////////////////////////////////////////////////////////////////
17411 . ////////////////////////////////////////////////////////////////////////////
17412
17413 .chapter "The manualroute router" "CHID7"
17414 .scindex IIDmanrou1 "&(manualroute)& router"
17415 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17416 .cindex "domain" "manually routing"
17417 The &(manualroute)& router is so-called because it provides a way of manually
17418 routing an address according to its domain. It is mainly used when you want to
17419 route addresses to remote hosts according to your own rules, bypassing the
17420 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17421 route to local transports, a facility that may be useful if you want to save
17422 messages for dial-in hosts in local files.
17423
17424 The &(manualroute)& router compares a list of domain patterns with the domain
17425 it is trying to route. If there is no match, the router declines. Each pattern
17426 has associated with it a list of hosts and some other optional data, which may
17427 include a transport. The combination of a pattern and its data is called a
17428 &"routing rule"&. For patterns that do not have an associated transport, the
17429 generic &%transport%& option must specify a transport, unless the router is
17430 being used purely for verification (see &%verify_only%&).
17431
17432 .vindex "&$host$&"
17433 In the case of verification, matching the domain pattern is sufficient for the
17434 router to accept the address. When actually routing an address for delivery,
17435 an address that matches a domain pattern is queued for the associated
17436 transport. If the transport is not a local one, a host list must be associated
17437 with the pattern; IP addresses are looked up for the hosts, and these are
17438 passed to the transport along with the mail address. For local transports, a
17439 host list is optional. If it is present, it is passed in &$host$& as a single
17440 text string.
17441
17442 The list of routing rules can be provided as an inline string in
17443 &%route_list%&, or the data can be obtained by looking up the domain in a file
17444 or database by setting &%route_data%&. Only one of these settings may appear in
17445 any one instance of &(manualroute)&. The format of routing rules is described
17446 below, following the list of private options.
17447
17448
17449 .section "Private options for manualroute" "SECTprioptman"
17450
17451 .cindex "options" "&(manualroute)& router"
17452 The private options for the &(manualroute)& router are as follows:
17453
17454 .option host_all_ignored manualroute string defer
17455 See &%host_find_failed%&.
17456
17457 .option host_find_failed manualroute string freeze
17458 This option controls what happens when &(manualroute)& tries to find an IP
17459 address for a host, and the host does not exist. The option can be set to one
17460 of the following values:
17461 .code
17462 decline
17463 defer
17464 fail
17465 freeze
17466 ignore
17467 pass
17468 .endd
17469 The default (&"freeze"&) assumes that this state is a serious configuration
17470 error. The difference between &"pass"& and &"decline"& is that the former
17471 forces the address to be passed to the next router (or the router defined by
17472 &%pass_router%&),
17473 .oindex "&%more%&"
17474 overriding &%no_more%&, whereas the latter passes the address to the next
17475 router only if &%more%& is true.
17476
17477 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17478 cannot be found. If all the hosts in the list are ignored, the behaviour is
17479 controlled by the &%host_all_ignored%& option. This takes the same values
17480 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17481
17482 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17483 state; if a host lookup gets a temporary error, delivery is deferred unless the
17484 generic &%pass_on_timeout%& option is set.
17485
17486
17487 .option hosts_randomize manualroute boolean false
17488 .cindex "randomized host list"
17489 .cindex "host" "list of; randomized"
17490 If this option is set, the order of the items in a host list in a routing rule
17491 is randomized each time the list is used, unless an option in the routing rule
17492 overrides (see below). Randomizing the order of a host list can be used to do
17493 crude load sharing. However, if more than one mail address is routed by the
17494 same router to the same host list, the host lists are considered to be the same
17495 (even though they may be randomized into different orders) for the purpose of
17496 deciding whether to batch the deliveries into a single SMTP transaction.
17497
17498 When &%hosts_randomize%& is true, a host list may be split
17499 into groups whose order is separately randomized. This makes it possible to
17500 set up MX-like behaviour. The boundaries between groups are indicated by an
17501 item that is just &`+`& in the host list. For example:
17502 .code
17503 route_list = * host1:host2:host3:+:host4:host5
17504 .endd
17505 The order of the first three hosts and the order of the last two hosts is
17506 randomized for each use, but the first three always end up before the last two.
17507 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17508 randomized host list is passed to an &(smtp)& transport that also has
17509 &%hosts_randomize set%&, the list is not re-randomized.
17510
17511
17512 .option route_data manualroute string&!! unset
17513 If this option is set, it must expand to yield the data part of a routing rule.
17514 Typically, the expansion string includes a lookup based on the domain. For
17515 example:
17516 .code
17517 route_data = ${lookup{$domain}dbm{/etc/routes}}
17518 .endd
17519 If the expansion is forced to fail, or the result is an empty string, the
17520 router declines. Other kinds of expansion failure cause delivery to be
17521 deferred.
17522
17523
17524 .option route_list manualroute "string list" unset
17525 This string is a list of routing rules, in the form defined below. Note that,
17526 unlike most string lists, the items are separated by semicolons. This is so
17527 that they may contain colon-separated host lists.
17528
17529
17530 .option same_domain_copy_routing manualroute boolean false
17531 .cindex "address" "copying routing"
17532 Addresses with the same domain are normally routed by the &(manualroute)&
17533 router to the same list of hosts. However, this cannot be presumed, because the
17534 router options and preconditions may refer to the local part of the address. By
17535 default, therefore, Exim routes each address in a message independently. DNS
17536 servers run caches, so repeated DNS lookups are not normally expensive, and in
17537 any case, personal messages rarely have more than a few recipients.
17538
17539 If you are running mailing lists with large numbers of subscribers at the same
17540 domain, and you are using a &(manualroute)& router which is independent of the
17541 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17542 lookups for identical domains in one message. In this case, when
17543 &(manualroute)& routes an address to a remote transport, any other unrouted
17544 addresses in the message that have the same domain are automatically given the
17545 same routing without processing them independently. However, this is only done
17546 if &%headers_add%& and &%headers_remove%& are unset.
17547
17548
17549
17550
17551 .section "Routing rules in route_list" "SECID120"
17552 The value of &%route_list%& is a string consisting of a sequence of routing
17553 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17554 entered as two semicolons. Alternatively, the list separator can be changed as
17555 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17556 Empty rules are ignored. The format of each rule is
17557 .display
17558 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17559 .endd
17560 The following example contains two rules, each with a simple domain pattern and
17561 no options:
17562 .code
17563 route_list = \
17564   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17565   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17566 .endd
17567 The three parts of a rule are separated by white space. The pattern and the
17568 list of hosts can be enclosed in quotes if necessary, and if they are, the
17569 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17570 single domain pattern, which is the only mandatory item in the rule. The
17571 pattern is in the same format as one item in a domain list (see section
17572 &<<SECTdomainlist>>&),
17573 except that it may not be the name of an interpolated file.
17574 That is, it may be wildcarded, or a regular expression, or a file or database
17575 lookup (with semicolons doubled, because of the use of semicolon as a separator
17576 in a &%route_list%&).
17577
17578 The rules in &%route_list%& are searched in order until one of the patterns
17579 matches the domain that is being routed. The list of hosts and then options are
17580 then used as described below. If there is no match, the router declines. When
17581 &%route_list%& is set, &%route_data%& must not be set.
17582
17583
17584
17585 .section "Routing rules in route_data" "SECID121"
17586 The use of &%route_list%& is convenient when there are only a small number of
17587 routing rules. For larger numbers, it is easier to use a file or database to
17588 hold the routing information, and use the &%route_data%& option instead.
17589 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17590 Most commonly, &%route_data%& is set as a string that contains an
17591 expansion lookup. For example, suppose we place two routing rules in a file
17592 like this:
17593 .code
17594 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17595 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17596 .endd
17597 This data can be accessed by setting
17598 .code
17599 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17600 .endd
17601 Failure of the lookup results in an empty string, causing the router to
17602 decline. However, you do not have to use a lookup in &%route_data%&. The only
17603 requirement is that the result of expanding the string is a list of hosts,
17604 possibly followed by options, separated by white space. The list of hosts must
17605 be enclosed in quotes if it contains white space.
17606
17607
17608
17609
17610 .section "Format of the list of hosts" "SECID122"
17611 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17612 always separately expanded before use. If the expansion fails, the router
17613 declines. The result of the expansion must be a colon-separated list of names
17614 and/or IP addresses, optionally also including ports. The format of each item
17615 in the list is described in the next section. The list separator can be changed
17616 as described in section &<<SECTlistconstruct>>&.
17617
17618 If the list of hosts was obtained from a &%route_list%& item, the following
17619 variables are set during its expansion:
17620
17621 .ilist
17622 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17623 If the domain was matched against a regular expression, the numeric variables
17624 &$1$&, &$2$&, etc. may be set. For example:
17625 .code
17626 route_list = ^domain(\d+)   host-$1.text.example
17627 .endd
17628 .next
17629 &$0$& is always set to the entire domain.
17630 .next
17631 &$1$& is also set when partial matching is done in a file lookup.
17632
17633 .next
17634 .vindex "&$value$&"
17635 If the pattern that matched the domain was a lookup item, the data that was
17636 looked up is available in the expansion variable &$value$&. For example:
17637 .code
17638 route_list = lsearch;;/some/file.routes  $value
17639 .endd
17640 .endlist
17641
17642 Note the doubling of the semicolon in the pattern that is necessary because
17643 semicolon is the default route list separator.
17644
17645
17646
17647 .section "Format of one host item" "SECTformatonehostitem"
17648 Each item in the list of hosts is either a host name or an IP address,
17649 optionally with an attached port number. When no port is given, an IP address
17650 is not enclosed in brackets. When a port is specified, it overrides the port
17651 specification on the transport. The port is separated from the name or address
17652 by a colon. This leads to some complications:
17653
17654 .ilist
17655 Because colon is the default separator for the list of hosts, either
17656 the colon that specifies a port must be doubled, or the list separator must
17657 be changed. The following two examples have the same effect:
17658 .code
17659 route_list = * "host1.tld::1225 : host2.tld::1226"
17660 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17661 .endd
17662 .next
17663 When IPv6 addresses are involved, it gets worse, because they contain
17664 colons of their own. To make this case easier, it is permitted to
17665 enclose an IP address (either v4 or v6) in square brackets if a port
17666 number follows. For example:
17667 .code
17668 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17669 .endd
17670 .endlist
17671
17672 .section "How the list of hosts is used" "SECThostshowused"
17673 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17674 the hosts is tried, in the order specified, when carrying out the SMTP
17675 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17676 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17677 transport.
17678
17679 Hosts may be listed by name or by IP address. An unadorned name in the list of
17680 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17681 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17682 records in the DNS. For example:
17683 .code
17684 route_list = *  x.y.z:p.q.r/MX:e.f.g
17685 .endd
17686 If this feature is used with a port specifier, the port must come last. For
17687 example:
17688 .code
17689 route_list = *  dom1.tld/mx::1225
17690 .endd
17691 If the &%hosts_randomize%& option is set, the order of the items in the list is
17692 randomized before any lookups are done. Exim then scans the list; for any name
17693 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17694 be an interface on the local host and the item is not the first in the list,
17695 Exim discards it and any subsequent items. If it is the first item, what
17696 happens is controlled by the
17697 .oindex "&%self%&" "in &(manualroute)& router"
17698 &%self%& option of the router.
17699
17700 A name on the list that is followed by &`/MX`& is replaced with the list of
17701 hosts obtained by looking up MX records for the name. This is always a DNS
17702 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17703 below) are not relevant here. The order of these hosts is determined by the
17704 preference values in the MX records, according to the usual rules. Because
17705 randomizing happens before the MX lookup, it does not affect the order that is
17706 defined by MX preferences.
17707
17708 If the local host is present in the sublist obtained from MX records, but is
17709 not the most preferred host in that list, it and any equally or less
17710 preferred hosts are removed before the sublist is inserted into the main list.
17711
17712 If the local host is the most preferred host in the MX list, what happens
17713 depends on where in the original list of hosts the &`/MX`& item appears. If it
17714 is not the first item (that is, there are previous hosts in the main list),
17715 Exim discards this name and any subsequent items in the main list.
17716
17717 If the MX item is first in the list of hosts, and the local host is the
17718 most preferred host, what happens is controlled by the &%self%& option of the
17719 router.
17720
17721 DNS failures when lookup up the MX records are treated in the same way as DNS
17722 failures when looking up IP addresses: &%pass_on_timeout%& and
17723 &%host_find_failed%& are used when relevant.
17724
17725 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17726 whether obtained from an MX lookup or not.
17727
17728
17729
17730 .section "How the options are used" "SECThowoptused"
17731 The options are a sequence of words; in practice no more than three are ever
17732 present. One of the words can be the name of a transport; this overrides the
17733 &%transport%& option on the router for this particular routing rule only. The
17734 other words (if present) control randomization of the list of hosts on a
17735 per-rule basis, and how the IP addresses of the hosts are to be found when
17736 routing to a remote transport. These options are as follows:
17737
17738 .ilist
17739 &%randomize%&: randomize the order of the hosts in this list, overriding the
17740 setting of &%hosts_randomize%& for this routing rule only.
17741 .next
17742 &%no_randomize%&: do not randomize the order of the hosts in this list,
17743 overriding the setting of &%hosts_randomize%& for this routing rule only.
17744 .next
17745 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17746 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17747 also look in &_/etc/hosts_& or other sources of information.
17748 .next
17749 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17750 no address records are found. If there is a temporary DNS error (such as a
17751 timeout), delivery is deferred.
17752 .endlist
17753
17754 For example:
17755 .code
17756 route_list = domain1  host1:host2:host3  randomize bydns;\
17757              domain2  host4:host5
17758 .endd
17759 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17760 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17761 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17762 or &[gethostbyname()]&, and the result of the lookup is the result of that
17763 call.
17764
17765 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17766 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17767 instead of TRY_AGAIN. That is why the default action is to try a DNS
17768 lookup first. Only if that gives a definite &"no such host"& is the local
17769 function called.
17770
17771
17772
17773 If no IP address for a host can be found, what happens is controlled by the
17774 &%host_find_failed%& option.
17775
17776 .vindex "&$host$&"
17777 When an address is routed to a local transport, IP addresses are not looked up.
17778 The host list is passed to the transport in the &$host$& variable.
17779
17780
17781
17782 .section "Manualroute examples" "SECID123"
17783 In some of the examples that follow, the presence of the &%remote_smtp%&
17784 transport, as defined in the default configuration file, is assumed:
17785
17786 .ilist
17787 .cindex "smart host" "example router"
17788 The &(manualroute)& router can be used to forward all external mail to a
17789 &'smart host'&. If you have set up, in the main part of the configuration, a
17790 named domain list that contains your local domains, for example:
17791 .code
17792 domainlist local_domains = my.domain.example
17793 .endd
17794 You can arrange for all other domains to be routed to a smart host by making
17795 your first router something like this:
17796 .code
17797 smart_route:
17798   driver = manualroute
17799   domains = !+local_domains
17800   transport = remote_smtp
17801   route_list = * smarthost.ref.example
17802 .endd
17803 This causes all non-local addresses to be sent to the single host
17804 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17805 they are tried in order
17806 (but you can use &%hosts_randomize%& to vary the order each time).
17807 Another way of configuring the same thing is this:
17808 .code
17809 smart_route:
17810   driver = manualroute
17811   transport = remote_smtp
17812   route_list = !+local_domains  smarthost.ref.example
17813 .endd
17814 There is no difference in behaviour between these two routers as they stand.
17815 However, they behave differently if &%no_more%& is added to them. In the first
17816 example, the router is skipped if the domain does not match the &%domains%&
17817 precondition; the following router is always tried. If the router runs, it
17818 always matches the domain and so can never decline. Therefore, &%no_more%&
17819 would have no effect. In the second case, the router is never skipped; it
17820 always runs. However, if it doesn't match the domain, it declines. In this case
17821 &%no_more%& would prevent subsequent routers from running.
17822
17823 .next
17824 .cindex "mail hub example"
17825 A &'mail hub'& is a host which receives mail for a number of domains via MX
17826 records in the DNS and delivers it via its own private routing mechanism. Often
17827 the final destinations are behind a firewall, with the mail hub being the one
17828 machine that can connect to machines both inside and outside the firewall. The
17829 &(manualroute)& router is usually used on a mail hub to route incoming messages
17830 to the correct hosts. For a small number of domains, the routing can be inline,
17831 using the &%route_list%& option, but for a larger number a file or database
17832 lookup is easier to manage.
17833
17834 If the domain names are in fact the names of the machines to which the mail is
17835 to be sent by the mail hub, the configuration can be quite simple. For
17836 example:
17837 .code
17838 hub_route:
17839   driver = manualroute
17840   transport = remote_smtp
17841   route_list = *.rhodes.tvs.example  $domain
17842 .endd
17843 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17844 whose names are the same as the mail domains. A similar approach can be taken
17845 if the host name can be obtained from the domain name by a string manipulation
17846 that the expansion facilities can handle. Otherwise, a lookup based on the
17847 domain can be used to find the host:
17848 .code
17849 through_firewall:
17850   driver = manualroute
17851   transport = remote_smtp
17852   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17853 .endd
17854 The result of the lookup must be the name or IP address of the host (or
17855 hosts) to which the address is to be routed. If the lookup fails, the route
17856 data is empty, causing the router to decline. The address then passes to the
17857 next router.
17858
17859 .next
17860 .cindex "batched SMTP output example"
17861 .cindex "SMTP" "batched outgoing; example"
17862 You can use &(manualroute)& to deliver messages to pipes or files in batched
17863 SMTP format for onward transportation by some other means. This is one way of
17864 storing mail for a dial-up host when it is not connected. The route list entry
17865 can be as simple as a single domain name in a configuration like this:
17866 .code
17867 save_in_file:
17868   driver = manualroute
17869   transport = batchsmtp_appendfile
17870   route_list = saved.domain.example
17871 .endd
17872 though often a pattern is used to pick up more than one domain. If there are
17873 several domains or groups of domains with different transport requirements,
17874 different transports can be listed in the routing information:
17875 .code
17876 save_in_file:
17877   driver = manualroute
17878   route_list = \
17879     *.saved.domain1.example  $domain  batch_appendfile; \
17880     *.saved.domain2.example  \
17881       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17882       batch_pipe
17883 .endd
17884 .vindex "&$domain$&"
17885 .vindex "&$host$&"
17886 The first of these just passes the domain in the &$host$& variable, which
17887 doesn't achieve much (since it is also in &$domain$&), but the second does a
17888 file lookup to find a value to pass, causing the router to decline to handle
17889 the address if the lookup fails.
17890
17891 .next
17892 .cindex "UUCP" "example of router for"
17893 Routing mail directly to UUCP software is a specific case of the use of
17894 &(manualroute)& in a gateway to another mail environment. This is an example of
17895 one way it can be done:
17896 .code
17897 # Transport
17898 uucp:
17899   driver = pipe
17900   user = nobody
17901   command = /usr/local/bin/uux -r - \
17902     ${substr_-5:$host}!rmail ${local_part}
17903   return_fail_output = true
17904
17905 # Router
17906 uucphost:
17907   transport = uucp
17908   driver = manualroute
17909   route_data = \
17910     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17911 .endd
17912 The file &_/usr/local/exim/uucphosts_& contains entries like
17913 .code
17914 darksite.ethereal.example:           darksite.UUCP
17915 .endd
17916 It can be set up more simply without adding and removing &".UUCP"& but this way
17917 makes clear the distinction between the domain name
17918 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17919 .endlist
17920 .ecindex IIDmanrou1
17921 .ecindex IIDmanrou2
17922
17923
17924
17925
17926
17927
17928
17929
17930 . ////////////////////////////////////////////////////////////////////////////
17931 . ////////////////////////////////////////////////////////////////////////////
17932
17933 .chapter "The queryprogram router" "CHAPdriverlast"
17934 .scindex IIDquerou1 "&(queryprogram)& router"
17935 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17936 .cindex "routing" "by external program"
17937 The &(queryprogram)& router routes an address by running an external command
17938 and acting on its output. This is an expensive way to route, and is intended
17939 mainly for use in lightly-loaded systems, or for performing experiments.
17940 However, if it is possible to use the precondition options (&%domains%&,
17941 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17942 be used in special cases, even on a busy host. There are the following private
17943 options:
17944 .cindex "options" "&(queryprogram)& router"
17945
17946 .option command queryprogram string&!! unset
17947 This option must be set. It specifies the command that is to be run. The
17948 command is split up into a command name and arguments, and then each is
17949 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17950 &<<CHAPpipetransport>>&).
17951
17952
17953 .option command_group queryprogram string unset
17954 .cindex "gid (group id)" "in &(queryprogram)& router"
17955 This option specifies a gid to be set when running the command while routing an
17956 address for deliver. It must be set if &%command_user%& specifies a numerical
17957 uid. If it begins with a digit, it is interpreted as the numerical value of the
17958 gid. Otherwise it is looked up using &[getgrnam()]&.
17959
17960
17961 .option command_user queryprogram string unset
17962 .cindex "uid (user id)" "for &(queryprogram)&"
17963 This option must be set. It specifies the uid which is set when running the
17964 command while routing an address for delivery. If the value begins with a digit,
17965 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
17966 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
17967 not set, a value for the gid also.
17968
17969 &*Warning:*& Changing uid and gid is possible only when Exim is running as
17970 root, which it does during a normal delivery in a conventional configuration.
17971 However, when an address is being verified during message reception, Exim is
17972 usually running as the Exim user, not as root. If the &(queryprogram)& router
17973 is called from a non-root process, Exim cannot change uid or gid before running
17974 the command. In this circumstance the command runs under the current uid and
17975 gid.
17976
17977
17978 .option current_directory queryprogram string /
17979 This option specifies an absolute path which is made the current directory
17980 before running the command.
17981
17982
17983 .option timeout queryprogram time 1h
17984 If the command does not complete within the timeout period, its process group
17985 is killed and the message is frozen. A value of zero time specifies no
17986 timeout.
17987
17988
17989 The standard output of the command is connected to a pipe, which is read when
17990 the command terminates. It should consist of a single line of output,
17991 containing up to five fields, separated by white space. The maximum length of
17992 the line is 1023 characters. Longer lines are silently truncated. The first
17993 field is one of the following words (case-insensitive):
17994
17995 .ilist
17996 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
17997 below).
17998 .next
17999 &'Decline'&: the router declines; pass the address to the next router, unless
18000 &%no_more%& is set.
18001 .next
18002 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18003 subsequent text on the line is an error message. If the router is run as part
18004 of address verification during an incoming SMTP message, the message is
18005 included in the SMTP response.
18006 .next
18007 &'Defer'&: routing could not be completed at this time; try again later. Any
18008 subsequent text on the line is an error message which is logged. It is not
18009 included in any SMTP response.
18010 .next
18011 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18012 .next
18013 &'Pass'&: pass the address to the next router (or the router specified by
18014 &%pass_router%&), overriding &%no_more%&.
18015 .next
18016 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18017 new addresses, which are routed independently, starting with the first router,
18018 or the router specified by &%redirect_router%&, if set.
18019 .endlist
18020
18021 When the first word is &'accept'&, the remainder of the line consists of a
18022 number of keyed data values, as follows (split into two lines here, to fit on
18023 the page):
18024 .code
18025 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18026 LOOKUP=byname|bydns DATA=<text>
18027 .endd
18028 The data items can be given in any order, and all are optional. If no transport
18029 is included, the transport specified by the generic &%transport%& option is
18030 used. The list of hosts and the lookup type are needed only if the transport is
18031 an &(smtp)& transport that does not itself supply a list of hosts.
18032
18033 The format of the list of hosts is the same as for the &(manualroute)& router.
18034 As well as host names and IP addresses with optional port numbers, as described
18035 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18036 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18037 (see section &<<SECThostshowused>>&).
18038
18039 If the lookup type is not specified, Exim behaves as follows when trying to
18040 find an IP address for each host: First, a DNS lookup is done. If this yields
18041 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18042 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18043 result of the lookup is the result of that call.
18044
18045 .vindex "&$address_data$&"
18046 If the DATA field is set, its value is placed in the &$address_data$&
18047 variable. For example, this return line
18048 .code
18049 accept hosts=x1.y.example:x2.y.example data="rule1"
18050 .endd
18051 routes the address to the default transport, passing a list of two hosts. When
18052 the transport runs, the string &"rule1"& is in &$address_data$&.
18053 .ecindex IIDquerou1
18054 .ecindex IIDquerou2
18055
18056
18057
18058
18059 . ////////////////////////////////////////////////////////////////////////////
18060 . ////////////////////////////////////////////////////////////////////////////
18061
18062 .chapter "The redirect router" "CHAPredirect"
18063 .scindex IIDredrou1 "&(redirect)& router"
18064 .scindex IIDredrou2 "routers" "&(redirect)&"
18065 .cindex "alias file" "in a &(redirect)& router"
18066 .cindex "address redirection" "&(redirect)& router"
18067 The &(redirect)& router handles several kinds of address redirection. Its most
18068 common uses are for resolving local part aliases from a central alias file
18069 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18070 files, but it has many other potential uses. The incoming address can be
18071 redirected in several different ways:
18072
18073 .ilist
18074 It can be replaced by one or more new addresses which are themselves routed
18075 independently.
18076 .next
18077 It can be routed to be delivered to a given file or directory.
18078 .next
18079 It can be routed to be delivered to a specified pipe command.
18080 .next
18081 It can cause an automatic reply to be generated.
18082 .next
18083 It can be forced to fail, optionally with a custom error message.
18084 .next
18085 It can be temporarily deferred, optionally with a custom message.
18086 .next
18087 It can be discarded.
18088 .endlist
18089
18090 The generic &%transport%& option must not be set for &(redirect)& routers.
18091 However, there are some private options which define transports for delivery to
18092 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18093 &%pipe_transport%& and &%reply_transport%& descriptions below.
18094
18095
18096
18097 .section "Redirection data" "SECID124"
18098 The router operates by interpreting a text string which it obtains either by
18099 expanding the contents of the &%data%& option, or by reading the entire
18100 contents of a file whose name is given in the &%file%& option. These two
18101 options are mutually exclusive. The first is commonly used for handling system
18102 aliases, in a configuration like this:
18103 .code
18104 system_aliases:
18105   driver = redirect
18106   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18107 .endd
18108 If the lookup fails, the expanded string in this example is empty. When the
18109 expansion of &%data%& results in an empty string, the router declines. A forced
18110 expansion failure also causes the router to decline; other expansion failures
18111 cause delivery to be deferred.
18112
18113 A configuration using &%file%& is commonly used for handling users'
18114 &_.forward_& files, like this:
18115 .code
18116 userforward:
18117   driver = redirect
18118   check_local_user
18119   file = $home/.forward
18120   no_verify
18121 .endd
18122 If the file does not exist, or causes no action to be taken (for example, it is
18123 empty or consists only of comments), the router declines. &*Warning*&: This
18124 is not the case when the file contains syntactically valid items that happen to
18125 yield empty addresses, for example, items containing only RFC 2822 address
18126 comments.
18127
18128
18129
18130 .section "Forward files and address verification" "SECID125"
18131 .cindex "address redirection" "while verifying"
18132 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18133 &_.forward_& files, as in the example above. There are two reasons for this:
18134
18135 .ilist
18136 When Exim is receiving an incoming SMTP message from a remote host, it is
18137 running under the Exim uid, not as root. Exim is unable to change uid to read
18138 the file as the user, and it may not be able to read it as the Exim user. So in
18139 practice the router may not be able to operate.
18140 .next
18141 However, even when the router can operate, the existence of a &_.forward_& file
18142 is unimportant when verifying an address. What should be checked is whether the
18143 local part is a valid user name or not. Cutting out the redirection processing
18144 saves some resources.
18145 .endlist
18146
18147
18148
18149
18150
18151
18152 .section "Interpreting redirection data" "SECID126"
18153 .cindex "Sieve filter" "specifying in redirection data"
18154 .cindex "filter" "specifying in redirection data"
18155 The contents of the data string, whether obtained from &%data%& or &%file%&,
18156 can be interpreted in two different ways:
18157
18158 .ilist
18159 If the &%allow_filter%& option is set true, and the data begins with the text
18160 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18161 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18162 respectively. Details of the syntax and semantics of filter files are described
18163 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18164 document is intended for use by end users.
18165 .next
18166 Otherwise, the data must be a comma-separated list of redirection items, as
18167 described in the next section.
18168 .endlist
18169
18170 When a message is redirected to a file (a &"mail folder"&), the file name given
18171 in a non-filter redirection list must always be an absolute path. A filter may
18172 generate a relative path &-- how this is handled depends on the transport's
18173 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18174 for the &(appendfile)& transport.
18175
18176
18177
18178 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18179 .cindex "address redirection" "non-filter list items"
18180 When the redirection data is not an Exim or Sieve filter, for example, if it
18181 comes from a conventional alias or forward file, it consists of a list of
18182 addresses, file names, pipe commands, or certain special items (see section
18183 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18184 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18185 depending on their default values. The items in the list are separated by
18186 commas or newlines.
18187 If a comma is required in an item, the entire item must be enclosed in double
18188 quotes.
18189
18190 Lines starting with a # character are comments, and are ignored, and # may
18191 also appear following a comma, in which case everything between the # and the
18192 next newline character is ignored.
18193
18194 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18195 double quotes are retained because some forms of mail address require their use
18196 (but never to enclose the entire address). In the following description,
18197 &"item"& refers to what remains after any surrounding double quotes have been
18198 removed.
18199
18200 .vindex "&$local_part$&"
18201 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18202 and the expansion contains a reference to &$local_part$&, you should make use
18203 of the &%quote_local_part%& expansion operator, in case the local part contains
18204 special characters. For example, to redirect all mail for the domain
18205 &'obsolete.example'&, retaining the existing local part, you could use this
18206 setting:
18207 .code
18208 data = ${quote_local_part:$local_part}@newdomain.example
18209 .endd
18210
18211
18212 .section "Redirecting to a local mailbox" "SECTredlocmai"
18213 .cindex "routing" "loops in"
18214 .cindex "loop" "while routing, avoidance of"
18215 .cindex "address redirection" "to local mailbox"
18216 A redirection item may safely be the same as the address currently under
18217 consideration. This does not cause a routing loop, because a router is
18218 automatically skipped if any ancestor of the address that is being processed
18219 is the same as the current address and was processed by the current router.
18220 Such an address is therefore passed to the following routers, so it is handled
18221 as if there were no redirection. When making this loop-avoidance test, the
18222 complete local part, including any prefix or suffix, is used.
18223
18224 .cindex "address redirection" "local part without domain"
18225 Specifying the same local part without a domain is a common usage in personal
18226 filter files when the user wants to have messages delivered to the local
18227 mailbox and also forwarded elsewhere. For example, the user whose login is
18228 &'cleo'& might have a &_.forward_& file containing this:
18229 .code
18230 cleo, cleopatra@egypt.example
18231 .endd
18232 .cindex "backslash in alias file"
18233 .cindex "alias file" "backslash in"
18234 For compatibility with other MTAs, such unqualified local parts may be
18235 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18236 it does make a difference if more than one domain is being handled
18237 synonymously.
18238
18239 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18240 2822 address that does not include a domain, the item is qualified using the
18241 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18242 addresses are qualified using the value in &%qualify_recipient%&, but you can
18243 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18244
18245 Care must be taken if there are alias names for local users.
18246 Consider an MTA handling a single local domain where the system alias file
18247 contains:
18248 .code
18249 Sam.Reman: spqr
18250 .endd
18251 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18252 messages in the local mailbox, and also forward copies elsewhere. He creates
18253 this forward file:
18254 .code
18255 Sam.Reman, spqr@reme.elsewhere.example
18256 .endd
18257 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18258 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18259 second time round, because it has previously routed it,
18260 and the following routers presumably cannot handle the alias. The forward file
18261 should really contain
18262 .code
18263 spqr, spqr@reme.elsewhere.example
18264 .endd
18265 but because this is such a common error, the &%check_ancestor%& option (see
18266 below) exists to provide a way to get round it. This is normally set on a
18267 &(redirect)& router that is handling users' &_.forward_& files.
18268
18269
18270
18271 .section "Special items in redirection lists" "SECTspecitredli"
18272 In addition to addresses, the following types of item may appear in redirection
18273 lists (that is, in non-filter redirection data):
18274
18275 .ilist
18276 .cindex "pipe" "in redirection list"
18277 .cindex "address redirection" "to pipe"
18278 An item is treated as a pipe command if it begins with &"|"& and does not parse
18279 as a valid RFC 2822 address that includes a domain. A transport for running the
18280 command must be specified by the &%pipe_transport%& option.
18281 Normally, either the router or the transport specifies a user and a group under
18282 which to run the delivery. The default is to use the Exim user and group.
18283
18284 Single or double quotes can be used for enclosing the individual arguments of
18285 the pipe command; no interpretation of escapes is done for single quotes. If
18286 the command contains a comma character, it is necessary to put the whole item
18287 in double quotes, for example:
18288 .code
18289 "|/some/command ready,steady,go"
18290 .endd
18291 since items in redirection lists are terminated by commas. Do not, however,
18292 quote just the command. An item such as
18293 .code
18294 |"/some/command ready,steady,go"
18295 .endd
18296 is interpreted as a pipe with a rather strange command name, and no arguments.
18297
18298 .next
18299 .cindex "file" "in redirection list"
18300 .cindex "address redirection" "to file"
18301 An item is interpreted as a path name if it begins with &"/"& and does not
18302 parse as a valid RFC 2822 address that includes a domain. For example,
18303 .code
18304 /home/world/minbari
18305 .endd
18306 is treated as a file name, but
18307 .code
18308 /s=molari/o=babylon/@x400gate.way
18309 .endd
18310 is treated as an address. For a file name, a transport must be specified using
18311 the &%file_transport%& option. However, if the generated path name ends with a
18312 forward slash character, it is interpreted as a directory name rather than a
18313 file name, and &%directory_transport%& is used instead.
18314
18315 Normally, either the router or the transport specifies a user and a group under
18316 which to run the delivery. The default is to use the Exim user and group.
18317
18318 .cindex "&_/dev/null_&"
18319 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18320 bypassed at a high level, and the log entry shows &"**bypassed**"&
18321 instead of a transport name. In this case the user and group are not used.
18322
18323 .next
18324 .cindex "included address list"
18325 .cindex "address redirection" "included external list"
18326 If an item is of the form
18327 .code
18328 :include:<path name>
18329 .endd
18330 a list of further items is taken from the given file and included at that
18331 point. &*Note*&: Such a file can not be a filter file; it is just an
18332 out-of-line addition to the list. The items in the included list are separated
18333 by commas or newlines and are not subject to expansion. If this is the first
18334 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18335 the alias name. This example is incorrect:
18336 .code
18337 list1    :include:/opt/lists/list1
18338 .endd
18339 It must be given as
18340 .code
18341 list1:   :include:/opt/lists/list1
18342 .endd
18343 .next
18344 .cindex "address redirection" "to black hole"
18345 Sometimes you want to throw away mail to a particular local part. Making the
18346 &%data%& option expand to an empty string does not work, because that causes
18347 the router to decline. Instead, the alias item
18348 .cindex "black hole"
18349 .cindex "abandoning mail"
18350 &':blackhole:'& can be used. It does what its name implies. No delivery is
18351 done, and no error message is generated. This has the same effect as specifing
18352 &_/dev/null_& as a destination, but it can be independently disabled.
18353
18354 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18355 delivery is done for the original local part, even if other redirection items
18356 are present. If you are generating a multi-item list (for example, by reading a
18357 database) and need the ability to provide a no-op item, you must use
18358 &_/dev/null_&.
18359
18360 .next
18361 .cindex "delivery" "forcing failure"
18362 .cindex "delivery" "forcing deferral"
18363 .cindex "failing delivery" "forcing"
18364 .cindex "deferred delivery, forcing"
18365 .cindex "customizing" "failure message"
18366 An attempt to deliver a particular address can be deferred or forced to fail by
18367 redirection items of the form
18368 .code
18369 :defer:
18370 :fail:
18371 .endd
18372 respectively. When a redirection list contains such an item, it applies
18373 to the entire redirection; any other items in the list are ignored. Any
18374 text following &':fail:'& or &':defer:'& is placed in the error text
18375 associated with the failure. For example, an alias file might contain:
18376 .code
18377 X.Employee:  :fail: Gone away, no forwarding address
18378 .endd
18379 In the case of an address that is being verified from an ACL or as the subject
18380 of a
18381 .cindex "VRFY" "error text, display of"
18382 VRFY command, the text is included in the SMTP error response by
18383 default.
18384 .cindex "EXPN" "error text, display of"
18385 The text is not included in the response to an EXPN command. In non-SMTP cases
18386 the text is included in the error message that Exim generates.
18387
18388 .cindex "SMTP" "error codes"
18389 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18390 &':fail:'&. However, if the message starts with three digits followed by a
18391 space, optionally followed by an extended code of the form &'n.n.n'&, also
18392 followed by a space, and the very first digit is the same as the default error
18393 code, the code from the message is used instead. If the very first digit is
18394 incorrect, a panic error is logged, and the default code is used. You can
18395 suppress the use of the supplied code in a redirect router by setting the
18396 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18397 ignored.
18398
18399 .vindex "&$acl_verify_message$&"
18400 In an ACL, an explicitly provided message overrides the default, but the
18401 default message is available in the variable &$acl_verify_message$& and can
18402 therefore be included in a custom message if this is desired.
18403
18404 Normally the error text is the rest of the redirection list &-- a comma does
18405 not terminate it &-- but a newline does act as a terminator. Newlines are not
18406 normally present in alias expansions. In &(lsearch)& lookups they are removed
18407 as part of the continuation process, but they may exist in other kinds of
18408 lookup and in &':include:'& files.
18409
18410 During routing for message delivery (as opposed to verification), a redirection
18411 containing &':fail:'& causes an immediate failure of the incoming address,
18412 whereas &':defer:'& causes the message to remain on the queue so that a
18413 subsequent delivery attempt can happen at a later time. If an address is
18414 deferred for too long, it will ultimately fail, because the normal retry
18415 rules still apply.
18416
18417 .next
18418 .cindex "alias file" "exception to default"
18419 Sometimes it is useful to use a single-key search type with a default (see
18420 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18421 for exceptions to the default. These can be handled by aliasing them to
18422 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18423 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18424 results in an empty redirection list has the same effect.
18425 .endlist
18426
18427
18428 .section "Duplicate addresses" "SECTdupaddr"
18429 .cindex "duplicate addresses"
18430 .cindex "address duplicate, discarding"
18431 .cindex "pipe" "duplicated"
18432 Exim removes duplicate addresses from the list to which it is delivering, so as
18433 to deliver just one copy to each address. This does not apply to deliveries
18434 routed to pipes by different immediate parent addresses, but an indirect
18435 aliasing scheme of the type
18436 .code
18437 pipe:       |/some/command $local_part
18438 localpart1: pipe
18439 localpart2: pipe
18440 .endd
18441 does not work with a message that is addressed to both local parts, because
18442 when the second is aliased to the intermediate local part &"pipe"& it gets
18443 discarded as being the same as a previously handled address. However, a scheme
18444 such as
18445 .code
18446 localpart1: |/some/command $local_part
18447 localpart2: |/some/command $local_part
18448 .endd
18449 does result in two different pipe deliveries, because the immediate parents of
18450 the pipes are distinct.
18451
18452
18453
18454 .section "Repeated redirection expansion" "SECID128"
18455 .cindex "repeated redirection expansion"
18456 .cindex "address redirection" "repeated for each delivery attempt"
18457 When a message cannot be delivered to all of its recipients immediately,
18458 leading to two or more delivery attempts, redirection expansion is carried out
18459 afresh each time for those addresses whose children were not all previously
18460 delivered. If redirection is being used as a mailing list, this can lead to new
18461 members of the list receiving copies of old messages. The &%one_time%& option
18462 can be used to avoid this.
18463
18464
18465 .section "Errors in redirection lists" "SECID129"
18466 .cindex "address redirection" "errors"
18467 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18468 error is skipped, and an entry is written to the main log. This may be useful
18469 for mailing lists that are automatically managed. Otherwise, if an error is
18470 detected while generating the list of new addresses, the original address is
18471 deferred. See also &%syntax_errors_to%&.
18472
18473
18474
18475 .section "Private options for the redirect router" "SECID130"
18476
18477 .cindex "options" "&(redirect)& router"
18478 The private options for the &(redirect)& router are as follows:
18479
18480
18481 .option allow_defer redirect boolean false
18482 Setting this option allows the use of &':defer:'& in non-filter redirection
18483 data, or the &%defer%& command in an Exim filter file.
18484
18485
18486 .option allow_fail redirect boolean false
18487 .cindex "failing delivery" "from filter"
18488 If this option is true, the &':fail:'& item can be used in a redirection list,
18489 and the &%fail%& command may be used in an Exim filter file.
18490
18491
18492 .option allow_filter redirect boolean false
18493 .cindex "filter" "enabling use of"
18494 .cindex "Sieve filter" "enabling use of"
18495 Setting this option allows Exim to interpret redirection data that starts with
18496 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18497 are some features of Exim filter files that some administrators may wish to
18498 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18499
18500 It is also possible to lock out Exim filters or Sieve filters while allowing
18501 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18502
18503
18504 The filter is run using the uid and gid set by the generic &%user%& and
18505 &%group%& options. These take their defaults from the password data if
18506 &%check_local_user%& is set, so in the normal case of users' personal filter
18507 files, the filter is run as the relevant user. When &%allow_filter%& is set
18508 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18509
18510
18511
18512 .option allow_freeze redirect boolean false
18513 .cindex "freezing messages" "allowing in filter"
18514 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18515 This command is more normally encountered in system filters, and is disabled by
18516 default for redirection filters because it isn't something you usually want to
18517 let ordinary users do.
18518
18519
18520
18521 .option check_ancestor redirect boolean false
18522 This option is concerned with handling generated addresses that are the same
18523 as some address in the list of redirection ancestors of the current address.
18524 Although it is turned off by default in the code, it is set in the default
18525 configuration file for handling users' &_.forward_& files. It is recommended
18526 for this use of the &(redirect)& router.
18527
18528 When &%check_ancestor%& is set, if a generated address (including the domain)
18529 is the same as any ancestor of the current address, it is replaced by a copy of
18530 the current address. This helps in the case where local part A is aliased to B,
18531 and B has a &_.forward_& file pointing back to A. For example, within a single
18532 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18533 &_&~jb/.forward_& contains:
18534 .code
18535 \Joe.Bloggs, <other item(s)>
18536 .endd
18537 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18538 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18539 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18540 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18541 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18542 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18543 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18544 original address. See also the &%repeat_use%& option below.
18545
18546
18547 .option check_group redirect boolean "see below"
18548 When the &%file%& option is used, the group owner of the file is checked only
18549 when this option is set. The permitted groups are those listed in the
18550 &%owngroups%& option, together with the user's default group if
18551 &%check_local_user%& is set. If the file has the wrong group, routing is
18552 deferred. The default setting for this option is true if &%check_local_user%&
18553 is set and the &%modemask%& option permits the group write bit, or if the
18554 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18555
18556
18557
18558 .option check_owner redirect boolean "see below"
18559 When the &%file%& option is used, the owner of the file is checked only when
18560 this option is set. If &%check_local_user%& is set, the local user is
18561 permitted; otherwise the owner must be one of those listed in the &%owners%&
18562 option. The default value for this option is true if &%check_local_user%& or
18563 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18564
18565
18566 .option data redirect string&!! unset
18567 This option is mutually exclusive with &%file%&. One or other of them must be
18568 set, but not both. The contents of &%data%& are expanded, and then used as the
18569 list of forwarding items, or as a set of filtering instructions. If the
18570 expansion is forced to fail, or the result is an empty string or a string that
18571 has no effect (consists entirely of comments), the router declines.
18572
18573 When filtering instructions are used, the string must begin with &"#Exim
18574 filter"&, and all comments in the string, including this initial one, must be
18575 terminated with newline characters. For example:
18576 .code
18577 data = #Exim filter\n\
18578        if $h_to: contains Exim then save $home/mail/exim endif
18579 .endd
18580 If you are reading the data from a database where newlines cannot be included,
18581 you can use the &${sg}$& expansion item to turn the escape string of your
18582 choice into a newline.
18583
18584
18585 .option directory_transport redirect string&!! unset
18586 A &(redirect)& router sets up a direct delivery to a directory when a path name
18587 ending with a slash is specified as a new &"address"&. The transport used is
18588 specified by this option, which, after expansion, must be the name of a
18589 configured transport. This should normally be an &(appendfile)& transport.
18590
18591
18592 .option file redirect string&!! unset
18593 This option specifies the name of a file that contains the redirection data. It
18594 is mutually exclusive with the &%data%& option. The string is expanded before
18595 use; if the expansion is forced to fail, the router declines. Other expansion
18596 failures cause delivery to be deferred. The result of a successful expansion
18597 must be an absolute path. The entire file is read and used as the redirection
18598 data. If the data is an empty string or a string that has no effect (consists
18599 entirely of comments), the router declines.
18600
18601 .cindex "NFS" "checking for file existence"
18602 If the attempt to open the file fails with a &"does not exist"& error, Exim
18603 runs a check on the containing directory,
18604 unless &%ignore_enotdir%& is true (see below).
18605 If the directory does not appear to exist, delivery is deferred. This can
18606 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18607 is a mount problem. If the containing directory does exist, but the file does
18608 not, the router declines.
18609
18610
18611 .option file_transport redirect string&!! unset
18612 .vindex "&$address_file$&"
18613 A &(redirect)& router sets up a direct delivery to a file when a path name not
18614 ending in a slash is specified as a new &"address"&. The transport used is
18615 specified by this option, which, after expansion, must be the name of a
18616 configured transport. This should normally be an &(appendfile)& transport. When
18617 it is running, the file name is in &$address_file$&.
18618
18619
18620 .option filter_prepend_home redirect boolean true
18621 When this option is true, if a &(save)& command in an Exim filter specifies a
18622 relative path, and &$home$& is defined, it is automatically prepended to the
18623 relative path. If this option is set false, this action does not happen. The
18624 relative path is then passed to the transport unmodified.
18625
18626
18627 .option forbid_blackhole redirect boolean false
18628 If this option is true, the &':blackhole:'& item may not appear in a
18629 redirection list.
18630
18631
18632 .option forbid_exim_filter redirect boolean false
18633 If this option is set true, only Sieve filters are permitted when
18634 &%allow_filter%& is true.
18635
18636
18637
18638
18639 .option forbid_file redirect boolean false
18640 .cindex "delivery" "to file; forbidding"
18641 .cindex "Sieve filter" "forbidding delivery to a file"
18642 .cindex "Sieve filter" "&""keep""& facility; disabling"
18643 If this option is true, this router may not generate a new address that
18644 specifies delivery to a local file or directory, either from a filter or from a
18645 conventional forward file. This option is forced to be true if &%one_time%& is
18646 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18647 locks out the Sieve's &"keep"& facility.
18648
18649
18650 .option forbid_filter_dlfunc redirect boolean false
18651 .cindex "filter" "locking out certain features"
18652 If this option is true, string expansions in Exim filters are not allowed to
18653 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18654 functions.
18655
18656 .option forbid_filter_existstest redirect boolean false
18657 .cindex "expansion" "statting a file"
18658 If this option is true, string expansions in Exim filters are not allowed to
18659 make use of the &%exists%& condition or the &%stat%& expansion item.
18660
18661 .option forbid_filter_logwrite redirect boolean false
18662 If this option is true, use of the logging facility in Exim filters is not
18663 permitted. Logging is in any case available only if the filter is being run
18664 under some unprivileged uid (which is normally the case for ordinary users'
18665 &_.forward_& files).
18666
18667
18668 .option forbid_filter_lookup redirect boolean false
18669 If this option is true, string expansions in Exim filter files are not allowed
18670 to make use of &%lookup%& items.
18671
18672
18673 .option forbid_filter_perl redirect boolean false
18674 This option has an effect only if Exim is built with embedded Perl support. If
18675 it is true, string expansions in Exim filter files are not allowed to make use
18676 of the embedded Perl support.
18677
18678
18679 .option forbid_filter_readfile redirect boolean false
18680 If this option is true, string expansions in Exim filter files are not allowed
18681 to make use of &%readfile%& items.
18682
18683
18684 .option forbid_filter_readsocket redirect boolean false
18685 If this option is true, string expansions in Exim filter files are not allowed
18686 to make use of &%readsocket%& items.
18687
18688
18689 .option forbid_filter_reply redirect boolean false
18690 If this option is true, this router may not generate an automatic reply
18691 message. Automatic replies can be generated only from Exim or Sieve filter
18692 files, not from traditional forward files. This option is forced to be true if
18693 &%one_time%& is set.
18694
18695
18696 .option forbid_filter_run redirect boolean false
18697 If this option is true, string expansions in Exim filter files are not allowed
18698 to make use of &%run%& items.
18699
18700
18701 .option forbid_include redirect boolean false
18702 If this option is true, items of the form
18703 .code
18704 :include:<path name>
18705 .endd
18706 are not permitted in non-filter redirection lists.
18707
18708
18709 .option forbid_pipe redirect boolean false
18710 .cindex "delivery" "to pipe; forbidding"
18711 If this option is true, this router may not generate a new address which
18712 specifies delivery to a pipe, either from an Exim filter or from a conventional
18713 forward file. This option is forced to be true if &%one_time%& is set.
18714
18715
18716 .option forbid_sieve_filter redirect boolean false
18717 If this option is set true, only Exim filters are permitted when
18718 &%allow_filter%& is true.
18719
18720
18721 .cindex "SMTP" "error codes"
18722 .option forbid_smtp_code redirect boolean false
18723 If this option is set true, any SMTP error codes that are present at the start
18724 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18725 the default codes (451 and 550, respectively) are always used.
18726
18727
18728
18729
18730 .option hide_child_in_errmsg redirect boolean false
18731 .cindex "bounce message" "redirection details; suppressing"
18732 If this option is true, it prevents Exim from quoting a child address if it
18733 generates a bounce or delay message for it. Instead it says &"an address
18734 generated from <&'the top level address'&>"&. Of course, this applies only to
18735 bounces generated locally. If a message is forwarded to another host, &'its'&
18736 bounce may well quote the generated address.
18737
18738
18739 .option ignore_eacces redirect boolean false
18740 .cindex "EACCES"
18741 If this option is set and an attempt to open a redirection file yields the
18742 EACCES error (permission denied), the &(redirect)& router behaves as if the
18743 file did not exist.
18744
18745
18746 .option ignore_enotdir redirect boolean false
18747 .cindex "ENOTDIR"
18748 If this option is set and an attempt to open a redirection file yields the
18749 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18750 router behaves as if the file did not exist.
18751
18752 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18753 router that has the &%file%& option set discovers that the file does not exist
18754 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18755 against unmounted NFS directories. If the parent can not be statted, delivery
18756 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18757 is set, because that option tells Exim to ignore &"something on the path is not
18758 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18759 that some operating systems give ENOENT where others give ENOTDIR.
18760
18761
18762
18763 .option include_directory redirect string unset
18764 If this option is set, the path names of any &':include:'& items in a
18765 redirection list must start with this directory.
18766
18767
18768 .option modemask redirect "octal integer" 022
18769 This specifies mode bits which must not be set for a file specified by the
18770 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18771
18772
18773 .option one_time redirect boolean false
18774 .cindex "one-time aliasing/forwarding expansion"
18775 .cindex "alias file" "one-time expansion"
18776 .cindex "forward file" "one-time expansion"
18777 .cindex "mailing lists" "one-time expansion"
18778 .cindex "address redirection" "one-time expansion"
18779 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18780 files each time it tries to deliver a message causes a problem when one or more
18781 of the generated addresses fails be delivered at the first attempt. The problem
18782 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18783 but of what happens when the redirection list changes during the time that the
18784 message is on Exim's queue. This is particularly true in the case of mailing
18785 lists, where new subscribers might receive copies of messages that were posted
18786 before they subscribed.
18787
18788 If &%one_time%& is set and any addresses generated by the router fail to
18789 deliver at the first attempt, the failing addresses are added to the message as
18790 &"top level"& addresses, and the parent address that generated them is marked
18791 &"delivered"&. Thus, redirection does not happen again at the next delivery
18792 attempt.
18793
18794 &*Warning 1*&: Any header line addition or removal that is specified by this
18795 router would be lost if delivery did not succeed at the first attempt. For this
18796 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18797 permitted when &%one_time%& is set.
18798
18799 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18800 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18801 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18802
18803 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18804 &%one_time%&.
18805
18806 The original top-level address is remembered with each of the generated
18807 addresses, and is output in any log messages. However, any intermediate parent
18808 addresses are not recorded. This makes a difference to the log only if
18809 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18810 typically be used for mailing lists, where there is normally just one level of
18811 expansion.
18812
18813
18814 .option owners redirect "string list" unset
18815 .cindex "ownership" "alias file"
18816 .cindex "ownership" "forward file"
18817 .cindex "alias file" "ownership"
18818 .cindex "forward file" "ownership"
18819 This specifies a list of permitted owners for the file specified by &%file%&.
18820 This list is in addition to the local user when &%check_local_user%& is set.
18821 See &%check_owner%& above.
18822
18823
18824 .option owngroups redirect "string list" unset
18825 This specifies a list of permitted groups for the file specified by &%file%&.
18826 The list is in addition to the local user's primary group when
18827 &%check_local_user%& is set. See &%check_group%& above.
18828
18829
18830 .option pipe_transport redirect string&!! unset
18831 .vindex "&$address_pipe$&"
18832 A &(redirect)& router sets up a direct delivery to a pipe when a string
18833 starting with a vertical bar character is specified as a new &"address"&. The
18834 transport used is specified by this option, which, after expansion, must be the
18835 name of a configured transport. This should normally be a &(pipe)& transport.
18836 When the transport is run, the pipe command is in &$address_pipe$&.
18837
18838
18839 .option qualify_domain redirect string&!! unset
18840 .vindex "&$qualify_recipient$&"
18841 If this option is set, and an unqualified address (one without a domain) is
18842 generated, and that address would normally be qualified by the global setting
18843 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18844 expanding this string. If the expansion fails, the router declines. If you want
18845 to revert to the default, you can have the expansion generate
18846 &$qualify_recipient$&.
18847
18848 This option applies to all unqualified addresses generated by Exim filters,
18849 but for traditional &_.forward_& files, it applies only to addresses that are
18850 not preceded by a backslash. Sieve filters cannot generate unqualified
18851 addresses.
18852
18853 .option qualify_preserve_domain redirect boolean false
18854 .cindex "domain" "in redirection; preserving"
18855 .cindex "preserving domain in redirection"
18856 .cindex "address redirection" "domain; preserving"
18857 If this option is set, the router's local &%qualify_domain%& option must not be
18858 set (a configuration error occurs if it is). If an unqualified address (one
18859 without a domain) is generated, it is qualified with the domain of the parent
18860 address (the immediately preceding ancestor) instead of the global
18861 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18862 this applies whether or not the address is preceded by a backslash.
18863
18864
18865 .option repeat_use redirect boolean true
18866 If this option is set false, the router is skipped for a child address that has
18867 any ancestor that was routed by this router. This test happens before any of
18868 the other preconditions are tested. Exim's default anti-looping rules skip
18869 only when the ancestor is the same as the current address. See also
18870 &%check_ancestor%& above and the generic &%redirect_router%& option.
18871
18872
18873 .option reply_transport redirect string&!! unset
18874 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18875 &%vacation%& command is used in a filter file. The transport used is specified
18876 by this option, which, after expansion, must be the name of a configured
18877 transport. This should normally be an &(autoreply)& transport. Other transports
18878 are unlikely to do anything sensible or useful.
18879
18880
18881 .option rewrite redirect boolean true
18882 .cindex "address redirection" "disabling rewriting"
18883 If this option is set false, addresses generated by the router are not
18884 subject to address rewriting. Otherwise, they are treated like new addresses
18885 and are rewritten according to the global rewriting rules.
18886
18887
18888 .option sieve_subaddress redirect string&!! unset
18889 The value of this option is passed to a Sieve filter to specify the
18890 :subaddress part of an address.
18891
18892 .option sieve_useraddress redirect string&!! unset
18893 The value of this option is passed to a Sieve filter to specify the :user part
18894 of an address. However, if it is unset, the entire original local part
18895 (including any prefix or suffix) is used for :user.
18896
18897
18898 .option sieve_vacation_directory redirect string&!! unset
18899 .cindex "Sieve filter" "vacation directory"
18900 To enable the &"vacation"& extension for Sieve filters, you must set
18901 &%sieve_vacation_directory%& to the directory where vacation databases are held
18902 (do not put anything else in that directory), and ensure that the
18903 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18904 needs their own directory; Exim will create it if necessary.
18905
18906
18907
18908 .option skip_syntax_errors redirect boolean false
18909 .cindex "forward file" "broken"
18910 .cindex "address redirection" "broken files"
18911 .cindex "alias file" "broken"
18912 .cindex "broken alias or forward files"
18913 .cindex "ignoring faulty addresses"
18914 .cindex "skipping faulty addresses"
18915 .cindex "error" "skipping bad syntax"
18916 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18917 non-filter redirection data are skipped, and each failing address is logged. If
18918 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18919 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18920 are expanded and placed at the head of the error message generated by
18921 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18922 be the same address as the generic &%errors_to%& option. The
18923 &%skip_syntax_errors%& option is often used when handling mailing lists.
18924
18925 If all the addresses in a redirection list are skipped because of syntax
18926 errors, the router declines to handle the original address, and it is passed to
18927 the following routers.
18928
18929 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18930 error in the filter causes filtering to be abandoned without any action being
18931 taken. The incident is logged, and the router declines to handle the address,
18932 so it is passed to the following routers.
18933
18934 .cindex "Sieve filter" "syntax errors in"
18935 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18936 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18937 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18938
18939 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18940 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18941 option, used with an address that does not get redirected, can be used to
18942 notify users of these errors, by means of a router like this:
18943 .code
18944 userforward:
18945   driver = redirect
18946   allow_filter
18947   check_local_user
18948   file = $home/.forward
18949   file_transport = address_file
18950   pipe_transport = address_pipe
18951   reply_transport = address_reply
18952   no_verify
18953   skip_syntax_errors
18954   syntax_errors_to = real-$local_part@$domain
18955   syntax_errors_text = \
18956    This is an automatically generated message. An error has\n\
18957    been found in your .forward file. Details of the error are\n\
18958    reported below. While this error persists, you will receive\n\
18959    a copy of this message for every message that is addressed\n\
18960    to you. If your .forward file is a filter file, or if it is\n\
18961    a non-filter file containing no valid forwarding addresses,\n\
18962    a copy of each incoming message will be put in your normal\n\
18963    mailbox. If a non-filter file contains at least one valid\n\
18964    forwarding address, forwarding to the valid addresses will\n\
18965    happen, and those will be the only deliveries that occur.
18966 .endd
18967 You also need a router to ensure that local addresses that are prefixed by
18968 &`real-`& are recognized, but not forwarded or filtered. For example, you could
18969 put this immediately before the &(userforward)& router:
18970 .code
18971 real_localuser:
18972   driver = accept
18973   check_local_user
18974   local_part_prefix = real-
18975   transport = local_delivery
18976 .endd
18977 For security, it would probably be a good idea to restrict the use of this
18978 router to locally-generated messages, using a condition such as this:
18979 .code
18980   condition = ${if match {$sender_host_address}\
18981                          {\N^(|127\.0\.0\.1)$\N}}
18982 .endd
18983
18984
18985 .option syntax_errors_text redirect string&!! unset
18986 See &%skip_syntax_errors%& above.
18987
18988
18989 .option syntax_errors_to redirect string unset
18990 See &%skip_syntax_errors%& above.
18991 .ecindex IIDredrou1
18992 .ecindex IIDredrou2
18993
18994
18995
18996
18997
18998
18999 . ////////////////////////////////////////////////////////////////////////////
19000 . ////////////////////////////////////////////////////////////////////////////
19001
19002 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19003          "Environment for local transports"
19004 .scindex IIDenvlotra1 "local transports" "environment for"
19005 .scindex IIDenvlotra2 "environment for local transports"
19006 .scindex IIDenvlotra3 "transport" "local; environment for"
19007 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19008 transport can be thought of as similar to a pipe.) Exim always runs transports
19009 in subprocesses, under specified uids and gids. Typical deliveries to local
19010 mailboxes run under the uid and gid of the local user.
19011
19012 Exim also sets a specific current directory while running the transport; for
19013 some transports a home directory setting is also relevant. The &(pipe)&
19014 transport is the only one that sets up environment variables; see section
19015 &<<SECTpipeenv>>& for details.
19016
19017 The values used for the uid, gid, and the directories may come from several
19018 different places. In many cases, the router that handles the address associates
19019 settings with that address as a result of its &%check_local_user%&, &%group%&,
19020 or &%user%& options. However, values may also be given in the transport's own
19021 configuration, and these override anything that comes from the router.
19022
19023
19024
19025 .section "Concurrent deliveries" "SECID131"
19026 .cindex "concurrent deliveries"
19027 .cindex "simultaneous deliveries"
19028 If two different messages for the same local recipient arrive more or less
19029 simultaneously, the two delivery processes are likely to run concurrently. When
19030 the &(appendfile)& transport is used to write to a file, Exim applies locking
19031 rules to stop concurrent processes from writing to the same file at the same
19032 time.
19033
19034 However, when you use a &(pipe)& transport, it is up to you to arrange any
19035 locking that is needed. Here is a silly example:
19036 .code
19037 my_transport:
19038   driver = pipe
19039   command = /bin/sh -c 'cat >>/some/file'
19040 .endd
19041 This is supposed to write the message at the end of the file. However, if two
19042 messages arrive at the same time, the file will be scrambled. You can use the
19043 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19044 file using the same algorithm that Exim itself uses.
19045
19046
19047
19048
19049 .section "Uids and gids" "SECTenvuidgid"
19050 .cindex "local transports" "uid and gid"
19051 .cindex "transport" "local; uid and gid"
19052 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19053 overrides any group that the router set in the address, even if &%user%& is not
19054 set for the transport. This makes it possible, for example, to run local mail
19055 delivery under the uid of the recipient (set by the router), but in a special
19056 group (set by the transport). For example:
19057 .code
19058 # Routers ...
19059 # User/group are set by check_local_user in this router
19060 local_users:
19061   driver = accept
19062   check_local_user
19063   transport = group_delivery
19064
19065 # Transports ...
19066 # This transport overrides the group
19067 group_delivery:
19068   driver = appendfile
19069   file = /var/spool/mail/$local_part
19070   group = mail
19071 .endd
19072 If &%user%& is set for a transport, its value overrides what is set in the
19073 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19074 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19075 set.
19076
19077 .oindex "&%initgroups%&"
19078 When the uid is taken from the transport's configuration, the &[initgroups()]&
19079 function is called for the groups associated with that uid if the
19080 &%initgroups%& option is set for the transport. When the uid is not specified
19081 by the transport, but is associated with the address by a router, the option
19082 for calling &[initgroups()]& is taken from the router configuration.
19083
19084 .cindex "&(pipe)& transport" "uid for"
19085 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19086 is set and &%user%& is not set, the uid of the process that called Exim to
19087 receive the message is used, and if &%group%& is not set, the corresponding
19088 original gid is also used.
19089
19090 This is the detailed preference order for obtaining a gid; the first of the
19091 following that is set is used:
19092
19093 .ilist
19094 A &%group%& setting of the transport;
19095 .next
19096 A &%group%& setting of the router;
19097 .next
19098 A gid associated with a user setting of the router, either as a result of
19099 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19100 .next
19101 The group associated with a non-numeric &%user%& setting of the transport;
19102 .next
19103 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19104 the uid is the creator's uid;
19105 .next
19106 The Exim gid if the Exim uid is being used as a default.
19107 .endlist
19108
19109 If, for example, the user is specified numerically on the router and there are
19110 no group settings, no gid is available. In this situation, an error occurs.
19111 This is different for the uid, for which there always is an ultimate default.
19112 The first of the following that is set is used:
19113
19114 .ilist
19115 A &%user%& setting of the transport;
19116 .next
19117 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19118 .next
19119 A &%user%& setting of the router;
19120 .next
19121 A &%check_local_user%& setting of the router;
19122 .next
19123 The Exim uid.
19124 .endlist
19125
19126 Of course, an error will still occur if the uid that is chosen is on the
19127 &%never_users%& list.
19128
19129
19130
19131
19132
19133 .section "Current and home directories" "SECID132"
19134 .cindex "current directory for local transport"
19135 .cindex "home directory" "for local transport"
19136 .cindex "transport" "local; home directory for"
19137 .cindex "transport" "local; current directory for"
19138 Routers may set current and home directories for local transports by means of
19139 the &%transport_current_directory%& and &%transport_home_directory%& options.
19140 However, if the transport's &%current_directory%& or &%home_directory%& options
19141 are set, they override the router's values. In detail, the home directory
19142 for a local transport is taken from the first of these values that is set:
19143
19144 .ilist
19145 The &%home_directory%& option on the transport;
19146 .next
19147 The &%transport_home_directory%& option on the router;
19148 .next
19149 The password data if &%check_local_user%& is set on the router;
19150 .next
19151 The &%router_home_directory%& option on the router.
19152 .endlist
19153
19154 The current directory is taken from the first of these values that is set:
19155
19156 .ilist
19157 The &%current_directory%& option on the transport;
19158 .next
19159 The &%transport_current_directory%& option on the router.
19160 .endlist
19161
19162
19163 If neither the router nor the transport sets a current directory, Exim uses the
19164 value of the home directory, if it is set. Otherwise it sets the current
19165 directory to &_/_& before running a local transport.
19166
19167
19168
19169 .section "Expansion variables derived from the address" "SECID133"
19170 .vindex "&$domain$&"
19171 .vindex "&$local_part$&"
19172 .vindex "&$original_domain$&"
19173 Normally a local delivery is handling a single address, and in that case the
19174 variables such as &$domain$& and &$local_part$& are set during local
19175 deliveries. However, in some circumstances more than one address may be handled
19176 at once (for example, while writing batch SMTP for onward transmission by some
19177 other means). In this case, the variables associated with the local part are
19178 never set, &$domain$& is set only if all the addresses have the same domain,
19179 and &$original_domain$& is never set.
19180 .ecindex IIDenvlotra1
19181 .ecindex IIDenvlotra2
19182 .ecindex IIDenvlotra3
19183
19184
19185
19186
19187
19188
19189
19190 . ////////////////////////////////////////////////////////////////////////////
19191 . ////////////////////////////////////////////////////////////////////////////
19192
19193 .chapter "Generic options for transports" "CHAPtransportgeneric"
19194 .scindex IIDgenoptra1 "generic options" "transport"
19195 .scindex IIDgenoptra2 "options" "generic; for transports"
19196 .scindex IIDgenoptra3 "transport" "generic options for"
19197 The following generic options apply to all transports:
19198
19199
19200 .option body_only transports boolean false
19201 .cindex "transport" "body only"
19202 .cindex "message" "transporting body only"
19203 .cindex "body of message" "transporting"
19204 If this option is set, the message's headers are not transported. It is
19205 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19206 or &(pipe)& transports, the settings of &%message_prefix%& and
19207 &%message_suffix%& should be checked, because this option does not
19208 automatically suppress them.
19209
19210
19211 .option current_directory transports string&!! unset
19212 .cindex "transport" "current directory for"
19213 This specifies the current directory that is to be set while running the
19214 transport, overriding any value that may have been set by the router.
19215 If the expansion fails for any reason, including forced failure, an error is
19216 logged, and delivery is deferred.
19217
19218
19219 .option disable_logging transports boolean false
19220 If this option is set true, nothing is logged for any
19221 deliveries by the transport or for any
19222 transport errors. You should not set this option unless you really, really know
19223 what you are doing.
19224
19225
19226 .option debug_print transports string&!! unset
19227 .cindex "testing" "variables in drivers"
19228 If this option is set and debugging is enabled (see the &%-d%& command line
19229 option), the string is expanded and included in the debugging output when the
19230 transport is run.
19231 If expansion of the string fails, the error message is written to the debugging
19232 output, and Exim carries on processing.
19233 This facility is provided to help with checking out the values of variables and
19234 so on when debugging driver configurations. For example, if a &%headers_add%&
19235 option is not working properly, &%debug_print%& could be used to output the
19236 variables it references. A newline is added to the text if it does not end with
19237 one.
19238
19239
19240 .option delivery_date_add transports boolean false
19241 .cindex "&'Delivery-date:'& header line"
19242 If this option is true, a &'Delivery-date:'& header is added to the message.
19243 This gives the actual time the delivery was made. As this is not a standard
19244 header, Exim has a configuration option (&%delivery_date_remove%&) which
19245 requests its removal from incoming messages, so that delivered messages can
19246 safely be resent to other recipients.
19247
19248
19249 .option driver transports string unset
19250 This specifies which of the available transport drivers is to be used.
19251 There is no default, and this option must be set for every transport.
19252
19253
19254 .option envelope_to_add transports boolean false
19255 .cindex "&'Envelope-to:'& header line"
19256 If this option is true, an &'Envelope-to:'& header is added to the message.
19257 This gives the original address(es) in the incoming envelope that caused this
19258 delivery to happen. More than one address may be present if the transport is
19259 configured to handle several addresses at once, or if more than one original
19260 address was redirected to the same final address. As this is not a standard
19261 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19262 its removal from incoming messages, so that delivered messages can safely be
19263 resent to other recipients.
19264
19265
19266 .option group transports string&!! "Exim group"
19267 .cindex "transport" "group; specifying"
19268 This option specifies a gid for running the transport process, overriding any
19269 value that the router supplies, and also overriding any value associated with
19270 &%user%& (see below).
19271
19272
19273 .option headers_add transports string&!! unset
19274 .cindex "header lines" "adding in transport"
19275 .cindex "transport" "header lines; adding"
19276 This option specifies a string of text that is expanded and added to the header
19277 portion of a message as it is transported, as described in section
19278 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19279 routers. If the result of the expansion is an empty string, or if the expansion
19280 is forced to fail, no action is taken. Other expansion failures are treated as
19281 errors and cause the delivery to be deferred.
19282
19283
19284
19285 .option headers_only transports boolean false
19286 .cindex "transport" "header lines only"
19287 .cindex "message" "transporting headers only"
19288 .cindex "header lines" "transporting"
19289 If this option is set, the message's body is not transported. It is mutually
19290 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19291 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19292 checked, since this option does not automatically suppress them.
19293
19294
19295 .option headers_remove transports string&!! unset
19296 .cindex "header lines" "removing"
19297 .cindex "transport" "header lines; removing"
19298 This option specifies a string that is expanded into a list of header names;
19299 these headers are omitted from the message as it is transported, as described
19300 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19301 routers. If the result of the expansion is an empty string, or if the expansion
19302 is forced to fail, no action is taken. Other expansion failures are treated as
19303 errors and cause the delivery to be deferred.
19304
19305
19306
19307 .option headers_rewrite transports string unset
19308 .cindex "transport" "header lines; rewriting"
19309 .cindex "rewriting" "at transport time"
19310 This option allows addresses in header lines to be rewritten at transport time,
19311 that is, as the message is being copied to its destination. The contents of the
19312 option are a colon-separated list of rewriting rules. Each rule is in exactly
19313 the same form as one of the general rewriting rules that are applied when a
19314 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19315 example,
19316 .code
19317 headers_rewrite = a@b c@d f : \
19318                   x@y w@z
19319 .endd
19320 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19321 &'w@z'& in all address-bearing header lines. The rules are applied to the
19322 header lines just before they are written out at transport time, so they affect
19323 only those copies of the message that pass through the transport. However, only
19324 the message's original header lines, and any that were added by a system
19325 filter, are rewritten. If a router or transport adds header lines, they are not
19326 affected by this option. These rewriting rules are &'not'& applied to the
19327 envelope. You can change the return path using &%return_path%&, but you cannot
19328 change envelope recipients at this time.
19329
19330
19331 .option home_directory transports string&!! unset
19332 .cindex "transport" "home directory for"
19333 .vindex "&$home$&"
19334 This option specifies a home directory setting for a local transport,
19335 overriding any value that may be set by the router. The home directory is
19336 placed in &$home$& while expanding the transport's private options. It is also
19337 used as the current directory if no current directory is set by the
19338 &%current_directory%& option on the transport or the
19339 &%transport_current_directory%& option on the router. If the expansion fails
19340 for any reason, including forced failure, an error is logged, and delivery is
19341 deferred.
19342
19343
19344 .option initgroups transports boolean false
19345 .cindex "additional groups"
19346 .cindex "groups" "additional"
19347 .cindex "transport" "group; additional"
19348 If this option is true and the uid for the delivery process is provided by the
19349 transport, the &[initgroups()]& function is called when running the transport
19350 to ensure that any additional groups associated with the uid are set up.
19351
19352
19353 .option message_size_limit transports string&!! 0
19354 .cindex "limit" "message size per transport"
19355 .cindex "size" "of message, limit"
19356 .cindex "transport" "message size; limiting"
19357 This option controls the size of messages passed through the transport. It is
19358 expanded before use; the result of the expansion must be a sequence of decimal
19359 digits, optionally followed by K or M. If the expansion fails for any reason,
19360 including forced failure, or if the result is not of the required form,
19361 delivery is deferred. If the value is greater than zero and the size of a
19362 message exceeds this limit, the address is failed. If there is any chance that
19363 the resulting bounce message could be routed to the same transport, you should
19364 ensure that &%return_size_limit%& is less than the transport's
19365 &%message_size_limit%&, as otherwise the bounce message will fail to get
19366 delivered.
19367
19368
19369
19370 .option rcpt_include_affixes transports boolean false
19371 .cindex "prefix" "for local part, including in envelope"
19372 .cindex "suffix for local part" "including in envelope"
19373 .cindex "local part" "prefix"
19374 .cindex "local part" "suffix"
19375 When this option is false (the default), and an address that has had any
19376 affixes (prefixes or suffixes) removed from the local part is delivered by any
19377 form of SMTP or LMTP, the affixes are not included. For example, if a router
19378 that contains
19379 .code
19380 local_part_prefix = *-
19381 .endd
19382 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19383 is delivered with
19384 .code
19385 RCPT TO:<xyz@some.domain>
19386 .endd
19387 This is also the case when an ACL-time callout is being used to verify a
19388 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19389 whole local part is included in the RCPT command. This option applies to BSMTP
19390 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19391 &(lmtp)& and &(smtp)& transports.
19392
19393
19394 .option retry_use_local_part transports boolean "see below"
19395 .cindex "hints database" "retry keys"
19396 When a delivery suffers a temporary failure, a retry record is created
19397 in Exim's hints database. For remote deliveries, the key for the retry record
19398 is based on the name and/or IP address of the failing remote host. For local
19399 deliveries, the key is normally the entire address, including both the local
19400 part and the domain. This is suitable for most common cases of local delivery
19401 temporary failure &-- for example, exceeding a mailbox quota should delay only
19402 deliveries to that mailbox, not to the whole domain.
19403
19404 However, in some special cases you may want to treat a temporary local delivery
19405 as a failure associated with the domain, and not with a particular local part.
19406 (For example, if you are storing all mail for some domain in files.) You can do
19407 this by setting &%retry_use_local_part%& false.
19408
19409 For all the local transports, its default value is true. For remote transports,
19410 the default value is false for tidiness, but changing the value has no effect
19411 on a remote transport in the current implementation.
19412
19413
19414 .option return_path transports string&!! unset
19415 .cindex "envelope sender"
19416 .cindex "transport" "return path; changing"
19417 .cindex "return path" "changing in transport"
19418 If this option is set, the string is expanded at transport time and replaces
19419 the existing return path (envelope sender) value in the copy of the message
19420 that is being delivered. An empty return path is permitted. This feature is
19421 designed for remote deliveries, where the value of this option is used in the
19422 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19423 only effect is to change the address that is placed in the &'Return-path:'&
19424 header line, if one is added to the message (see the next option).
19425
19426 &*Note:*& A changed return path is not logged unless you add
19427 &%return_path_on_delivery%& to the log selector.
19428
19429 .vindex "&$return_path$&"
19430 The expansion can refer to the existing value via &$return_path$&. This is
19431 either the message's envelope sender, or an address set by the
19432 &%errors_to%& option on a router. If the expansion is forced to fail, no
19433 replacement occurs; if it fails for another reason, delivery is deferred. This
19434 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19435 section &<<SECTverp>>&.
19436
19437 &*Note*&: If a delivery error is detected locally, including the case when a
19438 remote server rejects a message at SMTP time, the bounce message is not sent to
19439 the value of this option. It is sent to the previously set errors address.
19440 This defaults to the incoming sender address, but can be changed by setting
19441 &%errors_to%& in a router.
19442
19443
19444
19445 .option return_path_add transports boolean false
19446 .cindex "&'Return-path:'& header line"
19447 If this option is true, a &'Return-path:'& header is added to the message.
19448 Although the return path is normally available in the prefix line of BSD
19449 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19450 have easy access to it.
19451
19452 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19453 the delivery SMTP server makes the final delivery"&. This implies that this
19454 header should not be present in incoming messages. Exim has a configuration
19455 option, &%return_path_remove%&, which requests removal of this header from
19456 incoming messages, so that delivered messages can safely be resent to other
19457 recipients.
19458
19459
19460 .option shadow_condition transports string&!! unset
19461 See &%shadow_transport%& below.
19462
19463
19464 .option shadow_transport transports string unset
19465 .cindex "shadow transport"
19466 .cindex "transport" "shadow"
19467 A local transport may set the &%shadow_transport%& option to the name of
19468 another local transport. Shadow remote transports are not supported.
19469
19470 Whenever a delivery to the main transport succeeds, and either
19471 &%shadow_condition%& is unset, or its expansion does not result in the empty
19472 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19473 passed to the shadow transport, with the same delivery address or addresses. If
19474 expansion fails, no action is taken except that non-forced expansion failures
19475 cause a log line to be written.
19476
19477 The result of the shadow transport is discarded and does not affect the
19478 subsequent processing of the message. Only a single level of shadowing is
19479 provided; the &%shadow_transport%& option is ignored on any transport when it
19480 is running as a shadow. Options concerned with output from pipes are also
19481 ignored. The log line for the successful delivery has an item added on the end,
19482 of the form
19483 .code
19484 ST=<shadow transport name>
19485 .endd
19486 If the shadow transport did not succeed, the error message is put in
19487 parentheses afterwards. Shadow transports can be used for a number of different
19488 purposes, including keeping more detailed log information than Exim normally
19489 provides, and implementing automatic acknowledgment policies based on message
19490 headers that some sites insist on.
19491
19492
19493 .option transport_filter transports string&!! unset
19494 .cindex "transport" "filter"
19495 .cindex "filter" "transport filter"
19496 This option sets up a filtering (in the Unix shell sense) process for messages
19497 at transport time. It should not be confused with mail filtering as set up by
19498 individual users or via a system filter.
19499
19500 When the message is about to be written out, the command specified by
19501 &%transport_filter%& is started up in a separate, parallel process, and
19502 the entire message, including the header lines, is passed to it on its standard
19503 input (this in fact is done from a third process, to avoid deadlock). The
19504 command must be specified as an absolute path.
19505
19506 The lines of the message that are written to the transport filter are
19507 terminated by newline (&"\n"&). The message is passed to the filter before any
19508 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19509 lines beginning with a dot, and also before any processing implied by the
19510 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19511 &(pipe)& transports.
19512
19513 The standard error for the filter process is set to the same destination as its
19514 standard output; this is read and written to the message's ultimate
19515 destination. The process that writes the message to the filter, the
19516 filter itself, and the original process that reads the result and delivers it
19517 are all run in parallel, like a shell pipeline.
19518
19519 The filter can perform any transformations it likes, but of course should take
19520 care not to break RFC 2822 syntax. Exim does not check the result, except to
19521 test for a final newline when SMTP is in use. All messages transmitted over
19522 SMTP must end with a newline, so Exim supplies one if it is missing.
19523
19524 .cindex "content scanning" "per user"
19525 A transport filter can be used to provide content-scanning on a per-user basis
19526 at delivery time if the only required effect of the scan is to modify the
19527 message. For example, a content scan could insert a new header line containing
19528 a spam score. This could be interpreted by a filter in the user's MUA. It is
19529 not possible to discard a message at this stage.
19530
19531 .cindex "SMTP" "SIZE"
19532 A problem might arise if the filter increases the size of a message that is
19533 being sent down an SMTP connection. If the receiving SMTP server has indicated
19534 support for the SIZE parameter, Exim will have sent the size of the message
19535 at the start of the SMTP session. If what is actually sent is substantially
19536 more, the server might reject the message. This can be worked round by setting
19537 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19538 additions to the message, or to disable the use of SIZE altogether.
19539
19540 .vindex "&$pipe_addresses$&"
19541 The value of the &%transport_filter%& option is the command string for starting
19542 the filter, which is run directly from Exim, not under a shell. The string is
19543 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19544 Exim breaks it up into arguments and then expands each argument separately (see
19545 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19546 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19547 of arguments, one for each address that applies to this delivery. (This isn't
19548 an ideal name for this feature here, but as it was already implemented for the
19549 &(pipe)& transport, it seemed sensible not to change it.)
19550
19551 .vindex "&$host$&"
19552 .vindex "&$host_address$&"
19553 The expansion variables &$host$& and &$host_address$& are available when the
19554 transport is a remote one. They contain the name and IP address of the host to
19555 which the message is being sent. For example:
19556 .code
19557 transport_filter = /some/directory/transport-filter.pl \
19558   $host $host_address $sender_address $pipe_addresses
19559 .endd
19560
19561 Two problems arise if you want to use more complicated expansion items to
19562 generate transport filter commands, both of which due to the fact that the
19563 command is split up &'before'& expansion.
19564 .ilist
19565 If an expansion item contains white space, you must quote it, so that it is all
19566 part of the same command item. If the entire option setting is one such
19567 expansion item, you have to take care what kind of quoting you use. For
19568 example:
19569 .code
19570 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19571 .endd
19572 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19573 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19574 stripped by Exim when it read the option's value. When the value is used, if
19575 the single quotes were missing, the line would be split into two items,
19576 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19577 Exim tried to expand the first one.
19578 .next
19579 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19580 expansion cannot generate multiple arguments, or a command name followed by
19581 arguments. Consider this example:
19582 .code
19583 transport_filter = ${lookup{$host}lsearch{/a/file}\
19584                     {$value}{/bin/cat}}
19585 .endd
19586 The result of the lookup is interpreted as the name of the command, even
19587 if it contains white space. The simplest way round this is to use a shell:
19588 .code
19589 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19590                                {$value}{/bin/cat}}
19591 .endd
19592 .endlist
19593
19594 The filter process is run under the same uid and gid as the normal delivery.
19595 For remote deliveries this is the Exim uid/gid by default. The command should
19596 normally yield a zero return code. Transport filters are not supposed to fail.
19597 A non-zero code is taken to mean that the transport filter encountered some
19598 serious problem. Delivery of the message is deferred; the message remains on
19599 the queue and is tried again later. It is not possible to cause a message to be
19600 bounced from a transport filter.
19601
19602 If a transport filter is set on an autoreply transport, the original message is
19603 passed through the filter as it is being copied into the newly generated
19604 message, which happens if the &%return_message%& option is set.
19605
19606
19607 .option transport_filter_timeout transports time 5m
19608 .cindex "transport" "filter, timeout"
19609 When Exim is reading the output of a transport filter, it a applies a timeout
19610 that can be set by this option. Exceeding the timeout is normally treated as a
19611 temporary delivery failure. However, if a transport filter is used with a
19612 &(pipe)& transport, a timeout in the transport filter is treated in the same
19613 way as a timeout in the pipe command itself. By default, a timeout is a hard
19614 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19615 becomes a temporary error.
19616
19617
19618 .option user transports string&!! "Exim user"
19619 .cindex "uid (user id)" "local delivery"
19620 .cindex "transport" "user, specifying"
19621 This option specifies the user under whose uid the delivery process is to be
19622 run, overriding any uid that may have been set by the router. If the user is
19623 given as a name, the uid is looked up from the password data, and the
19624 associated group is taken as the value of the gid to be used if the &%group%&
19625 option is not set.
19626
19627 For deliveries that use local transports, a user and group are normally
19628 specified explicitly or implicitly (for example, as a result of
19629 &%check_local_user%&) by the router or transport.
19630
19631 .cindex "hints database" "access by remote transport"
19632 For remote transports, you should leave this option unset unless you really are
19633 sure you know what you are doing. When a remote transport is running, it needs
19634 to be able to access Exim's hints databases, because each host may have its own
19635 retry data.
19636 .ecindex IIDgenoptra1
19637 .ecindex IIDgenoptra2
19638 .ecindex IIDgenoptra3
19639
19640
19641
19642
19643
19644
19645 . ////////////////////////////////////////////////////////////////////////////
19646 . ////////////////////////////////////////////////////////////////////////////
19647
19648 .chapter "Address batching in local transports" "CHAPbatching" &&&
19649          "Address batching"
19650 .cindex "transport" "local; address batching in"
19651 The only remote transport (&(smtp)&) is normally configured to handle more than
19652 one address at a time, so that when several addresses are routed to the same
19653 remote host, just one copy of the message is sent. Local transports, however,
19654 normally handle one address at a time. That is, a separate instance of the
19655 transport is run for each address that is routed to the transport. A separate
19656 copy of the message is delivered each time.
19657
19658 .cindex "batched local delivery"
19659 .oindex "&%batch_max%&"
19660 .oindex "&%batch_id%&"
19661 In special cases, it may be desirable to handle several addresses at once in a
19662 local transport, for example:
19663
19664 .ilist
19665 In an &(appendfile)& transport, when storing messages in files for later
19666 delivery by some other means, a single copy of the message with multiple
19667 recipients saves space.
19668 .next
19669 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19670 a single copy saves time, and is the normal way LMTP is expected to work.
19671 .next
19672 In a &(pipe)& transport, when passing the message
19673 to a scanner program or
19674 to some other delivery mechanism such as UUCP, multiple recipients may be
19675 acceptable.
19676 .endlist
19677
19678 These three local transports all have the same options for controlling multiple
19679 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19680 repeating the information for each transport, these options are described here.
19681
19682 The &%batch_max%& option specifies the maximum number of addresses that can be
19683 delivered together in a single run of the transport. Its default value is one
19684 (no batching). When more than one address is routed to a transport that has a
19685 &%batch_max%& value greater than one, the addresses are delivered in a batch
19686 (that is, in a single run of the transport with multiple recipients), subject
19687 to certain conditions:
19688
19689 .ilist
19690 .vindex "&$local_part$&"
19691 If any of the transport's options contain a reference to &$local_part$&, no
19692 batching is possible.
19693 .next
19694 .vindex "&$domain$&"
19695 If any of the transport's options contain a reference to &$domain$&, only
19696 addresses with the same domain are batched.
19697 .next
19698 .cindex "customizing" "batching condition"
19699 If &%batch_id%& is set, it is expanded for each address, and only those
19700 addresses with the same expanded value are batched. This allows you to specify
19701 customized batching conditions. Failure of the expansion for any reason,
19702 including forced failure, disables batching, but it does not stop the delivery
19703 from taking place.
19704 .next
19705 Batched addresses must also have the same errors address (where to send
19706 delivery errors), the same header additions and removals, the same user and
19707 group for the transport, and if a host list is present, the first host must
19708 be the same.
19709 .endlist
19710
19711 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19712 both when the file or pipe command is specified in the transport, and when it
19713 is specified by a &(redirect)& router, but all the batched addresses must of
19714 course be routed to the same file or pipe command. These two transports have an
19715 option called &%use_bsmtp%&, which causes them to deliver the message in
19716 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19717 &%check_string%& and &%escape_string%& options are forced to the values
19718 .code
19719 check_string = "."
19720 escape_string = ".."
19721 .endd
19722 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19723 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19724 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19725
19726 .cindex "&'Envelope-to:'& header line"
19727 If the generic &%envelope_to_add%& option is set for a batching transport, the
19728 &'Envelope-to:'& header that is added to the message contains all the addresses
19729 that are being processed together. If you are using a batching &(appendfile)&
19730 transport without &%use_bsmtp%&, the only way to preserve the recipient
19731 addresses is to set the &%envelope_to_add%& option.
19732
19733 .cindex "&(pipe)& transport" "with multiple addresses"
19734 .vindex "&$pipe_addresses$&"
19735 If you are using a &(pipe)& transport without BSMTP, and setting the
19736 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19737 the command. This is not a true variable; it is a bit of magic that causes each
19738 of the recipient addresses to be inserted into the command as a separate
19739 argument. This provides a way of accessing all the addresses that are being
19740 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19741 are specified by a &(redirect)& router.
19742
19743
19744
19745
19746 . ////////////////////////////////////////////////////////////////////////////
19747 . ////////////////////////////////////////////////////////////////////////////
19748
19749 .chapter "The appendfile transport" "CHAPappendfile"
19750 .scindex IIDapptra1 "&(appendfile)& transport"
19751 .scindex IIDapptra2 "transports" "&(appendfile)&"
19752 .cindex "directory creation"
19753 .cindex "creating directories"
19754 The &(appendfile)& transport delivers a message by appending it to an existing
19755 file, or by creating an entirely new file in a specified directory. Single
19756 files to which messages are appended can be in the traditional Unix mailbox
19757 format, or optionally in the MBX format supported by the Pine MUA and
19758 University of Washington IMAP daemon, &'inter alia'&. When each message is
19759 being delivered as a separate file, &"maildir"& format can optionally be used
19760 to give added protection against failures that happen part-way through the
19761 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19762 supported. For all file formats, Exim attempts to create as many levels of
19763 directory as necessary, provided that &%create_directory%& is set.
19764
19765 The code for the optional formats is not included in the Exim binary by
19766 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19767 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19768 included.
19769
19770 .cindex "quota" "system"
19771 Exim recognizes system quota errors, and generates an appropriate message. Exim
19772 also supports its own quota control within the transport, for use when the
19773 system facility is unavailable or cannot be used for some reason.
19774
19775 If there is an error while appending to a file (for example, quota exceeded or
19776 partition filled), Exim attempts to reset the file's length and last
19777 modification time back to what they were before. If there is an error while
19778 creating an entirely new file, the new file is removed.
19779
19780 Before appending to a file, a number of security checks are made, and the
19781 file is locked. A detailed description is given below, after the list of
19782 private options.
19783
19784 The &(appendfile)& transport is most commonly used for local deliveries to
19785 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19786 putting messages into files for remote delivery by some means other than Exim.
19787 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19788 option).
19789
19790
19791
19792 .section "The file and directory options" "SECTfildiropt"
19793 The &%file%& option specifies a single file, to which the message is appended;
19794 the &%directory%& option specifies a directory, in which a new file containing
19795 the message is created. Only one of these two options can be set, and for
19796 normal deliveries to mailboxes, one of them &'must'& be set.
19797
19798 .vindex "&$address_file$&"
19799 .vindex "&$local_part$&"
19800 However, &(appendfile)& is also used for delivering messages to files or
19801 directories whose names (or parts of names) are obtained from alias,
19802 forwarding, or filtering operations (for example, a &%save%& command in a
19803 user's Exim filter). When such a transport is running, &$local_part$& contains
19804 the local part that was aliased or forwarded, and &$address_file$& contains the
19805 name (or partial name) of the file or directory generated by the redirection
19806 operation. There are two cases:
19807
19808 .ilist
19809 If neither &%file%& nor &%directory%& is set, the redirection operation
19810 must specify an absolute path (one that begins with &`/`&). This is the most
19811 common case when users with local accounts use filtering to sort mail into
19812 different folders. See for example, the &(address_file)& transport in the
19813 default configuration. If the path ends with a slash, it is assumed to be the
19814 name of a directory. A delivery to a directory can also be forced by setting
19815 &%maildir_format%& or &%mailstore_format%&.
19816 .next
19817 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19818 used to determine the file or directory name for the delivery. Normally, the
19819 contents of &$address_file$& are used in some way in the string expansion.
19820 .endlist
19821
19822
19823 .cindex "Sieve filter" "configuring &(appendfile)&"
19824 .cindex "Sieve filter" "relative mailbox path handling"
19825 As an example of the second case, consider an environment where users do not
19826 have home directories. They may be permitted to use Exim filter commands of the
19827 form:
19828 .code
19829 save folder23
19830 .endd
19831 or Sieve filter commands of the form:
19832 .code
19833 require "fileinto";
19834 fileinto "folder23";
19835 .endd
19836 In this situation, the expansion of &%file%& or &%directory%& in the transport
19837 must transform the relative path into an appropriate absolute file name. In the
19838 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19839 is used as a result of a &"keep"& action in the filter. This example shows one
19840 way of handling this requirement:
19841 .code
19842 file = ${if eq{$address_file}{inbox} \
19843             {/var/mail/$local_part} \
19844             {${if eq{${substr_0_1:$address_file}}{/} \
19845                   {$address_file} \
19846                   {$home/mail/$address_file} \
19847             }} \
19848        }
19849 .endd
19850 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19851 location, absolute paths are used without change, and other folders are in the
19852 &_mail_& directory within the home directory.
19853
19854 &*Note 1*&: While processing an Exim filter, a relative path such as
19855 &_folder23_& is turned into an absolute path if a home directory is known to
19856 the router. In particular, this is the case if &%check_local_user%& is set. If
19857 you want to prevent this happening at routing time, you can set
19858 &%router_home_directory%& empty. This forces the router to pass the relative
19859 path to the transport.
19860
19861 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19862 the &%file%& or &%directory%& option is still used if it is set.
19863
19864
19865
19866
19867 .section "Private options for appendfile" "SECID134"
19868 .cindex "options" "&(appendfile)& transport"
19869
19870
19871
19872 .option allow_fifo appendfile boolean false
19873 .cindex "fifo (named pipe)"
19874 .cindex "named pipe (fifo)"
19875 .cindex "pipe" "named (fifo)"
19876 Setting this option permits delivery to named pipes (FIFOs) as well as to
19877 regular files. If no process is reading the named pipe at delivery time, the
19878 delivery is deferred.
19879
19880
19881 .option allow_symlink appendfile boolean false
19882 .cindex "symbolic link" "to mailbox"
19883 .cindex "mailbox" "symbolic link"
19884 By default, &(appendfile)& will not deliver if the path name for the file is
19885 that of a symbolic link. Setting this option relaxes that constraint, but there
19886 are security issues involved in the use of symbolic links. Be sure you know
19887 what you are doing if you set this. Details of exactly what this option affects
19888 are included in the discussion which follows this list of options.
19889
19890
19891 .option batch_id appendfile string&!! unset
19892 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19893 However, batching is automatically disabled for &(appendfile)& deliveries that
19894 happen as a result of forwarding or aliasing or other redirection directly to a
19895 file.
19896
19897
19898 .option batch_max appendfile integer 1
19899 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19900
19901
19902 .option check_group appendfile boolean false
19903 When this option is set, the group owner of the file defined by the &%file%&
19904 option is checked to see that it is the same as the group under which the
19905 delivery process is running. The default setting is false because the default
19906 file mode is 0600, which means that the group is irrelevant.
19907
19908
19909 .option check_owner appendfile boolean true
19910 When this option is set, the owner of the file defined by the &%file%& option
19911 is checked to ensure that it is the same as the user under which the delivery
19912 process is running.
19913
19914
19915 .option check_string appendfile string "see below"
19916 .cindex "&""From""& line"
19917 As &(appendfile)& writes the message, the start of each line is tested for
19918 matching &%check_string%&, and if it does, the initial matching characters are
19919 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19920 a literal string, not a regular expression, and the case of any letters it
19921 contains is significant.
19922
19923 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19924 are forced to &"."& and &".."& respectively, and any settings in the
19925 configuration are ignored. Otherwise, they default to &"From&~"& and
19926 &">From&~"& when the &%file%& option is set, and unset when any of the
19927 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19928
19929 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19930 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19931 &"From&~"& indicates the start of a new message. All four options need changing
19932 if another format is used. For example, to deliver to mailboxes in MMDF format:
19933 .cindex "MMDF format mailbox"
19934 .cindex "mailbox" "MMDF format"
19935 .code
19936 check_string = "\1\1\1\1\n"
19937 escape_string = "\1\1\1\1 \n"
19938 message_prefix = "\1\1\1\1\n"
19939 message_suffix = "\1\1\1\1\n"
19940 .endd
19941 .option create_directory appendfile boolean true
19942 .cindex "directory creation"
19943 When this option is true, Exim attempts to create any missing superior
19944 directories for the file that it is about to write. A created directory's mode
19945 is given by the &%directory_mode%& option.
19946
19947 The group ownership of a newly created directory is highly dependent on the
19948 operating system (and possibly the file system) that is being used. For
19949 example, in Solaris, if the parent directory has the setgid bit set, its group
19950 is propagated to the child; if not, the currently set group is used. However,
19951 in FreeBSD, the parent's group is always used.
19952
19953
19954
19955 .option create_file appendfile string anywhere
19956 This option constrains the location of files and directories that are created
19957 by this transport. It applies to files defined by the &%file%& option and
19958 directories defined by the &%directory%& option. In the case of maildir
19959 delivery, it applies to the top level directory, not the maildir directories
19960 beneath.
19961
19962 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
19963 &"belowhome"&. In the second and third cases, a home directory must have been
19964 set for the transport. This option is not useful when an explicit file name is
19965 given for normal mailbox deliveries. It is intended for the case when file
19966 names are generated from users' &_.forward_& files. These are usually handled
19967 by an &(appendfile)& transport called &%address_file%&. See also
19968 &%file_must_exist%&.
19969
19970
19971 .option directory appendfile string&!! unset
19972 This option is mutually exclusive with the &%file%& option, but one of &%file%&
19973 or &%directory%& must be set, unless the delivery is the direct result of a
19974 redirection (see section &<<SECTfildiropt>>&).
19975
19976 When &%directory%& is set, the string is expanded, and the message is delivered
19977 into a new file or files in or below the given directory, instead of being
19978 appended to a single mailbox file. A number of different formats are provided
19979 (see &%maildir_format%& and &%mailstore_format%&), and see section
19980 &<<SECTopdir>>& for further details of this form of delivery.
19981
19982
19983 .option directory_file appendfile string&!! "see below"
19984 .cindex "base62"
19985 .vindex "&$inode$&"
19986 When &%directory%& is set, but neither &%maildir_format%& nor
19987 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
19988 whose name is obtained by expanding this string. The default value is:
19989 .code
19990 q${base62:$tod_epoch}-$inode
19991 .endd
19992 This generates a unique name from the current time, in base 62 form, and the
19993 inode of the file. The variable &$inode$& is available only when expanding this
19994 option.
19995
19996
19997 .option directory_mode appendfile "octal integer" 0700
19998 If &(appendfile)& creates any directories as a result of the
19999 &%create_directory%& option, their mode is specified by this option.
20000
20001
20002 .option escape_string appendfile string "see description"
20003 See &%check_string%& above.
20004
20005
20006 .option file appendfile string&!! unset
20007 This option is mutually exclusive with the &%directory%& option, but one of
20008 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20009 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20010 specifies a single file, to which the message is appended. One or more of
20011 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20012 &%file%&.
20013
20014 .cindex "NFS" "lock file"
20015 .cindex "locking files"
20016 .cindex "lock files"
20017 If you are using more than one host to deliver over NFS into the same
20018 mailboxes, you should always use lock files.
20019
20020 The string value is expanded for each delivery, and must yield an absolute
20021 path. The most common settings of this option are variations on one of these
20022 examples:
20023 .code
20024 file = /var/spool/mail/$local_part
20025 file = /home/$local_part/inbox
20026 file = $home/inbox
20027 .endd
20028 .cindex "&""sticky""& bit"
20029 In the first example, all deliveries are done into the same directory. If Exim
20030 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20031 create a file in the directory, so the &"sticky"& bit must be turned on for
20032 deliveries to be possible, or alternatively the &%group%& option can be used to
20033 run the delivery under a group id which has write access to the directory.
20034
20035
20036
20037 .option file_format appendfile string unset
20038 .cindex "file" "mailbox; checking existing format"
20039 This option requests the transport to check the format of an existing file
20040 before adding to it. The check consists of matching a specific string at the
20041 start of the file. The value of the option consists of an even number of
20042 colon-separated strings. The first of each pair is the test string, and the
20043 second is the name of a transport. If the transport associated with a matched
20044 string is not the current transport, control is passed over to the other
20045 transport. For example, suppose the standard &(local_delivery)& transport has
20046 this added to it:
20047 .code
20048 file_format = "From       : local_delivery :\
20049                \1\1\1\1\n : local_mmdf_delivery"
20050 .endd
20051 Mailboxes that begin with &"From"& are still handled by this transport, but if
20052 a mailbox begins with four binary ones followed by a newline, control is passed
20053 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20054 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20055 is assumed to match the current transport. If the start of a mailbox doesn't
20056 match any string, or if the transport named for a given string is not defined,
20057 delivery is deferred.
20058
20059
20060 .option file_must_exist appendfile boolean false
20061 If this option is true, the file specified by the &%file%& option must exist.
20062 A temporary error occurs if it does not, causing delivery to be deferred.
20063 If this option is false, the file is created if it does not exist.
20064
20065
20066 .option lock_fcntl_timeout appendfile time 0s
20067 .cindex "timeout" "mailbox locking"
20068 .cindex "mailbox" "locking, blocking and non-blocking"
20069 .cindex "locking files"
20070 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20071 when locking an open mailbox file. If the call fails, the delivery process
20072 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20073 Non-blocking calls are used so that the file is not kept open during the wait
20074 for the lock; the reason for this is to make it as safe as possible for
20075 deliveries over NFS in the case when processes might be accessing an NFS
20076 mailbox without using a lock file. This should not be done, but
20077 misunderstandings and hence misconfigurations are not unknown.
20078
20079 On a busy system, however, the performance of a non-blocking lock approach is
20080 not as good as using a blocking lock with a timeout. In this case, the waiting
20081 is done inside the system call, and Exim's delivery process acquires the lock
20082 and can proceed as soon as the previous lock holder releases it.
20083
20084 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20085 timeout, are used. There may still be some retrying: the maximum number of
20086 retries is
20087 .code
20088 (lock_retries * lock_interval) / lock_fcntl_timeout
20089 .endd
20090 rounded up to the next whole number. In other words, the total time during
20091 which &(appendfile)& is trying to get a lock is roughly the same, unless
20092 &%lock_fcntl_timeout%& is set very large.
20093
20094 You should consider setting this option if you are getting a lot of delayed
20095 local deliveries because of errors of the form
20096 .code
20097 failed to lock mailbox /some/file (fcntl)
20098 .endd
20099
20100 .option lock_flock_timeout appendfile time 0s
20101 This timeout applies to file locking when using &[flock()]& (see
20102 &%use_flock%&); the timeout operates in a similar manner to
20103 &%lock_fcntl_timeout%&.
20104
20105
20106 .option lock_interval appendfile time 3s
20107 This specifies the time to wait between attempts to lock the file. See below
20108 for details of locking.
20109
20110
20111 .option lock_retries appendfile integer 10
20112 This specifies the maximum number of attempts to lock the file. A value of zero
20113 is treated as 1. See below for details of locking.
20114
20115
20116 .option lockfile_mode appendfile "octal integer" 0600
20117 This specifies the mode of the created lock file, when a lock file is being
20118 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20119
20120
20121 .option lockfile_timeout appendfile time 30m
20122 .cindex "timeout" "mailbox locking"
20123 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20124 exists and is older than this value, it is assumed to have been left behind by
20125 accident, and Exim attempts to remove it.
20126
20127
20128 .option mailbox_filecount appendfile string&!! unset
20129 .cindex "mailbox" "specifying size of"
20130 .cindex "size" "of mailbox"
20131 If this option is set, it is expanded, and the result is taken as the current
20132 number of files in the mailbox. It must be a decimal number, optionally
20133 followed by K or M. This provides a way of obtaining this information from an
20134 external source that maintains the data.
20135
20136
20137 .option mailbox_size appendfile string&!! unset
20138 .cindex "mailbox" "specifying size of"
20139 .cindex "size" "of mailbox"
20140 If this option is set, it is expanded, and the result is taken as the current
20141 size the mailbox. It must be a decimal number, optionally followed by K or M.
20142 This provides a way of obtaining this information from an external source that
20143 maintains the data. This is likely to be helpful for maildir deliveries where
20144 it is computationally expensive to compute the size of a mailbox.
20145
20146
20147
20148 .option maildir_format appendfile boolean false
20149 .cindex "maildir format" "specifying"
20150 If this option is set with the &%directory%& option, the delivery is into a new
20151 file, in the &"maildir"& format that is used by other mail software. When the
20152 transport is activated directly from a &(redirect)& router (for example, the
20153 &(address_file)& transport in the default configuration), setting
20154 &%maildir_format%& causes the path received from the router to be treated as a
20155 directory, whether or not it ends with &`/`&. This option is available only if
20156 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20157 &<<SECTmaildirdelivery>>& below for further details.
20158
20159
20160 .option maildir_quota_directory_regex appendfile string "See below"
20161 .cindex "maildir format" "quota; directories included in"
20162 .cindex "quota" "maildir; directories included in"
20163 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20164 a regular expression for specifying directories, relative to the quota
20165 directory (see &%quota_directory%&), that should be included in the quota
20166 calculation. The default value is:
20167 .code
20168 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20169 .endd
20170 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20171 (directories whose names begin with a dot). If you want to exclude the
20172 &_Trash_&
20173 folder from the count (as some sites do), you need to change this setting to
20174 .code
20175 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20176 .endd
20177 This uses a negative lookahead in the regular expression to exclude the
20178 directory whose name is &_.Trash_&. When a directory is excluded from quota
20179 calculations, quota processing is bypassed for any messages that are delivered
20180 directly into that directory.
20181
20182
20183 .option maildir_retries appendfile integer 10
20184 This option specifies the number of times to retry when writing a file in
20185 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20186
20187
20188 .option maildir_tag appendfile string&!! unset
20189 This option applies only to deliveries in maildir format, and is described in
20190 section &<<SECTmaildirdelivery>>& below.
20191
20192
20193 .new
20194 .option maildir_use_size_file appendfile&!! boolean false
20195 .cindex "maildir format" "&_maildirsize_& file"
20196 The result of string expansion for this option must be a valid boolean value.
20197 If it is true, it enables support for &_maildirsize_& files. Exim
20198 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20199 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20200 value is zero. See &%maildir_quota_directory_regex%& above and section
20201 &<<SECTmaildirdelivery>>& below for further details.
20202 .wen
20203
20204 .option maildirfolder_create_regex appendfile string unset
20205 .cindex "maildir format" "&_maildirfolder_& file"
20206 .cindex "&_maildirfolder_&, creating"
20207 The value of this option is a regular expression. If it is unset, it has no
20208 effect. Otherwise, before a maildir delivery takes place, the pattern is
20209 matched against the name of the maildir directory, that is, the directory
20210 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20211 delivery. If there is a match, Exim checks for the existence of a file called
20212 &_maildirfolder_& in the directory, and creates it if it does not exist.
20213 See section &<<SECTmaildirdelivery>>& for more details.
20214
20215
20216 .option mailstore_format appendfile boolean false
20217 .cindex "mailstore format" "specifying"
20218 If this option is set with the &%directory%& option, the delivery is into two
20219 new files in  &"mailstore"& format. The option is available only if
20220 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20221 below for further details.
20222
20223
20224 .option mailstore_prefix appendfile string&!! unset
20225 This option applies only to deliveries in mailstore format, and is described in
20226 section &<<SECTopdir>>& below.
20227
20228
20229 .option mailstore_suffix appendfile string&!! unset
20230 This option applies only to deliveries in mailstore format, and is described in
20231 section &<<SECTopdir>>& below.
20232
20233
20234 .option mbx_format appendfile boolean false
20235 .cindex "locking files"
20236 .cindex "file" "locking"
20237 .cindex "file" "MBX format"
20238 .cindex "MBX format, specifying"
20239 This option is available only if Exim has been compiled with SUPPORT_MBX
20240 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20241 the message is appended to the mailbox file in MBX format instead of
20242 traditional Unix format. This format is supported by Pine4 and its associated
20243 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20244
20245 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20246 automatically changed by the use of &%mbx_format%&. They should normally be set
20247 empty when using MBX format, so this option almost always appears in this
20248 combination:
20249 .code
20250 mbx_format = true
20251 message_prefix =
20252 message_suffix =
20253 .endd
20254 If none of the locking options are mentioned in the configuration,
20255 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20256 is possible to specify the other kinds of locking with &%mbx_format%&, but
20257 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20258 interworks with &'c-client'&, providing for shared access to the mailbox. It
20259 should not be used if any program that does not use this form of locking is
20260 going to access the mailbox, nor should it be used if the mailbox file is NFS
20261 mounted, because it works only when the mailbox is accessed from a single host.
20262
20263 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20264 the standard version of &'c-client'&, because as long as it has a mailbox open
20265 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20266 append messages to it.
20267
20268
20269 .option message_prefix appendfile string&!! "see below"
20270 .cindex "&""From""& line"
20271 The string specified here is expanded and output at the start of every message.
20272 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20273 in which case it is:
20274 .code
20275 message_prefix = "From ${if def:return_path{$return_path}\
20276   {MAILER-DAEMON}} $tod_bsdinbox\n"
20277 .endd
20278 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20279 &`\n`& to &`\r\n`& in &%message_prefix%&.
20280
20281 .option message_suffix appendfile string&!! "see below"
20282 The string specified here is expanded and output at the end of every message.
20283 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20284 in which case it is a single newline character. The suffix can be suppressed by
20285 setting
20286 .code
20287 message_suffix =
20288 .endd
20289 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20290 &`\n`& to &`\r\n`& in &%message_suffix%&.
20291
20292 .option mode appendfile "octal integer" 0600
20293 If the output file is created, it is given this mode. If it already exists and
20294 has wider permissions, they are reduced to this mode. If it has narrower
20295 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20296 if the delivery is the result of a &%save%& command in a filter file specifying
20297 a particular mode, the mode of the output file is always forced to take that
20298 value, and this option is ignored.
20299
20300
20301 .option mode_fail_narrower appendfile boolean true
20302 This option applies in the case when an existing mailbox file has a narrower
20303 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20304 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20305 continues with the delivery attempt, using the existing mode of the file.
20306
20307
20308 .option notify_comsat appendfile boolean false
20309 If this option is true, the &'comsat'& daemon is notified after every
20310 successful delivery to a user mailbox. This is the daemon that notifies logged
20311 on users about incoming mail.
20312
20313
20314 .option quota appendfile string&!! unset
20315 .cindex "quota" "imposed by Exim"
20316 This option imposes a limit on the size of the file to which Exim is appending,
20317 or to the total space used in the directory tree when the &%directory%& option
20318 is set. In the latter case, computation of the space used is expensive, because
20319 all the files in the directory (and any sub-directories) have to be
20320 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20321 &%maildir_use_size_file%& for ways to avoid this in environments where users
20322 have no shell access to their mailboxes).
20323
20324 As there is no interlock against two simultaneous deliveries into a
20325 multi-file mailbox, it is possible for the quota to be overrun in this case.
20326 For single-file mailboxes, of course, an interlock is a necessity.
20327
20328 A file's size is taken as its &'used'& value. Because of blocking effects, this
20329 may be a lot less than the actual amount of disk space allocated to the file.
20330 If the sizes of a number of files are being added up, the rounding effect can
20331 become quite noticeable, especially on systems that have large block sizes.
20332 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20333 the obvious value which users understand most easily.
20334
20335 The value of the option is expanded, and must then be a numerical value
20336 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20337 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20338 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20339 be handled.
20340
20341 &*Note*&: A value of zero is interpreted as &"no quota"&.
20342
20343 The expansion happens while Exim is running as root, before it changes uid for
20344 the delivery. This means that files that are inaccessible to the end user can
20345 be used to hold quota values that are looked up in the expansion. When delivery
20346 fails because this quota is exceeded, the handling of the error is as for
20347 system quota failures.
20348
20349 By default, Exim's quota checking mimics system quotas, and restricts the
20350 mailbox to the specified maximum size, though the value is not accurate to the
20351 last byte, owing to separator lines and additional headers that may get added
20352 during message delivery. When a mailbox is nearly full, large messages may get
20353 refused even though small ones are accepted, because the size of the current
20354 message is added to the quota when the check is made. This behaviour can be
20355 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20356 for exceeding the quota does not include the current message. Thus, deliveries
20357 continue until the quota has been exceeded; thereafter, no further messages are
20358 delivered. See also &%quota_warn_threshold%&.
20359
20360
20361 .option quota_directory appendfile string&!! unset
20362 This option defines the directory to check for quota purposes when delivering
20363 into individual files. The default is the delivery directory, or, if a file
20364 called &_maildirfolder_& exists in a maildir directory, the parent of the
20365 delivery directory.
20366
20367
20368 .option quota_filecount appendfile string&!! 0
20369 This option applies when the &%directory%& option is set. It limits the total
20370 number of files in the directory (compare the inode limit in system quotas). It
20371 can only be used if &%quota%& is also set. The value is expanded; an expansion
20372 failure causes delivery to be deferred. A value of zero is interpreted as
20373 &"no quota"&.
20374
20375
20376 .option quota_is_inclusive appendfile boolean true
20377 See &%quota%& above.
20378
20379
20380 .option quota_size_regex appendfile string unset
20381 This option applies when one of the delivery modes that writes a separate file
20382 for each message is being used. When Exim wants to find the size of one of
20383 these files in order to test the quota, it first checks &%quota_size_regex%&.
20384 If this is set to a regular expression that matches the file name, and it
20385 captures one string, that string is interpreted as a representation of the
20386 file's size. The value of &%quota_size_regex%& is not expanded.
20387
20388 This feature is useful only when users have no shell access to their mailboxes
20389 &-- otherwise they could defeat the quota simply by renaming the files. This
20390 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20391 the file length to the file name. For example:
20392 .code
20393 maildir_tag = ,S=$message_size
20394 quota_size_regex = ,S=(\d+)
20395 .endd
20396 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20397 number of lines in the message.
20398
20399 The regular expression should not assume that the length is at the end of the
20400 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20401 sometimes add other information onto the ends of message file names.
20402
20403 Section &<<SECID136>>& contains further information.
20404
20405
20406 .option quota_warn_message appendfile string&!! "see below"
20407 See below for the use of this option. If it is not set when
20408 &%quota_warn_threshold%& is set, it defaults to
20409 .code
20410 quota_warn_message = "\
20411   To: $local_part@$domain\n\
20412   Subject: Your mailbox\n\n\
20413   This message is automatically created \
20414   by mail delivery software.\n\n\
20415   The size of your mailbox has exceeded \
20416   a warning threshold that is\n\
20417   set by the system administrator.\n"
20418 .endd
20419
20420
20421 .option quota_warn_threshold appendfile string&!! 0
20422 .cindex "quota" "warning threshold"
20423 .cindex "mailbox" "size warning"
20424 .cindex "size" "of mailbox"
20425 This option is expanded in the same way as &%quota%& (see above). If the
20426 resulting value is greater than zero, and delivery of the message causes the
20427 size of the file or total space in the directory tree to cross the given
20428 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20429 may be specified as a percentage of it by following the value with a percent
20430 sign. For example:
20431 .code
20432 quota = 10M
20433 quota_warn_threshold = 75%
20434 .endd
20435 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20436 percent sign is ignored.
20437
20438 The warning message itself is specified by the &%quota_warn_message%& option,
20439 and it must start with a &'To:'& header line containing the recipient(s) of the
20440 warning message. These do not necessarily have to include the recipient(s) of
20441 the original message. A &'Subject:'& line should also normally be supplied. You
20442 can include any other header lines that you want. If you do not include a
20443 &'From:'& line, the default is:
20444 .code
20445 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20446 .endd
20447 .oindex &%errors_reply_to%&
20448 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20449 option.
20450
20451 The &%quota%& option does not have to be set in order to use this option; they
20452 are independent of one another except when the threshold is specified as a
20453 percentage.
20454
20455
20456 .option use_bsmtp appendfile boolean false
20457 .cindex "envelope sender"
20458 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20459 format, with the envelope sender and recipient(s) included as SMTP commands. If
20460 you want to include a leading HELO command with such messages, you can do
20461 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20462 for details of batch SMTP.
20463
20464
20465 .option use_crlf appendfile boolean false
20466 .cindex "carriage return"
20467 .cindex "linefeed"
20468 This option causes lines to be terminated with the two-character CRLF sequence
20469 (carriage return, linefeed) instead of just a linefeed character. In the case
20470 of batched SMTP, the byte sequence written to the file is then an exact image
20471 of what would be sent down a real SMTP connection.
20472
20473 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20474 (which are used to supply the traditional &"From&~"& and blank line separators
20475 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20476 carriage return characters if these are needed. In cases where these options
20477 have non-empty defaults, the values end with a single linefeed, so they must be
20478 changed to end with &`\r\n`& if &%use_crlf%& is set.
20479
20480
20481 .option use_fcntl_lock appendfile boolean "see below"
20482 This option controls the use of the &[fcntl()]& function to lock a file for
20483 exclusive use when a message is being appended. It is set by default unless
20484 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20485 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20486 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20487
20488
20489 .option use_flock_lock appendfile boolean false
20490 This option is provided to support the use of &[flock()]& for file locking, for
20491 the few situations where it is needed. Most modern operating systems support
20492 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20493 each other. Exim uses &[fcntl()]& locking by default.
20494
20495 This option is required only if you are using an operating system where
20496 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20497 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20498 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20499
20500 .cindex "Solaris" "&[flock()]& support"
20501 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20502 have it (and some, I think, provide a not quite right version built on top of
20503 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20504 the ability to use it, and any attempt to do so will cause a configuration
20505 error.
20506
20507 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20508 is just being mapped onto &[fcntl()]& by the OS).
20509
20510
20511 .option use_lockfile appendfile boolean "see below"
20512 If this option is turned off, Exim does not attempt to create a lock file when
20513 appending to a mailbox file. In this situation, the only locking is by
20514 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20515 sure that every MUA that is ever going to look at your users' mailboxes uses
20516 &[fcntl()]& rather than a lock file, and even then only when you are not
20517 delivering over NFS from more than one host.
20518
20519 .cindex "NFS" "lock file"
20520 In order to append to an NFS file safely from more than one host, it is
20521 necessary to take out a lock &'before'& opening the file, and the lock file
20522 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20523 file corruption.
20524
20525 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20526 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20527 except when &%mbx_format%& is set.
20528
20529
20530 .option use_mbx_lock appendfile boolean "see below"
20531 This option is available only if Exim has been compiled with SUPPORT_MBX
20532 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20533 locking rules be used. It is set by default if &%mbx_format%& is set and none
20534 of the locking options are mentioned in the configuration. The locking rules
20535 are the same as are used by the &'c-client'& library that underlies Pine and
20536 the IMAP4 and POP daemons that come with it (see the discussion below). The
20537 rules allow for shared access to the mailbox. However, this kind of locking
20538 does not work when the mailbox is NFS mounted.
20539
20540 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20541 &%use_flock_lock%& to control what kind of locking is used in implementing the
20542 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20543 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20544
20545
20546
20547
20548 .section "Operational details for appending" "SECTopappend"
20549 .cindex "appending to a file"
20550 .cindex "file" "appending"
20551 Before appending to a file, the following preparations are made:
20552
20553 .ilist
20554 If the name of the file is &_/dev/null_&, no action is taken, and a success
20555 return is given.
20556
20557 .next
20558 .cindex "directory creation"
20559 If any directories on the file's path are missing, Exim creates them if the
20560 &%create_directory%& option is set. A created directory's mode is given by the
20561 &%directory_mode%& option.
20562
20563 .next
20564 If &%file_format%& is set, the format of an existing file is checked. If this
20565 indicates that a different transport should be used, control is passed to that
20566 transport.
20567
20568 .next
20569 .cindex "file" "locking"
20570 .cindex "locking files"
20571 .cindex "NFS" "lock file"
20572 If &%use_lockfile%& is set, a lock file is built in a way that will work
20573 reliably over NFS, as follows:
20574
20575 .olist
20576 Create a &"hitching post"& file whose name is that of the lock file with the
20577 current time, primary host name, and process id added, by opening for writing
20578 as a new file. If this fails with an access error, delivery is deferred.
20579 .next
20580 Close the hitching post file, and hard link it to the lock file name.
20581 .next
20582 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20583 Unlink the hitching post name.
20584 .next
20585 Otherwise, use &[stat()]& to get information about the hitching post file, and
20586 then unlink hitching post name. If the number of links is exactly two, creation
20587 of the lock file succeeded but something (for example, an NFS server crash and
20588 restart) caused this fact not to be communicated to the &[link()]& call.
20589 .next
20590 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20591 up to &%lock_retries%& times. However, since any program that writes to a
20592 mailbox should complete its task very quickly, it is reasonable to time out old
20593 lock files that are normally the result of user agent and system crashes. If an
20594 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20595 it before trying again.
20596 .endlist olist
20597
20598 .next
20599 A call is made to &[lstat()]& to discover whether the main file exists, and if
20600 so, what its characteristics are. If &[lstat()]& fails for any reason other
20601 than non-existence, delivery is deferred.
20602
20603 .next
20604 .cindex "symbolic link" "to mailbox"
20605 .cindex "mailbox" "symbolic link"
20606 If the file does exist and is a symbolic link, delivery is deferred, unless the
20607 &%allow_symlink%& option is set, in which case the ownership of the link is
20608 checked, and then &[stat()]& is called to find out about the real file, which
20609 is then subjected to the checks below. The check on the top-level link
20610 ownership prevents one user creating a link for another's mailbox in a sticky
20611 directory, though allowing symbolic links in this case is definitely not a good
20612 idea. If there is a chain of symbolic links, the intermediate ones are not
20613 checked.
20614
20615 .next
20616 If the file already exists but is not a regular file, or if the file's owner
20617 and group (if the group is being checked &-- see &%check_group%& above) are
20618 different from the user and group under which the delivery is running,
20619 delivery is deferred.
20620
20621 .next
20622 If the file's permissions are more generous than specified, they are reduced.
20623 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20624 is set false, in which case the delivery is tried using the existing
20625 permissions.
20626
20627 .next
20628 The file's inode number is saved, and the file is then opened for appending.
20629 If this fails because the file has vanished, &(appendfile)& behaves as if it
20630 hadn't existed (see below). For any other failures, delivery is deferred.
20631
20632 .next
20633 If the file is opened successfully, check that the inode number hasn't
20634 changed, that it is still a regular file, and that the owner and permissions
20635 have not changed. If anything is wrong, defer delivery and freeze the message.
20636
20637 .next
20638 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20639 option is set. Otherwise, check that the file is being created in a permitted
20640 directory if the &%create_file%& option is set (deferring on failure), and then
20641 open for writing as a new file, with the O_EXCL and O_CREAT options,
20642 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20643 set). In this case, which can happen if the link points to a non-existent file,
20644 the file is opened for writing using O_CREAT but not O_EXCL, because
20645 that prevents link following.
20646
20647 .next
20648 .cindex "loop" "while file testing"
20649 If opening fails because the file exists, obey the tests given above for
20650 existing files. However, to avoid looping in a situation where the file is
20651 being continuously created and destroyed, the exists/not-exists loop is broken
20652 after 10 repetitions, and the message is then frozen.
20653
20654 .next
20655 If opening fails with any other error, defer delivery.
20656
20657 .next
20658 .cindex "file" "locking"
20659 .cindex "locking files"
20660 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20661 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20662 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20663 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20664 file, and an exclusive lock on the file whose name is
20665 .code
20666 /tmp/.<device-number>.<inode-number>
20667 .endd
20668 using the device and inode numbers of the open mailbox file, in accordance with
20669 the MBX locking rules. This file is created with a mode that is specified by
20670 the &%lockfile_mode%& option.
20671
20672 If Exim fails to lock the file, there are two possible courses of action,
20673 depending on the value of the locking timeout. This is obtained from
20674 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20675
20676 If the timeout value is zero, the file is closed, Exim waits for
20677 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20678 to lock it again. This happens up to &%lock_retries%& times, after which the
20679 delivery is deferred.
20680
20681 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20682 &[flock()]& are used (with the given timeout), so there has already been some
20683 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20684 immediately. It retries up to
20685 .code
20686 (lock_retries * lock_interval) / <timeout>
20687 .endd
20688 times (rounded up).
20689 .endlist
20690
20691 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20692 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20693
20694
20695 .section "Operational details for delivery to a new file" "SECTopdir"
20696 .cindex "delivery" "to single file"
20697 .cindex "&""From""& line"
20698 When the &%directory%& option is set instead of &%file%&, each message is
20699 delivered into a newly-created file or set of files. When &(appendfile)& is
20700 activated directly from a &(redirect)& router, neither &%file%& nor
20701 &%directory%& is normally set, because the path for delivery is supplied by the
20702 router. (See for example, the &(address_file)& transport in the default
20703 configuration.) In this case, delivery is to a new file if either the path name
20704 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20705
20706 No locking is required while writing the message to a new file, so the various
20707 locking options of the transport are ignored. The &"From"& line that by default
20708 separates messages in a single file is not normally needed, nor is the escaping
20709 of message lines that start with &"From"&, and there is no need to ensure a
20710 newline at the end of each message. Consequently, the default values for
20711 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20712 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20713
20714 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20715 the files in the delivery directory by default. However, you can specify a
20716 different directory by setting &%quota_directory%&. Also, for maildir
20717 deliveries (see below) the &_maildirfolder_& convention is honoured.
20718
20719
20720 .cindex "maildir format"
20721 .cindex "mailstore format"
20722 There are three different ways in which delivery to individual files can be
20723 done, controlled by the settings of the &%maildir_format%& and
20724 &%mailstore_format%& options. Note that code to support maildir or mailstore
20725 formats is not included in the binary unless SUPPORT_MAILDIR or
20726 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20727
20728 .cindex "directory creation"
20729 In all three cases an attempt is made to create the directory and any necessary
20730 sub-directories if they do not exist, provided that the &%create_directory%&
20731 option is set (the default). The location of a created directory can be
20732 constrained by setting &%create_file%&. A created directory's mode is given by
20733 the &%directory_mode%& option. If creation fails, or if the
20734 &%create_directory%& option is not set when creation is required, delivery is
20735 deferred.
20736
20737
20738
20739 .section "Maildir delivery" "SECTmaildirdelivery"
20740 .cindex "maildir format" "description of"
20741 If the &%maildir_format%& option is true, Exim delivers each message by writing
20742 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20743 directory that is defined by the &%directory%& option (the &"delivery
20744 directory"&). If the delivery is successful, the file is renamed into the
20745 &_new_& subdirectory.
20746
20747 In the file name, <&'stime'&> is the current time of day in seconds, and
20748 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20749 Exim checks that the time-of-day clock has moved on by at least one microsecond
20750 before terminating the delivery process. This guarantees uniqueness for the
20751 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20752 opening it. If any response other than ENOENT (does not exist) is given,
20753 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20754
20755 Before Exim carries out a maildir delivery, it ensures that subdirectories
20756 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20757 do not exist, Exim tries to create them and any superior directories in their
20758 path, subject to the &%create_directory%& and &%create_file%& options. If the
20759 &%maildirfolder_create_regex%& option is set, and the regular expression it
20760 contains matches the delivery directory, Exim also ensures that a file called
20761 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20762 &_maildirfolder_& file cannot be created, delivery is deferred.
20763
20764 These features make it possible to use Exim to create all the necessary files
20765 and directories in a maildir mailbox, including subdirectories for maildir++
20766 folders. Consider this example:
20767 .code
20768 maildir_format = true
20769 directory = /var/mail/$local_part\
20770            ${if eq{$local_part_suffix}{}{}\
20771            {/.${substr_1:$local_part_suffix}}}
20772 maildirfolder_create_regex = /\.[^/]+$
20773 .endd
20774 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20775 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20776 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20777 not match this name, so Exim will not look for or create the file
20778 &_/var/mail/pimbo/maildirfolder_&, though it will create
20779 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20780
20781 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20782 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20783 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20784 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20785 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20786
20787 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20788 not inadvertently match the toplevel maildir directory, because a
20789 &_maildirfolder_& file at top level would completely break quota calculations.
20790
20791 .cindex "quota" "in maildir delivery"
20792 .cindex "maildir++"
20793 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20794 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20795 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20796 Exim assumes the directory is a maildir++ folder directory, which is one level
20797 down from the user's top level mailbox directory. This causes it to start at
20798 the parent directory instead of the current directory when calculating the
20799 amount of space used.
20800
20801 One problem with delivering into a multi-file mailbox is that it is
20802 computationally expensive to compute the size of the mailbox for quota
20803 checking. Various approaches have been taken to reduce the amount of work
20804 needed. The next two sections describe two of them. A third alternative is to
20805 use some external process for maintaining the size data, and use the expansion
20806 of the &%mailbox_size%& option as a way of importing it into Exim.
20807
20808
20809
20810
20811 .section "Using tags to record message sizes" "SECID135"
20812 If &%maildir_tag%& is set, the string is expanded for each delivery.
20813 When the maildir file is renamed into the &_new_& sub-directory, the
20814 tag is added to its name. However, if adding the tag takes the length of the
20815 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20816 the tag is dropped and the maildir file is created with no tag.
20817
20818
20819 .vindex "&$message_size$&"
20820 Tags can be used to encode the size of files in their names; see
20821 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20822 happens after the message has been written. The value of the &$message_size$&
20823 variable is set to the number of bytes actually written. If the expansion is
20824 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20825 be deferred. The expanded tag may contain any printing characters except &"/"&.
20826 Non-printing characters in the string are ignored; if the resulting string is
20827 empty, it is ignored. If it starts with an alphanumeric character, a leading
20828 colon is inserted; this default has not proven to be the path that popular
20829 maildir implementations have chosen (but changing it in Exim would break
20830 backwards compatibility).
20831
20832 For one common implementation, you might set:
20833 .code
20834 maildir_tag = ,S=${message_size}
20835 .endd
20836 but you should check the documentation of the other software to be sure.
20837
20838 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
20839 as this allows Exim to extract the size from your tag, instead of having to
20840 &[stat()]& each message file.
20841
20842
20843 .section "Using a maildirsize file" "SECID136"
20844 .cindex "quota" "in maildir delivery"
20845 .cindex "maildir format" "&_maildirsize_& file"
20846 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20847 storing quota and message size information in a file called &_maildirsize_&
20848 within the toplevel maildir directory. If this file does not exist, Exim
20849 creates it, setting the quota from the &%quota%& option of the transport. If
20850 the maildir directory itself does not exist, it is created before any attempt
20851 to write a &_maildirsize_& file.
20852
20853 The &_maildirsize_& file is used to hold information about the sizes of
20854 messages in the maildir, thus speeding up quota calculations. The quota value
20855 in the file is just a cache; if the quota is changed in the transport, the new
20856 value overrides the cached value when the next message is delivered. The cache
20857 is maintained for the benefit of other programs that access the maildir and
20858 need to know the quota.
20859
20860 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20861 file is maintained (with a zero quota setting), but no quota is imposed.
20862
20863 A regular expression is available for controlling which directories in the
20864 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20865 See the description of the &%maildir_quota_directory_regex%& option above for
20866 details.
20867
20868
20869 .section "Mailstore delivery" "SECID137"
20870 .cindex "mailstore format" "description of"
20871 If the &%mailstore_format%& option is true, each message is written as two
20872 files in the given directory. A unique base name is constructed from the
20873 message id and the current delivery process, and the files that are written use
20874 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20875 contains the message's envelope, and the &_.msg_& file contains the message
20876 itself. The base name is placed in the variable &$mailstore_basename$&.
20877
20878 During delivery, the envelope is first written to a file with the suffix
20879 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20880 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20881 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20882 file before accessing either of them. An alternative approach is to wait for
20883 the absence of a &_.tmp_& file.
20884
20885 The envelope file starts with any text defined by the &%mailstore_prefix%&
20886 option, expanded and terminated by a newline if there isn't one. Then follows
20887 the sender address on one line, then all the recipient addresses, one per line.
20888 There can be more than one recipient only if the &%batch_max%& option is set
20889 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20890 appended to the file, followed by a newline if it does not end with one.
20891
20892 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20893 failure, it is ignored. Other expansion errors are treated as serious
20894 configuration errors, and delivery is deferred. The variable
20895 &$mailstore_basename$& is available for use during these expansions.
20896
20897
20898 .section "Non-special new file delivery" "SECID138"
20899 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20900 file is created directly in the named directory. For example, when delivering
20901 messages into files in batched SMTP format for later delivery to some host (see
20902 section &<<SECTbatchSMTP>>&), a setting such as
20903 .code
20904 directory = /var/bsmtp/$host
20905 .endd
20906 might be used. A message is written to a file with a temporary name, which is
20907 then renamed when the delivery is complete. The final name is obtained by
20908 expanding the contents of the &%directory_file%& option.
20909 .ecindex IIDapptra1
20910 .ecindex IIDapptra2
20911
20912
20913
20914
20915
20916
20917 . ////////////////////////////////////////////////////////////////////////////
20918 . ////////////////////////////////////////////////////////////////////////////
20919
20920 .chapter "The autoreply transport" "CHID8"
20921 .scindex IIDauttra1 "transports" "&(autoreply)&"
20922 .scindex IIDauttra2 "&(autoreply)& transport"
20923 The &(autoreply)& transport is not a true transport in that it does not cause
20924 the message to be transmitted. Instead, it generates a new mail message as an
20925 automatic reply to the incoming message. &'References:'& and
20926 &'Auto-Submitted:'& header lines are included. These are constructed according
20927 to the rules in RFCs 2822 and 3834, respectively.
20928
20929 If the router that passes the message to this transport does not have the
20930 &%unseen%& option set, the original message (for the current recipient) is not
20931 delivered anywhere. However, when the &%unseen%& option is set on the router
20932 that passes the message to this transport, routing of the address continues, so
20933 another router can set up a normal message delivery.
20934
20935
20936 The &(autoreply)& transport is usually run as the result of mail filtering, a
20937 &"vacation"& message being the standard example. However, it can also be run
20938 directly from a router like any other transport. To reduce the possibility of
20939 message cascades, messages created by the &(autoreply)& transport always have
20940 empty envelope sender addresses, like bounce messages.
20941
20942 The parameters of the message to be sent can be specified in the configuration
20943 by options described below. However, these are used only when the address
20944 passed to the transport does not contain its own reply information. When the
20945 transport is run as a consequence of a
20946 &%mail%&
20947 or &%vacation%& command in a filter file, the parameters of the message are
20948 supplied by the filter, and passed with the address. The transport's options
20949 that define the message are then ignored (so they are not usually set in this
20950 case). The message is specified entirely by the filter or by the transport; it
20951 is never built from a mixture of options. However, the &%file_optional%&,
20952 &%mode%&, and &%return_message%& options apply in all cases.
20953
20954 &(Autoreply)& is implemented as a local transport. When used as a result of a
20955 command in a user's filter file, &(autoreply)& normally runs under the uid and
20956 gid of the user, and with appropriate current and home directories (see chapter
20957 &<<CHAPenvironment>>&).
20958
20959 There is a subtle difference between routing a message to a &(pipe)& transport
20960 that generates some text to be returned to the sender, and routing it to an
20961 &(autoreply)& transport. This difference is noticeable only if more than one
20962 address from the same message is so handled. In the case of a pipe, the
20963 separate outputs from the different addresses are gathered up and returned to
20964 the sender in a single message, whereas if &(autoreply)& is used, a separate
20965 message is generated for each address that is passed to it.
20966
20967 Non-printing characters are not permitted in the header lines generated for the
20968 message that &(autoreply)& creates, with the exception of newlines that are
20969 immediately followed by white space. If any non-printing characters are found,
20970 the transport defers.
20971 Whether characters with the top bit set count as printing characters or not is
20972 controlled by the &%print_topbitchars%& global option.
20973
20974 If any of the generic options for manipulating headers (for example,
20975 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
20976 of the original message that is included in the generated message when
20977 &%return_message%& is set. They do not apply to the generated message itself.
20978
20979 .vindex "&$sender_address$&"
20980 If the &(autoreply)& transport receives return code 2 from Exim when it submits
20981 the message, indicating that there were no recipients, it does not treat this
20982 as an error. This means that autoreplies sent to &$sender_address$& when this
20983 is empty (because the incoming message is a bounce message) do not cause
20984 problems. They are just discarded.
20985
20986
20987
20988 .section "Private options for autoreply" "SECID139"
20989 .cindex "options" "&(autoreply)& transport"
20990
20991 .option bcc autoreply string&!! unset
20992 This specifies the addresses that are to receive &"blind carbon copies"& of the
20993 message when the message is specified by the transport.
20994
20995
20996 .option cc autoreply string&!! unset
20997 This specifies recipients of the message and the contents of the &'Cc:'& header
20998 when the message is specified by the transport.
20999
21000
21001 .option file autoreply string&!! unset
21002 The contents of the file are sent as the body of the message when the message
21003 is specified by the transport. If both &%file%& and &%text%& are set, the text
21004 string comes first.
21005
21006
21007 .option file_expand autoreply boolean false
21008 If this is set, the contents of the file named by the &%file%& option are
21009 subjected to string expansion as they are added to the message.
21010
21011
21012 .option file_optional autoreply boolean false
21013 If this option is true, no error is generated if the file named by the &%file%&
21014 option or passed with the address does not exist or cannot be read.
21015
21016
21017 .option from autoreply string&!! unset
21018 This specifies the contents of the &'From:'& header when the message is
21019 specified by the transport.
21020
21021
21022 .option headers autoreply string&!! unset
21023 This specifies additional RFC 2822 headers that are to be added to the message
21024 when the message is specified by the transport. Several can be given by using
21025 &"\n"& to separate them. There is no check on the format.
21026
21027
21028 .option log autoreply string&!! unset
21029 This option names a file in which a record of every message sent is logged when
21030 the message is specified by the transport.
21031
21032
21033 .option mode autoreply "octal integer" 0600
21034 If either the log file or the &"once"& file has to be created, this mode is
21035 used.
21036
21037
21038 .option never_mail autoreply "address list&!!" unset
21039 If any run of the transport creates a message with a recipient that matches any
21040 item in the list, that recipient is quietly discarded. If all recipients are
21041 discarded, no message is created. This applies both when the recipients are
21042 generated by a filter and when they are specified in the transport.
21043
21044
21045
21046 .option once autoreply string&!! unset
21047 This option names a file or DBM database in which a record of each &'To:'&
21048 recipient is kept when the message is specified by the transport. &*Note*&:
21049 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21050
21051 If &%once%& is unset, or is set to an empty string, the message is always sent.
21052 By default, if &%once%& is set to a non-empty file name, the message
21053 is not sent if a potential recipient is already listed in the database.
21054 However, if the &%once_repeat%& option specifies a time greater than zero, the
21055 message is sent if that much time has elapsed since a message was last sent to
21056 this recipient. A setting of zero time for &%once_repeat%& (the default)
21057 prevents a message from being sent a second time &-- in this case, zero means
21058 infinity.
21059
21060 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21061 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21062 greater than zero, it changes the way Exim implements the &%once%& option.
21063 Instead of using a DBM file to record every recipient it sends to, it uses a
21064 regular file, whose size will never get larger than the given value.
21065
21066 In the file, Exim keeps a linear list of recipient addresses and the times at
21067 which they were sent messages. If the file is full when a new address needs to
21068 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21069 means that a given recipient may receive multiple messages, but at
21070 unpredictable intervals that depend on the rate of turnover of addresses in the
21071 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21072
21073
21074 .option once_file_size autoreply integer 0
21075 See &%once%& above.
21076
21077
21078 .option once_repeat autoreply time&!! 0s
21079 See &%once%& above.
21080 After expansion, the value of this option must be a valid time value.
21081
21082
21083 .option reply_to autoreply string&!! unset
21084 This specifies the contents of the &'Reply-To:'& header when the message is
21085 specified by the transport.
21086
21087
21088 .option return_message autoreply boolean false
21089 If this is set, a copy of the original message is returned with the new
21090 message, subject to the maximum size set in the &%return_size_limit%& global
21091 configuration option.
21092
21093
21094 .option subject autoreply string&!! unset
21095 This specifies the contents of the &'Subject:'& header when the message is
21096 specified by the transport. It is tempting to quote the original subject in
21097 automatic responses. For example:
21098 .code
21099 subject = Re: $h_subject:
21100 .endd
21101 There is a danger in doing this, however. It may allow a third party to
21102 subscribe your users to an opt-in mailing list, provided that the list accepts
21103 bounce messages as subscription confirmations. Well-managed lists require a
21104 non-bounce message to confirm a subscription, so the danger is relatively
21105 small.
21106
21107
21108
21109 .option text autoreply string&!! unset
21110 This specifies a single string to be used as the body of the message when the
21111 message is specified by the transport. If both &%text%& and &%file%& are set,
21112 the text comes first.
21113
21114
21115 .option to autoreply string&!! unset
21116 This specifies recipients of the message and the contents of the &'To:'& header
21117 when the message is specified by the transport.
21118 .ecindex IIDauttra1
21119 .ecindex IIDauttra2
21120
21121
21122
21123
21124 . ////////////////////////////////////////////////////////////////////////////
21125 . ////////////////////////////////////////////////////////////////////////////
21126
21127 .chapter "The lmtp transport" "CHAPLMTP"
21128 .cindex "transports" "&(lmtp)&"
21129 .cindex "&(lmtp)& transport"
21130 .cindex "LMTP" "over a pipe"
21131 .cindex "LMTP" "over a socket"
21132 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21133 specified command
21134 or by interacting with a Unix domain socket.
21135 This transport is something of a cross between the &(pipe)& and &(smtp)&
21136 transports. Exim also has support for using LMTP over TCP/IP; this is
21137 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21138 to be of minority interest, the default build-time configure in &_src/EDITME_&
21139 has it commented out. You need to ensure that
21140 .code
21141 TRANSPORT_LMTP=yes
21142 .endd
21143 .cindex "options" "&(lmtp)& transport"
21144 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21145 included in the Exim binary. The private options of the &(lmtp)& transport are
21146 as follows:
21147
21148 .option batch_id lmtp string&!! unset
21149 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21150
21151
21152 .option batch_max lmtp integer 1
21153 This limits the number of addresses that can be handled in a single delivery.
21154 Most LMTP servers can handle several addresses at once, so it is normally a
21155 good idea to increase this value. See the description of local delivery
21156 batching in chapter &<<CHAPbatching>>&.
21157
21158
21159 .option command lmtp string&!! unset
21160 This option must be set if &%socket%& is not set. The string is a command which
21161 is run in a separate process. It is split up into a command name and list of
21162 arguments, each of which is separately expanded (so expansion cannot change the
21163 number of arguments). The command is run directly, not via a shell. The message
21164 is passed to the new process using the standard input and output to operate the
21165 LMTP protocol.
21166
21167 .option ignore_quota lmtp boolean false
21168 .cindex "LMTP" "ignoring quota errors"
21169 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21170 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21171 in its response to the LHLO command.
21172
21173 .option socket lmtp string&!! unset
21174 This option must be set if &%command%& is not set. The result of expansion must
21175 be the name of a Unix domain socket. The transport connects to the socket and
21176 delivers the message to it using the LMTP protocol.
21177
21178
21179 .option timeout lmtp time 5m
21180 The transport is aborted if the created process or Unix domain socket does not
21181 respond to LMTP commands or message input within this timeout. Delivery
21182 is deferred, and will be tried again later. Here is an example of a typical
21183 LMTP transport:
21184 .code
21185 lmtp:
21186   driver = lmtp
21187   command = /some/local/lmtp/delivery/program
21188   batch_max = 20
21189   user = exim
21190 .endd
21191 This delivers up to 20 addresses at a time, in a mixture of domains if
21192 necessary, running as the user &'exim'&.
21193
21194
21195
21196 . ////////////////////////////////////////////////////////////////////////////
21197 . ////////////////////////////////////////////////////////////////////////////
21198
21199 .chapter "The pipe transport" "CHAPpipetransport"
21200 .scindex IIDpiptra1 "transports" "&(pipe)&"
21201 .scindex IIDpiptra2 "&(pipe)& transport"
21202 The &(pipe)& transport is used to deliver messages via a pipe to a command
21203 running in another process. One example is the use of &(pipe)& as a
21204 pseudo-remote transport for passing messages to some other delivery mechanism
21205 (such as UUCP). Another is the use by individual users to automatically process
21206 their incoming messages. The &(pipe)& transport can be used in one of the
21207 following ways:
21208
21209 .ilist
21210 .vindex "&$local_part$&"
21211 A router routes one address to a transport in the normal way, and the
21212 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21213 contains the local part of the address (as usual), and the command that is run
21214 is specified by the &%command%& option on the transport.
21215 .next
21216 .vindex "&$pipe_addresses$&"
21217 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21218 transport can handle more than one address in a single run. In this case, when
21219 more than one address is routed to the transport, &$local_part$& is not set
21220 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21221 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21222 that are routed to the transport.
21223 .next
21224 .vindex "&$address_pipe$&"
21225 A router redirects an address directly to a pipe command (for example, from an
21226 alias or forward file). In this case, &$address_pipe$& contains the text of the
21227 pipe command, and the &%command%& option on the transport is ignored. If only
21228 one address is being transported (&%batch_max%& is not greater than one, or
21229 only one address was redirected to this pipe command), &$local_part$& contains
21230 the local part that was redirected.
21231 .endlist
21232
21233
21234 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21235 deliver messages over pipes using the LMTP interactive protocol. This is
21236 implemented by the &(lmtp)& transport.
21237
21238 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21239 &_.forward_& file, the command runs under the uid and gid of that user. In
21240 other cases, the uid and gid have to be specified explicitly, either on the
21241 transport or on the router that handles the address. Current and &"home"&
21242 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21243 details of the local delivery environment and chapter &<<CHAPbatching>>&
21244 for a discussion of local delivery batching.
21245
21246
21247 .section "Concurrent delivery" "SECID140"
21248 If two messages arrive at almost the same time, and both are routed to a pipe
21249 delivery, the two pipe transports may be run concurrently. You must ensure that
21250 any pipe commands you set up are robust against this happening. If the commands
21251 write to a file, the &%exim_lock%& utility might be of use.
21252
21253
21254
21255
21256 .section "Returned status and data" "SECID141"
21257 .cindex "&(pipe)& transport" "returned data"
21258 If the command exits with a non-zero return code, the delivery is deemed to
21259 have failed, unless either the &%ignore_status%& option is set (in which case
21260 the return code is treated as zero), or the return code is one of those listed
21261 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21262 later"&. In this case, delivery is deferred. Details of a permanent failure are
21263 logged, but are not included in the bounce message, which merely contains
21264 &"local delivery failed"&.
21265
21266 If the command exits on a signal and the &%freeze_signal%& option is set then
21267 the message will be frozen in the queue. If that option is not set, a bounce
21268 will be sent as normal.
21269
21270 If the return code is greater than 128 and the command being run is a shell
21271 script, it normally means that the script was terminated by a signal whose
21272 value is the return code minus 128. The &%freeze_signal%& option does not
21273 apply in this case.
21274
21275 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21276 return code is set to 127. This is the value that a shell returns if it is
21277 asked to run a non-existent command. The wording for the log line suggests that
21278 a non-existent command may be the problem.
21279
21280 The &%return_output%& option can affect the result of a pipe delivery. If it is
21281 set and the command produces any output on its standard output or standard
21282 error streams, the command is considered to have failed, even if it gave a zero
21283 return code or if &%ignore_status%& is set. The output from the command is
21284 included as part of the bounce message. The &%return_fail_output%& option is
21285 similar, except that output is returned only when the command exits with a
21286 failure return code, that is, a value other than zero or a code that matches
21287 &%temp_errors%&.
21288
21289
21290
21291 .section "How the command is run" "SECThowcommandrun"
21292 .cindex "&(pipe)& transport" "path for command"
21293 The command line is (by default) broken down into a command name and arguments
21294 by the &(pipe)& transport itself. The &%allow_commands%& and
21295 &%restrict_to_path%& options can be used to restrict the commands that may be
21296 run.
21297
21298 .cindex "quoting" "in pipe command"
21299 Unquoted arguments are delimited by white space. If an argument appears in
21300 double quotes, backslash is interpreted as an escape character in the usual
21301 way. If an argument appears in single quotes, no escaping is done.
21302
21303 String expansion is applied to the command line except when it comes from a
21304 traditional &_.forward_& file (commands from a filter file are expanded). The
21305 expansion is applied to each argument in turn rather than to the whole line.
21306 For this reason, any string expansion item that contains white space must be
21307 quoted so as to be contained within a single argument. A setting such as
21308 .code
21309 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21310 .endd
21311 will not work, because the expansion item gets split between several
21312 arguments. You have to write
21313 .code
21314 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21315 .endd
21316 to ensure that it is all in one argument. The expansion is done in this way,
21317 argument by argument, so that the number of arguments cannot be changed as a
21318 result of expansion, and quotes or backslashes in inserted variables do not
21319 interact with external quoting. However, this leads to problems if you want to
21320 generate multiple arguments (or the command name plus arguments) from a single
21321 expansion. In this situation, the simplest solution is to use a shell. For
21322 example:
21323 .code
21324 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21325 .endd
21326
21327 .cindex "transport" "filter"
21328 .cindex "filter" "transport filter"
21329 .vindex "&$pipe_addresses$&"
21330 Special handling takes place when an argument consists of precisely the text
21331 &`$pipe_addresses`&. This is not a general expansion variable; the only
21332 place this string is recognized is when it appears as an argument for a pipe or
21333 transport filter command. It causes each address that is being handled to be
21334 inserted in the argument list at that point &'as a separate argument'&. This
21335 avoids any problems with spaces or shell metacharacters, and is of use when a
21336 &(pipe)& transport is handling groups of addresses in a batch.
21337
21338 After splitting up into arguments and expansion, the resulting command is run
21339 in a subprocess directly from the transport, &'not'& under a shell. The
21340 message that is being delivered is supplied on the standard input, and the
21341 standard output and standard error are both connected to a single pipe that is
21342 read by Exim. The &%max_output%& option controls how much output the command
21343 may produce, and the &%return_output%& and &%return_fail_output%& options
21344 control what is done with it.
21345
21346 Not running the command under a shell (by default) lessens the security risks
21347 in cases when a command from a user's filter file is built out of data that was
21348 taken from an incoming message. If a shell is required, it can of course be
21349 explicitly specified as the command to be run. However, there are circumstances
21350 where existing commands (for example, in &_.forward_& files) expect to be run
21351 under a shell and cannot easily be modified. To allow for these cases, there is
21352 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21353 works. Instead of breaking up the command line as just described, it expands it
21354 as a single string and passes the result to &_/bin/sh_&. The
21355 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21356 with &%use_shell%&, and the whole mechanism is inherently less secure.
21357
21358
21359
21360 .section "Environment variables" "SECTpipeenv"
21361 .cindex "&(pipe)& transport" "environment for command"
21362 .cindex "environment for pipe transport"
21363 The environment variables listed below are set up when the command is invoked.
21364 This list is a compromise for maximum compatibility with other MTAs. Note that
21365 the &%environment%& option can be used to add additional variables to this
21366 environment.
21367 .display
21368 &`DOMAIN            `&   the domain of the address
21369 &`HOME              `&   the home directory, if set
21370 &`HOST              `&   the host name when called from a router (see below)
21371 &`LOCAL_PART        `&   see below
21372 &`LOCAL_PART_PREFIX `&   see below
21373 &`LOCAL_PART_SUFFIX `&   see below
21374 &`LOGNAME           `&   see below
21375 &`MESSAGE_ID        `&   Exim's local ID for the message
21376 &`PATH              `&   as specified by the &%path%& option below
21377 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21378 &`RECIPIENT         `&   the complete recipient address
21379 &`SENDER            `&   the sender of the message (empty if a bounce)
21380 &`SHELL             `&   &`/bin/sh`&
21381 &`TZ                `&   the value of the &%timezone%& option, if set
21382 &`USER              `&   see below
21383 .endd
21384 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21385 router, LOCAL_PART is set to the local part of the address. When it is
21386 called as a result of a forward or alias expansion, LOCAL_PART is set to
21387 the local part of the address that was expanded. In both cases, any affixes are
21388 removed from the local part, and made available in LOCAL_PART_PREFIX and
21389 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21390 same value as LOCAL_PART for compatibility with other MTAs.
21391
21392 .cindex "HOST"
21393 HOST is set only when a &(pipe)& transport is called from a router that
21394 associates hosts with an address, typically when using &(pipe)& as a
21395 pseudo-remote transport. HOST is set to the first host name specified by
21396 the router.
21397
21398 .cindex "HOME"
21399 If the transport's generic &%home_directory%& option is set, its value is used
21400 for the HOME environment variable. Otherwise, a home directory may be set
21401 by the router's &%transport_home_directory%& option, which defaults to the
21402 user's home directory if &%check_local_user%& is set.
21403
21404
21405 .section "Private options for pipe" "SECID142"
21406 .cindex "options" "&(pipe)& transport"
21407
21408
21409
21410 .option allow_commands pipe "string list&!!" unset
21411 .cindex "&(pipe)& transport" "permitted commands"
21412 The string is expanded, and is then interpreted as a colon-separated list of
21413 permitted commands. If &%restrict_to_path%& is not set, the only commands
21414 permitted are those in the &%allow_commands%& list. They need not be absolute
21415 paths; the &%path%& option is still used for relative paths. If
21416 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21417 in the &%allow_commands%& list, or a name without any slashes that is found on
21418 the path. In other words, if neither &%allow_commands%& nor
21419 &%restrict_to_path%& is set, there is no restriction on the command, but
21420 otherwise only commands that are permitted by one or the other are allowed. For
21421 example, if
21422 .code
21423 allow_commands = /usr/bin/vacation
21424 .endd
21425 and &%restrict_to_path%& is not set, the only permitted command is
21426 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21427 &%use_shell%& is set.
21428
21429
21430 .option batch_id pipe string&!! unset
21431 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21432
21433
21434 .option batch_max pipe integer 1
21435 This limits the number of addresses that can be handled in a single delivery.
21436 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21437
21438
21439 .option check_string pipe string unset
21440 As &(pipe)& writes the message, the start of each line is tested for matching
21441 &%check_string%&, and if it does, the initial matching characters are replaced
21442 by the contents of &%escape_string%&, provided both are set. The value of
21443 &%check_string%& is a literal string, not a regular expression, and the case of
21444 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21445 of &%check_string%& and &%escape_string%& are forced to values that implement
21446 the SMTP escaping protocol. Any settings made in the configuration file are
21447 ignored.
21448
21449
21450 .option command pipe string&!! unset
21451 This option need not be set when &(pipe)& is being used to deliver to pipes
21452 obtained directly from address redirections. In other cases, the option must be
21453 set, to provide a command to be run. It need not yield an absolute path (see
21454 the &%path%& option below). The command is split up into separate arguments by
21455 Exim, and each argument is separately expanded, as described in section
21456 &<<SECThowcommandrun>>& above.
21457
21458
21459 .option environment pipe string&!! unset
21460 .cindex "&(pipe)& transport" "environment for command"
21461 .cindex "environment for &(pipe)& transport"
21462 This option is used to add additional variables to the environment in which the
21463 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21464 a string which is expanded, and then interpreted as a colon-separated list of
21465 environment settings of the form <&'name'&>=<&'value'&>.
21466
21467
21468 .option escape_string pipe string unset
21469 See &%check_string%& above.
21470
21471
21472 .option freeze_exec_fail pipe boolean false
21473 .cindex "exec failure"
21474 .cindex "failure of exec"
21475 .cindex "&(pipe)& transport" "failure of exec"
21476 Failure to exec the command in a pipe transport is by default treated like
21477 any other failure while running the command. However, if &%freeze_exec_fail%&
21478 is set, failure to exec is treated specially, and causes the message to be
21479 frozen, whatever the setting of &%ignore_status%&.
21480
21481
21482 .option freeze_signal pipe boolean false
21483 .cindex "signal exit"
21484 .cindex "&(pipe)& transport", "signal exit"
21485 Normally if the process run by a command in a pipe transport exits on a signal,
21486 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21487 frozen in Exim's queue instead.
21488
21489
21490 .option ignore_status pipe boolean false
21491 If this option is true, the status returned by the subprocess that is set up to
21492 run the command is ignored, and Exim behaves as if zero had been returned.
21493 Otherwise, a non-zero status or termination by signal causes an error return
21494 from the transport unless the status value is one of those listed in
21495 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21496
21497 &*Note*&: This option does not apply to timeouts, which do not return a status.
21498 See the &%timeout_defer%& option for how timeouts are handled.
21499
21500 .option log_defer_output pipe boolean false
21501 .cindex "&(pipe)& transport" "logging output"
21502 If this option is set, and the status returned by the command is
21503 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21504 and any output was produced, the first line of it is written to the main log.
21505
21506
21507 .option log_fail_output pipe boolean false
21508 If this option is set, and the command returns any output, and also ends with a
21509 return code that is neither zero nor one of the return codes listed in
21510 &%temp_errors%& (that is, the delivery failed), the first line of output is
21511 written to the main log. This option and &%log_output%& are mutually exclusive.
21512 Only one of them may be set.
21513
21514
21515
21516 .option log_output pipe boolean false
21517 If this option is set and the command returns any output, the first line of
21518 output is written to the main log, whatever the return code. This option and
21519 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21520
21521
21522
21523 .option max_output pipe integer 20K
21524 This specifies the maximum amount of output that the command may produce on its
21525 standard output and standard error file combined. If the limit is exceeded, the
21526 process running the command is killed. This is intended as a safety measure to
21527 catch runaway processes. The limit is applied independently of the settings of
21528 the options that control what is done with such output (for example,
21529 &%return_output%&). Because of buffering effects, the amount of output may
21530 exceed the limit by a small amount before Exim notices.
21531
21532
21533 .option message_prefix pipe string&!! "see below"
21534 The string specified here is expanded and output at the start of every message.
21535 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21536 .code
21537 message_prefix = \
21538   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21539   ${tod_bsdinbox}\n
21540 .endd
21541 .cindex "Cyrus"
21542 .cindex "&%tmail%&"
21543 .cindex "&""From""& line"
21544 This is required by the commonly used &_/usr/bin/vacation_& program.
21545 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21546 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21547 setting
21548 .code
21549 message_prefix =
21550 .endd
21551 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21552 &`\n`& to &`\r\n`& in &%message_prefix%&.
21553
21554
21555 .option message_suffix pipe string&!! "see below"
21556 The string specified here is expanded and output at the end of every message.
21557 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21558 The suffix can be suppressed by setting
21559 .code
21560 message_suffix =
21561 .endd
21562 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21563 &`\n`& to &`\r\n`& in &%message_suffix%&.
21564
21565
21566 .option path pipe string "see below"
21567 This option specifies the string that is set up in the PATH environment
21568 variable of the subprocess. The default is:
21569 .code
21570 /bin:/usr/bin
21571 .endd
21572 If the &%command%& option does not yield an absolute path name, the command is
21573 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21574 apply to a command specified as a transport filter.
21575
21576
21577 .option permit_coredump pipe boolean false
21578 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21579 a core-dump of a pipe command, enable this command.  This enables core-dumps
21580 during delivery and affects both the Exim binary and the pipe command run.
21581 It is recommended that this option remain off unless and until you have a need
21582 for it and that this only be enabled when needed, as the risk of excessive
21583 resource consumption can be quite high.  Note also that Exim is typically
21584 installed as a setuid binary and most operating systems will inhibit coredumps
21585 of these by default, so further OS-specific action may be required.
21586
21587
21588 .option pipe_as_creator pipe boolean false
21589 .cindex "uid (user id)" "local delivery"
21590 If the generic &%user%& option is not set and this option is true, the delivery
21591 process is run under the uid that was in force when Exim was originally called
21592 to accept the message. If the group id is not otherwise set (via the generic
21593 &%group%& option), the gid that was in force when Exim was originally called to
21594 accept the message is used.
21595
21596
21597 .option restrict_to_path pipe boolean false
21598 When this option is set, any command name not listed in &%allow_commands%& must
21599 contain no slashes. The command is searched for only in the directories listed
21600 in the &%path%& option. This option is intended for use in the case when a pipe
21601 command has been generated from a user's &_.forward_& file. This is usually
21602 handled by a &(pipe)& transport called &%address_pipe%&.
21603
21604
21605 .option return_fail_output pipe boolean false
21606 If this option is true, and the command produced any output and ended with a
21607 return code other than zero or one of the codes listed in &%temp_errors%& (that
21608 is, the delivery failed), the output is returned in the bounce message.
21609 However, if the message has a null sender (that is, it is itself a bounce
21610 message), output from the command is discarded. This option and
21611 &%return_output%& are mutually exclusive. Only one of them may be set.
21612
21613
21614
21615 .option return_output pipe boolean false
21616 If this option is true, and the command produced any output, the delivery is
21617 deemed to have failed whatever the return code from the command, and the output
21618 is returned in the bounce message. Otherwise, the output is just discarded.
21619 However, if the message has a null sender (that is, it is a bounce message),
21620 output from the command is always discarded, whatever the setting of this
21621 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21622 of them may be set.
21623
21624
21625
21626 .option temp_errors pipe "string list" "see below"
21627 .cindex "&(pipe)& transport" "temporary failure"
21628 This option contains either a colon-separated list of numbers, or a single
21629 asterisk. If &%ignore_status%& is false
21630 and &%return_output%& is not set,
21631 and the command exits with a non-zero return code, the failure is treated as
21632 temporary and the delivery is deferred if the return code matches one of the
21633 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21634 codes are treated as permanent errors. The default setting contains the codes
21635 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21636 compiled on a system that does not define these macros, it assumes values of 75
21637 and 73, respectively.
21638
21639
21640 .option timeout pipe time 1h
21641 If the command fails to complete within this time, it is killed. This normally
21642 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21643 specifies no timeout. In order to ensure that any subprocesses created by the
21644 command are also killed, Exim makes the initial process a process group leader,
21645 and kills the whole process group on a timeout. However, this can be defeated
21646 if one of the processes starts a new process group.
21647
21648 .option timeout_defer pipe boolean false
21649 A timeout in a &(pipe)& transport, either in the command that the transport
21650 runs, or in a transport filter that is associated with it, is by default
21651 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21652 is set true, both kinds of timeout become temporary errors, causing the
21653 delivery to be deferred.
21654
21655 .option umask pipe "octal integer" 022
21656 This specifies the umask setting for the subprocess that runs the command.
21657
21658
21659 .option use_bsmtp pipe boolean false
21660 .cindex "envelope sender"
21661 If this option is set true, the &(pipe)& transport writes messages in &"batch
21662 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21663 commands. If you want to include a leading HELO command with such messages,
21664 you can do so by setting the &%message_prefix%& option. See section
21665 &<<SECTbatchSMTP>>& for details of batch SMTP.
21666
21667 .option use_classresources pipe boolean false
21668 .cindex "class resources (BSD)"
21669 This option is available only when Exim is running on FreeBSD, NetBSD, or
21670 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21671 resource limits when a &(pipe)& transport is run to perform a delivery. The
21672 limits for the uid under which the pipe is to run are obtained from the login
21673 class database.
21674
21675
21676 .option use_crlf pipe boolean false
21677 .cindex "carriage return"
21678 .cindex "linefeed"
21679 This option causes lines to be terminated with the two-character CRLF sequence
21680 (carriage return, linefeed) instead of just a linefeed character. In the case
21681 of batched SMTP, the byte sequence written to the pipe is then an exact image
21682 of what would be sent down a real SMTP connection.
21683
21684 The contents of the &%message_prefix%& and &%message_suffix%& options are
21685 written verbatim, so must contain their own carriage return characters if these
21686 are needed. When &%use_bsmtp%& is not set, the default values for both
21687 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21688 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21689
21690
21691 .option use_shell pipe boolean false
21692 .vindex "&$pipe_addresses$&"
21693 If this option is set, it causes the command to be passed to &_/bin/sh_&
21694 instead of being run directly from the transport, as described in section
21695 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21696 where the command is expected to be run under a shell and cannot easily be
21697 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21698 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21699 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21700 its &%-c%& option.
21701
21702
21703
21704 .section "Using an external local delivery agent" "SECID143"
21705 .cindex "local delivery" "using an external agent"
21706 .cindex "&'procmail'&"
21707 .cindex "external local delivery"
21708 .cindex "delivery" "&'procmail'&"
21709 .cindex "delivery" "by external agent"
21710 The &(pipe)& transport can be used to pass all messages that require local
21711 delivery to a separate local delivery agent such as &%procmail%&. When doing
21712 this, care must be taken to ensure that the pipe is run under an appropriate
21713 uid and gid. In some configurations one wants this to be a uid that is trusted
21714 by the delivery agent to supply the correct sender of the message. It may be
21715 necessary to recompile or reconfigure the delivery agent so that it trusts an
21716 appropriate user. The following is an example transport and router
21717 configuration for &%procmail%&:
21718 .code
21719 # transport
21720 procmail_pipe:
21721   driver = pipe
21722   command = /usr/local/bin/procmail -d $local_part
21723   return_path_add
21724   delivery_date_add
21725   envelope_to_add
21726   check_string = "From "
21727   escape_string = ">From "
21728   umask = 077
21729   user = $local_part
21730   group = mail
21731
21732 # router
21733 procmail:
21734   driver = accept
21735   check_local_user
21736   transport = procmail_pipe
21737 .endd
21738 In this example, the pipe is run as the local user, but with the group set to
21739 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21740 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21741 user to supply a correct sender address. If you do not specify either a
21742 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21743 home directory is the user's home directory by default.
21744
21745 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21746 .code
21747 IFS=" "
21748 .endd
21749 as shown in some &%procmail%& documentation, because Exim does not by default
21750 use a shell to run pipe commands.
21751
21752 .cindex "Cyrus"
21753 The next example shows a transport and a router for a system where local
21754 deliveries are handled by the Cyrus IMAP server.
21755 .code
21756 # transport
21757 local_delivery_cyrus:
21758   driver = pipe
21759   command = /usr/cyrus/bin/deliver \
21760             -m ${substr_1:$local_part_suffix} -- $local_part
21761   user = cyrus
21762   group = mail
21763   return_output
21764   log_output
21765   message_prefix =
21766   message_suffix =
21767
21768 # router
21769 local_user_cyrus:
21770   driver = accept
21771   check_local_user
21772   local_part_suffix = .*
21773   transport = local_delivery_cyrus
21774 .endd
21775 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21776 &%return_output%& to cause any text written by Cyrus to be returned to the
21777 sender.
21778 .ecindex IIDpiptra1
21779 .ecindex IIDpiptra2
21780
21781
21782 . ////////////////////////////////////////////////////////////////////////////
21783 . ////////////////////////////////////////////////////////////////////////////
21784
21785 .chapter "The smtp transport" "CHAPsmtptrans"
21786 .scindex IIDsmttra1 "transports" "&(smtp)&"
21787 .scindex IIDsmttra2 "&(smtp)& transport"
21788 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21789 or LMTP protocol. The list of hosts to try can either be taken from the address
21790 that is being processed (having been set up by the router), or specified
21791 explicitly for the transport. Timeout and retry processing (see chapter
21792 &<<CHAPretry>>&) is applied to each IP address independently.
21793
21794
21795 .section "Multiple messages on a single connection" "SECID144"
21796 The sending of multiple messages over a single TCP/IP connection can arise in
21797 two ways:
21798
21799 .ilist
21800 If a message contains more than &%max_rcpt%& (see below) addresses that are
21801 routed to the same host, more than one copy of the message has to be sent to
21802 that host. In this situation, multiple copies may be sent in a single run of
21803 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21804 does when it has too many addresses to send in one message also depends on the
21805 value of the global &%remote_max_parallel%& option. Details are given in
21806 section &<<SECToutSMTPTCP>>&.)
21807 .next
21808 .cindex "hints database" "remembering routing"
21809 When a message has been successfully delivered over a TCP/IP connection, Exim
21810 looks in its hints database to see if there are any other messages awaiting a
21811 connection to the same host. If there are, a new delivery process is started
21812 for one of them, and the current TCP/IP connection is passed on to it. The new
21813 process may in turn send multiple copies and possibly create yet another
21814 process.
21815 .endlist
21816
21817
21818 For each copy sent over the same TCP/IP connection, a sequence counter is
21819 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21820 no further messages are sent over that connection.
21821
21822
21823
21824 .section "Use of the $host and $host_address variables" "SECID145"
21825 .vindex "&$host$&"
21826 .vindex "&$host_address$&"
21827 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21828 &$host_address$& are the name and IP address of the first host on the host list
21829 passed by the router. However, when the transport is about to connect to a
21830 specific host, and while it is connected to that host, &$host$& and
21831 &$host_address$& are set to the values for that host. These are the values
21832 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21833 &%serialize_hosts%&, and the various TLS options are expanded.
21834
21835
21836 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21837 .vindex &$tls_bits$&
21838 .vindex &$tls_cipher$&
21839 .vindex &$tls_peerdn$&
21840 .vindex &$tls_sni$&
21841 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
21842 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
21843 are the values that were set when the message was received.
21844 These are the values that are used for options that are expanded before any
21845 SMTP connections are made. Just before each connection is made, these four
21846 variables are emptied. If TLS is subsequently started, they are set to the
21847 appropriate values for the outgoing connection, and these are the values that
21848 are in force when any authenticators are run and when the
21849 &%authenticated_sender%& option is expanded.
21850
21851
21852 .section "Private options for smtp" "SECID146"
21853 .cindex "options" "&(smtp)& transport"
21854 The private options of the &(smtp)& transport are as follows:
21855
21856
21857 .option address_retry_include_sender smtp boolean true
21858 .cindex "4&'xx'& responses" "retrying after"
21859 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21860 is the combination of sender and recipient that is delayed in subsequent queue
21861 runs until the retry time is reached. You can delay the recipient without
21862 reference to the sender (which is what earlier versions of Exim did), by
21863 setting &%address_retry_include_sender%& false. However, this can lead to
21864 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21865
21866 .option allow_localhost smtp boolean false
21867 .cindex "local host" "sending to"
21868 .cindex "fallback" "hosts specified on transport"
21869 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21870 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21871 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21872 the delivery anyway. This should be used only in special cases when the
21873 configuration ensures that no looping will result (for example, a differently
21874 configured Exim is listening on the port to which the message is sent).
21875
21876
21877 .option authenticated_sender smtp string&!! unset
21878 .cindex "Cyrus"
21879 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21880 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21881 overriding any existing authenticated sender value. If the string expansion is
21882 forced to fail, the option is ignored. Other expansion failures cause delivery
21883 to be deferred. If the result of expansion is an empty string, that is also
21884 ignored.
21885
21886 The expansion happens after the outgoing connection has been made and TLS
21887 started, if required. This means that the &$host$&, &$host_address$&,
21888 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21889 particular connection.
21890
21891 If the SMTP session is not authenticated, the expansion of
21892 &%authenticated_sender%& still happens (and can cause the delivery to be
21893 deferred if it fails), but no AUTH= item is added to MAIL commands
21894 unless &%authenticated_sender_force%& is true.
21895
21896 This option allows you to use the &(smtp)& transport in LMTP mode to
21897 deliver mail to Cyrus IMAP and provide the proper local part as the
21898 &"authenticated sender"&, via a setting such as:
21899 .code
21900 authenticated_sender = $local_part
21901 .endd
21902 This removes the need for IMAP subfolders to be assigned special ACLs to
21903 allow direct delivery to those subfolders.
21904
21905 Because of expected uses such as that just described for Cyrus (when no
21906 domain is involved), there is no checking on the syntax of the provided
21907 value.
21908
21909
21910 .option authenticated_sender_force smtp boolean false
21911 If this option is set true, the &%authenticated_sender%& option's value
21912 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21913 authenticated as a client.
21914
21915
21916 .option command_timeout smtp time 5m
21917 This sets a timeout for receiving a response to an SMTP command that has been
21918 sent out. It is also used when waiting for the initial banner line from the
21919 remote host. Its value must not be zero.
21920
21921
21922 .option connect_timeout smtp time 5m
21923 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21924 to a remote host. A setting of zero allows the system timeout (typically
21925 several minutes) to act. To have any effect, the value of this option must be
21926 less than the system timeout. However, it has been observed that on some
21927 systems there is no system timeout, which is why the default value for this
21928 option is 5 minutes, a value recommended by RFC 1123.
21929
21930
21931 .option connection_max_messages smtp integer 500
21932 .cindex "SMTP" "passed connection"
21933 .cindex "SMTP" "multiple deliveries"
21934 .cindex "multiple SMTP deliveries"
21935 This controls the maximum number of separate message deliveries that are sent
21936 over a single TCP/IP connection. If the value is zero, there is no limit.
21937 For testing purposes, this value can be overridden by the &%-oB%& command line
21938 option.
21939
21940
21941 .option data_timeout smtp time 5m
21942 This sets a timeout for the transmission of each block in the data portion of
21943 the message. As a result, the overall timeout for a message depends on the size
21944 of the message. Its value must not be zero. See also &%final_timeout%&.
21945
21946
21947 .option delay_after_cutoff smtp boolean true
21948 This option controls what happens when all remote IP addresses for a given
21949 domain have been inaccessible for so long that they have passed their retry
21950 cutoff times.
21951
21952 In the default state, if the next retry time has not been reached for any of
21953 them, the address is bounced without trying any deliveries. In other words,
21954 Exim delays retrying an IP address after the final cutoff time until a new
21955 retry time is reached, and can therefore bounce an address without ever trying
21956 a delivery, when machines have been down for a long time. Some people are
21957 unhappy at this prospect, so...
21958
21959 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
21960 addresses are past their final cutoff time, Exim tries to deliver to those
21961 IP addresses that have not been tried since the message arrived. If there are
21962 none, of if they all fail, the address is bounced. In other words, it does not
21963 delay when a new message arrives, but immediately tries those expired IP
21964 addresses that haven't been tried since the message arrived. If there is a
21965 continuous stream of messages for the dead hosts, unsetting
21966 &%delay_after_cutoff%& means that there will be many more attempts to deliver
21967 to them.
21968
21969
21970 .option dns_qualify_single smtp boolean true
21971 If the &%hosts%& or &%fallback_hosts%& option is being used,
21972 and the &%gethostbyname%& option is false,
21973 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
21974 in chapter &<<CHAPdnslookup>>& for more details.
21975
21976
21977 .option dns_search_parents smtp boolean false
21978 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
21979 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
21980 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
21981 details.
21982
21983
21984
21985 .option fallback_hosts smtp "string list" unset
21986 .cindex "fallback" "hosts specified on transport"
21987 String expansion is not applied to this option. The argument must be a
21988 colon-separated list of host names or IP addresses, optionally also including
21989 port numbers, though the separator can be changed, as described in section
21990 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21991 item in a &%route_list%& setting for the &(manualroute)& router, as described
21992 in section &<<SECTformatonehostitem>>&.
21993
21994 Fallback hosts can also be specified on routers, which associate them with the
21995 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
21996 &%fallback_hosts%& specified on the transport is used only if the address does
21997 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
21998 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
21999 However, &%hosts_randomize%& does apply to fallback host lists.
22000
22001 If Exim is unable to deliver to any of the hosts for a particular address, and
22002 the errors are not permanent rejections, the address is put on a separate
22003 transport queue with its host list replaced by the fallback hosts, unless the
22004 address was routed via MX records and the current host was in the original MX
22005 list. In that situation, the fallback host list is not used.
22006
22007 Once normal deliveries are complete, the fallback queue is delivered by
22008 re-running the same transports with the new host lists. If several failing
22009 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22010 copy of the message is sent.
22011
22012 The resolution of the host names on the fallback list is controlled by the
22013 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22014 both to cases when the host list comes with the address and when it is taken
22015 from &%hosts%&. This option provides a &"use a smart host only if delivery
22016 fails"& facility.
22017
22018
22019 .option final_timeout smtp time 10m
22020 This is the timeout that applies while waiting for the response to the final
22021 line containing just &"."& that terminates a message. Its value must not be
22022 zero.
22023
22024 .option gethostbyname smtp boolean false
22025 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22026 being used, names are looked up using &[gethostbyname()]&
22027 (or &[getipnodebyname()]& when available)
22028 instead of using the DNS. Of course, that function may in fact use the DNS, but
22029 it may also consult other sources of information such as &_/etc/hosts_&.
22030
22031 .option gnutls_compat_mode smtp boolean unset
22032 This option controls whether GnuTLS is used in compatibility mode in an Exim
22033 server. This reduces security slightly, but improves interworking with older
22034 implementations of TLS.
22035
22036 .option helo_data smtp string&!! "see below"
22037 .cindex "HELO" "argument, setting"
22038 .cindex "EHLO" "argument, setting"
22039 .cindex "LHLO argument setting"
22040 The value of this option is expanded after a connection to a another host has
22041 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22042 command that starts the outgoing SMTP or LMTP session. The default value of the
22043 option is:
22044 .code
22045 $primary_hostname
22046 .endd
22047 During the expansion, the variables &$host$& and &$host_address$& are set to
22048 the identity of the remote host, and the variables &$sending_ip_address$& and
22049 &$sending_port$& are set to the local IP address and port number that are being
22050 used. These variables can be used to generate different values for different
22051 servers or different local IP addresses. For example, if you want the string
22052 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22053 interface address, you could use this:
22054 .code
22055 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22056   {$primary_hostname}}
22057 .endd
22058 The use of &%helo_data%& applies both to sending messages and when doing
22059 callouts.
22060
22061 .option hosts smtp "string list&!!" unset
22062 Hosts are associated with an address by a router such as &(dnslookup)&, which
22063 finds the hosts by looking up the address domain in the DNS, or by
22064 &(manualroute)&, which has lists of hosts in its configuration. However,
22065 email addresses can be passed to the &(smtp)& transport by any router, and not
22066 all of them can provide an associated list of hosts.
22067
22068 The &%hosts%& option specifies a list of hosts to be used if the address being
22069 processed does not have any hosts associated with it. The hosts specified by
22070 &%hosts%& are also used, whether or not the address has its own hosts, if
22071 &%hosts_override%& is set.
22072
22073 The string is first expanded, before being interpreted as a colon-separated
22074 list of host names or IP addresses, possibly including port numbers. The
22075 separator may be changed to something other than colon, as described in section
22076 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22077 item in a &%route_list%& setting for the &(manualroute)& router, as described
22078 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22079 of the &(manualroute)& router is not available here.
22080
22081 If the expansion fails, delivery is deferred. Unless the failure was caused by
22082 the inability to complete a lookup, the error is logged to the panic log as
22083 well as the main log. Host names are looked up either by searching directly for
22084 address records in the DNS or by calling &[gethostbyname()]& (or
22085 &[getipnodebyname()]& when available), depending on the setting of the
22086 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22087 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22088 address are used.
22089
22090 During delivery, the hosts are tried in order, subject to their retry status,
22091 unless &%hosts_randomize%& is set.
22092
22093
22094 .option hosts_avoid_esmtp smtp "host list&!!" unset
22095 .cindex "ESMTP, avoiding use of"
22096 .cindex "HELO" "forcing use of"
22097 .cindex "EHLO" "avoiding use of"
22098 .cindex "PIPELINING" "avoiding the use of"
22099 This option is for use with broken hosts that announce ESMTP facilities (for
22100 example, PIPELINING) and then fail to implement them properly. When a host
22101 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22102 start of the SMTP session. This means that it cannot use any of the ESMTP
22103 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22104
22105
22106 .option hosts_avoid_pipelining smtp "host list&!!" unset
22107 .cindex "PIPELINING" "avoiding the use of"
22108 Exim will not use the SMTP PIPELINING extension when delivering to any host
22109 that matches this list, even if the server host advertises PIPELINING support.
22110
22111
22112 .option hosts_avoid_tls smtp "host list&!!" unset
22113 .cindex "TLS" "avoiding for certain hosts"
22114 Exim will not try to start a TLS session when delivering to any host that
22115 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22116
22117
22118 .option hosts_max_try smtp integer 5
22119 .cindex "host" "maximum number to try"
22120 .cindex "limit" "number of hosts tried"
22121 .cindex "limit" "number of MX tried"
22122 .cindex "MX record" "maximum tried"
22123 This option limits the number of IP addresses that are tried for any one
22124 delivery in cases where there are temporary delivery errors. Section
22125 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22126
22127
22128 .option hosts_max_try_hardlimit smtp integer 50
22129 This is an additional check on the maximum number of IP addresses that Exim
22130 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22131 why it exists.
22132
22133
22134
22135 .option hosts_nopass_tls smtp "host list&!!" unset
22136 .cindex "TLS" "passing connection"
22137 .cindex "multiple SMTP deliveries"
22138 .cindex "TLS" "multiple message deliveries"
22139 For any host that matches this list, a connection on which a TLS session has
22140 been started will not be passed to a new delivery process for sending another
22141 message on the same connection. See section &<<SECTmulmessam>>& for an
22142 explanation of when this might be needed.
22143
22144
22145 .option hosts_override smtp boolean false
22146 If this option is set and the &%hosts%& option is also set, any hosts that are
22147 attached to the address are ignored, and instead the hosts specified by the
22148 &%hosts%& option are always used. This option does not apply to
22149 &%fallback_hosts%&.
22150
22151
22152 .option hosts_randomize smtp boolean false
22153 .cindex "randomized host list"
22154 .cindex "host" "list of; randomized"
22155 .cindex "fallback" "randomized hosts"
22156 If this option is set, and either the list of hosts is taken from the
22157 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22158 were not obtained from MX records (this includes fallback hosts from the
22159 router), and were not randomized by the router, the order of trying the hosts
22160 is randomized each time the transport runs. Randomizing the order of a host
22161 list can be used to do crude load sharing.
22162
22163 When &%hosts_randomize%& is true, a host list may be split into groups whose
22164 order is separately randomized. This makes it possible to set up MX-like
22165 behaviour. The boundaries between groups are indicated by an item that is just
22166 &`+`& in the host list. For example:
22167 .code
22168 hosts = host1:host2:host3:+:host4:host5
22169 .endd
22170 The order of the first three hosts and the order of the last two hosts is
22171 randomized for each use, but the first three always end up before the last two.
22172 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22173
22174 .option hosts_require_auth smtp "host list&!!" unset
22175 .cindex "authentication" "required by client"
22176 This option provides a list of servers for which authentication must succeed
22177 before Exim will try to transfer a message. If authentication fails for
22178 servers which are not in this list, Exim tries to send unauthenticated. If
22179 authentication fails for one of these servers, delivery is deferred. This
22180 temporary error is detectable in the retry rules, so it can be turned into a
22181 hard failure if required. See also &%hosts_try_auth%&, and chapter
22182 &<<CHAPSMTPAUTH>>& for details of authentication.
22183
22184
22185 .option hosts_require_tls smtp "host list&!!" unset
22186 .cindex "TLS" "requiring for certain servers"
22187 Exim will insist on using a TLS session when delivering to any host that
22188 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22189 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22190 incoming messages, use an appropriate ACL.
22191
22192 .option hosts_try_auth smtp "host list&!!" unset
22193 .cindex "authentication" "optional in client"
22194 This option provides a list of servers to which, provided they announce
22195 authentication support, Exim will attempt to authenticate as a client when it
22196 connects. If authentication fails, Exim will try to transfer the message
22197 unauthenticated. See also &%hosts_require_auth%&, and chapter
22198 &<<CHAPSMTPAUTH>>& for details of authentication.
22199
22200 .option interface smtp "string list&!!" unset
22201 .cindex "bind IP address"
22202 .cindex "IP address" "binding"
22203 .vindex "&$host$&"
22204 .vindex "&$host_address$&"
22205 This option specifies which interface to bind to when making an outgoing SMTP
22206 call. The value is an IP address, not an interface name such as
22207 &`eth0`&. Do not confuse this with the interface address that was used when a
22208 message was received, which is in &$received_ip_address$&, formerly known as
22209 &$interface_address$&. The name was changed to minimize confusion with the
22210 outgoing interface address. There is no variable that contains an outgoing
22211 interface address because, unless it is set by this option, its value is
22212 unknown.
22213
22214 During the expansion of the &%interface%& option the variables &$host$& and
22215 &$host_address$& refer to the host to which a connection is about to be made
22216 during the expansion of the string. Forced expansion failure, or an empty
22217 string result causes the option to be ignored. Otherwise, after expansion, the
22218 string must be a list of IP addresses, colon-separated by default, but the
22219 separator can be changed in the usual way. For example:
22220 .code
22221 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22222 .endd
22223 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22224 connection. If none of them are the correct type, the option is ignored. If
22225 &%interface%& is not set, or is ignored, the system's IP functions choose which
22226 interface to use if the host has more than one.
22227
22228
22229 .option keepalive smtp boolean true
22230 .cindex "keepalive" "on outgoing connection"
22231 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22232 connections. When set, it causes the kernel to probe idle connections
22233 periodically, by sending packets with &"old"& sequence numbers. The other end
22234 of the connection should send a acknowledgment if the connection is still okay
22235 or a reset if the connection has been aborted. The reason for doing this is
22236 that it has the beneficial effect of freeing up certain types of connection
22237 that can get stuck when the remote host is disconnected without tidying up the
22238 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22239 unreachable hosts.
22240
22241
22242 .option lmtp_ignore_quota smtp boolean false
22243 .cindex "LMTP" "ignoring quota errors"
22244 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22245 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22246 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22247
22248 .option max_rcpt smtp integer 100
22249 .cindex "RCPT" "maximum number of outgoing"
22250 This option limits the number of RCPT commands that are sent in a single
22251 SMTP message transaction. Each set of addresses is treated independently, and
22252 so can cause parallel connections to the same host if &%remote_max_parallel%&
22253 permits this.
22254
22255
22256 .option multi_domain smtp boolean true
22257 .vindex "&$domain$&"
22258 When this option is set, the &(smtp)& transport can handle a number of
22259 addresses containing a mixture of different domains provided they all resolve
22260 to the same list of hosts. Turning the option off restricts the transport to
22261 handling only one domain at a time. This is useful if you want to use
22262 &$domain$& in an expansion for the transport, because it is set only when there
22263 is a single domain involved in a remote delivery.
22264
22265
22266 .option port smtp string&!! "see below"
22267 .cindex "port" "sending TCP/IP"
22268 .cindex "TCP/IP" "setting outgoing port"
22269 This option specifies the TCP/IP port on the server to which Exim connects.
22270 &*Note:*& Do not confuse this with the port that was used when a message was
22271 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22272 The name was changed to minimize confusion with the outgoing port. There is no
22273 variable that contains an outgoing port.
22274
22275 If the value of this option begins with a digit it is taken as a port number;
22276 otherwise it is looked up using &[getservbyname()]&. The default value is
22277 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22278 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22279 is deferred.
22280
22281
22282
22283 .option protocol smtp string smtp
22284 .cindex "LMTP" "over TCP/IP"
22285 .cindex "ssmtp protocol" "outbound"
22286 .cindex "TLS" "SSL-on-connect outbound"
22287 .vindex "&$port$&"
22288 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22289 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22290 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22291 deliveries into closed message stores. Exim also has support for running LMTP
22292 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22293
22294 .new
22295 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22296 changes to &"smtps"&, and the transport initiates TLS immediately after
22297 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22298 The Internet standards bodies strongly discourage use of this mode.
22299 .wen
22300
22301
22302 .option retry_include_ip_address smtp boolean true
22303 Exim normally includes both the host name and the IP address in the key it
22304 constructs for indexing retry data after a temporary delivery failure. This
22305 means that when one of several IP addresses for a host is failing, it gets
22306 tried periodically (controlled by the retry rules), but use of the other IP
22307 addresses is not affected.
22308
22309 However, in some dialup environments hosts are assigned a different IP address
22310 each time they connect. In this situation the use of the IP address as part of
22311 the retry key leads to undesirable behaviour. Setting this option false causes
22312 Exim to use only the host name. This should normally be done on a separate
22313 instance of the &(smtp)& transport, set up specially to handle the dialup
22314 hosts.
22315
22316
22317 .option serialize_hosts smtp "host list&!!" unset
22318 .cindex "serializing connections"
22319 .cindex "host" "serializing connections"
22320 Because Exim operates in a distributed manner, if several messages for the same
22321 host arrive at around the same time, more than one simultaneous connection to
22322 the remote host can occur. This is not usually a problem except when there is a
22323 slow link between the hosts. In that situation it may be helpful to restrict
22324 Exim to one connection at a time. This can be done by setting
22325 &%serialize_hosts%& to match the relevant hosts.
22326
22327 .cindex "hints database" "serializing deliveries to a host"
22328 Exim implements serialization by means of a hints database in which a record is
22329 written whenever a process connects to one of the restricted hosts. The record
22330 is deleted when the connection is completed. Obviously there is scope for
22331 records to get left lying around if there is a system or program crash. To
22332 guard against this, Exim ignores any records that are more than six hours old.
22333
22334 If you set up this kind of serialization, you should also arrange to delete the
22335 relevant hints database whenever your system reboots. The names of the files
22336 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22337 may be one or two files, depending on the type of DBM in use. The same files
22338 are used for ETRN serialization.
22339
22340
22341 .option size_addition smtp integer 1024
22342 .cindex "SMTP" "SIZE"
22343 .cindex "message" "size issue for transport filter"
22344 .cindex "size" "of message"
22345 .cindex "transport" "filter"
22346 .cindex "filter" "transport filter"
22347 If a remote SMTP server indicates that it supports the SIZE option of the
22348 MAIL command, Exim uses this to pass over the message size at the start of
22349 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22350 sends, to allow for headers and other text that may be added during delivery by
22351 configuration options or in a transport filter. It may be necessary to increase
22352 this if a lot of text is added to messages.
22353
22354 Alternatively, if the value of &%size_addition%& is set negative, it disables
22355 the use of the SIZE option altogether.
22356
22357
22358 .option tls_certificate smtp string&!! unset
22359 .cindex "TLS" "client certificate, location of"
22360 .cindex "certificate" "client, location of"
22361 .vindex "&$host$&"
22362 .vindex "&$host_address$&"
22363 The value of this option must be the absolute path to a file which contains the
22364 client's certificate, for possible use when sending a message over an encrypted
22365 connection. The values of &$host$& and &$host_address$& are set to the name and
22366 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22367 details of TLS.
22368
22369 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22370 certificate when sending messages as a client. The global option of the same
22371 name specifies the certificate for Exim as a server; it is not automatically
22372 assumed that the same certificate should be used when Exim is operating as a
22373 client.
22374
22375
22376 .option tls_crl smtp string&!! unset
22377 .cindex "TLS" "client certificate revocation list"
22378 .cindex "certificate" "revocation list for client"
22379 This option specifies a certificate revocation list. The expanded value must
22380 be the name of a file that contains a CRL in PEM format.
22381
22382
22383 .option tls_privatekey smtp string&!! unset
22384 .cindex "TLS" "client private key, location of"
22385 .vindex "&$host$&"
22386 .vindex "&$host_address$&"
22387 The value of this option must be the absolute path to a file which contains the
22388 client's private key. This is used when sending a message over an encrypted
22389 connection using a client certificate. The values of &$host$& and
22390 &$host_address$& are set to the name and address of the server during the
22391 expansion. If this option is unset, or the expansion is forced to fail, or the
22392 result is an empty string, the private key is assumed to be in the same file as
22393 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22394
22395
22396 .option tls_require_ciphers smtp string&!! unset
22397 .cindex "TLS" "requiring specific ciphers"
22398 .cindex "cipher" "requiring specific"
22399 .vindex "&$host$&"
22400 .vindex "&$host_address$&"
22401 The value of this option must be a list of permitted cipher suites, for use
22402 when setting up an outgoing encrypted connection. (There is a global option of
22403 the same name for controlling incoming connections.) The values of &$host$& and
22404 &$host_address$& are set to the name and address of the server during the
22405 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22406 is used in different ways by OpenSSL and GnuTLS (see sections
22407 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22408 ciphers is a preference order.
22409
22410
22411
22412 .new
22413 .option tls_sni smtp string&!! unset
22414 .cindex "TLS" "Server Name Indication"
22415 .vindex "&$tls_sni$&"
22416 If this option is set then it sets the $tls_sni variable and causes any
22417 TLS session to pass this value as the Server Name Indication extension to
22418 the remote side, which can be used by the remote side to select an appropriate
22419 certificate and private key for the session.
22420
22421 See &<<SECTtlssni>>& for more information.
22422
22423 OpenSSL only, also requiring a build of OpenSSL that supports TLS extensions.
22424 .wen
22425
22426
22427
22428 .option tls_tempfail_tryclear smtp boolean true
22429 .cindex "4&'xx'& responses" "to STARTTLS"
22430 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22431 setting up a TLS session, this option determines whether or not Exim should try
22432 to deliver the message unencrypted. If it is set false, delivery to the
22433 current host is deferred; if there are other hosts, they are tried. If this
22434 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22435 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22436 TLS negotiation fails, Exim closes the current connection (because it is in an
22437 unknown state), opens a new one to the same host, and then tries the delivery
22438 in clear.
22439
22440
22441 .option tls_verify_certificates smtp string&!! unset
22442 .cindex "TLS" "server certificate verification"
22443 .cindex "certificate" "verification of server"
22444 .vindex "&$host$&"
22445 .vindex "&$host_address$&"
22446 The value of this option must be the absolute path to a file containing
22447 permitted server certificates, for use when setting up an encrypted connection.
22448 Alternatively, if you are using OpenSSL, you can set
22449 &%tls_verify_certificates%& to the name of a directory containing certificate
22450 files. This does not work with GnuTLS; the option must be set to the name of a
22451 single file if you are using GnuTLS. The values of &$host$& and
22452 &$host_address$& are set to the name and address of the server during the
22453 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22454
22455
22456
22457
22458 .section "How the limits for the number of hosts to try are used" &&&
22459          "SECTvalhosmax"
22460 .cindex "host" "maximum number to try"
22461 .cindex "limit" "hosts; maximum number tried"
22462 There are two options that are concerned with the number of hosts that are
22463 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22464 &%hosts_max_try_hardlimit%&.
22465
22466
22467 The &%hosts_max_try%& option limits the number of hosts that are tried
22468 for a single delivery. However, despite the term &"host"& in its name, the
22469 option actually applies to each IP address independently. In other words, a
22470 multihomed host is treated as several independent hosts, just as it is for
22471 retrying.
22472
22473 Many of the larger ISPs have multiple MX records which often point to
22474 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22475 created as a result of routing one of these domains.
22476
22477 Trying every single IP address on such a long list does not seem sensible; if
22478 several at the top of the list fail, it is reasonable to assume there is some
22479 problem that is likely to affect all of them. Roughly speaking, the value of
22480 &%hosts_max_try%& is the maximum number that are tried before deferring the
22481 delivery. However, the logic cannot be quite that simple.
22482
22483 Firstly, IP addresses that are skipped because their retry times have not
22484 arrived do not count, and in addition, addresses that are past their retry
22485 limits are also not counted, even when they are tried. This means that when
22486 some IP addresses are past their retry limits, more than the value of
22487 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22488 that all IP addresses are considered before timing out an email address (but
22489 see below for an exception).
22490
22491 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22492 list to see if there is a subsequent host with a different (higher valued) MX.
22493 If there is, that host is considered next, and the current IP address is used
22494 but not counted. This behaviour helps in the case of a domain with a retry rule
22495 that hardly ever delays any hosts, as is now explained:
22496
22497 Consider the case of a long list of hosts with one MX value, and a few with a
22498 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22499 hosts at the top of the list are tried at first. With the default retry rule,
22500 which specifies increasing retry times, the higher MX hosts are eventually
22501 tried when those at the top of the list are skipped because they have not
22502 reached their retry times.
22503
22504 However, it is common practice to put a fixed short retry time on domains for
22505 large ISPs, on the grounds that their servers are rarely down for very long.
22506 Unfortunately, these are exactly the domains that tend to resolve to long lists
22507 of hosts. The short retry time means that the lowest MX hosts are tried every
22508 time. The attempts may be in a different order because of random sorting, but
22509 without the special MX check, the higher MX hosts would never be tried until
22510 all the lower MX hosts had timed out (which might be several days), because
22511 there are always some lower MX hosts that have reached their retry times. With
22512 the special check, Exim considers at least one IP address from each MX value at
22513 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22514 reached.
22515
22516 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22517 particular, Exim normally eventually tries all the IP addresses before timing
22518 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22519 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22520 been set up with hundreds of IP addresses for some domains. It can
22521 take a very long time indeed for an address to time out in these cases.
22522
22523 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22524 Exim never tries more than this number of IP addresses; if it hits this limit
22525 and they are all timed out, the email address is bounced, even though not all
22526 possible IP addresses have been tried.
22527 .ecindex IIDsmttra1
22528 .ecindex IIDsmttra2
22529
22530
22531
22532
22533
22534 . ////////////////////////////////////////////////////////////////////////////
22535 . ////////////////////////////////////////////////////////////////////////////
22536
22537 .chapter "Address rewriting" "CHAPrewrite"
22538 .scindex IIDaddrew "rewriting" "addresses"
22539 There are some circumstances in which Exim automatically rewrites domains in
22540 addresses. The two most common are when an address is given without a domain
22541 (referred to as an &"unqualified address"&) or when an address contains an
22542 abbreviated domain that is expanded by DNS lookup.
22543
22544 Unqualified envelope addresses are accepted only for locally submitted
22545 messages, or for messages that are received from hosts matching
22546 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22547 appropriate. Unqualified addresses in header lines are qualified if they are in
22548 locally submitted messages, or messages from hosts that are permitted to send
22549 unqualified envelope addresses. Otherwise, unqualified addresses in header
22550 lines are neither qualified nor rewritten.
22551
22552 One situation in which Exim does &'not'& automatically rewrite a domain is
22553 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22554 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22555 do this. The new RFCs do not contain this suggestion.
22556
22557
22558 .section "Explicitly configured address rewriting" "SECID147"
22559 This chapter describes the rewriting rules that can be used in the
22560 main rewrite section of the configuration file, and also in the generic
22561 &%headers_rewrite%& option that can be set on any transport.
22562
22563 Some people believe that configured address rewriting is a Mortal Sin.
22564 Others believe that life is not possible without it. Exim provides the
22565 facility; you do not have to use it.
22566
22567 The main rewriting rules that appear in the &"rewrite"& section of the
22568 configuration file are applied to addresses in incoming messages, both envelope
22569 addresses and addresses in header lines. Each rule specifies the types of
22570 address to which it applies.
22571
22572 Whether or not addresses in header lines are rewritten depends on the origin of
22573 the headers and the type of rewriting. Global rewriting, that is, rewriting
22574 rules from the rewrite section of the configuration file, is applied only to
22575 those headers that were received with the message. Header lines that are added
22576 by ACLs or by a system filter or by individual routers or transports (which
22577 are specific to individual recipient addresses) are not rewritten by the global
22578 rules.
22579
22580 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22581 applies all headers except those added by routers and transports. That is, as
22582 well as the headers that were received with the message, it also applies to
22583 headers that were added by an ACL or a system filter.
22584
22585
22586 In general, rewriting addresses from your own system or domain has some
22587 legitimacy. Rewriting other addresses should be done only with great care and
22588 in special circumstances. The author of Exim believes that rewriting should be
22589 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22590 Although it can sometimes be used as a routing tool, this is very strongly
22591 discouraged.
22592
22593 There are two commonly encountered circumstances where rewriting is used, as
22594 illustrated by these examples:
22595
22596 .ilist
22597 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22598 exchange mail with each other behind a firewall, but there is only a single
22599 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22600 &'hitch.fict.example'& when sending mail off-site.
22601 .next
22602 A host rewrites the local parts of its own users so that, for example,
22603 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22604 .endlist
22605
22606
22607
22608 .section "When does rewriting happen?" "SECID148"
22609 .cindex "rewriting" "timing of"
22610 .cindex "&ACL;" "rewriting addresses in"
22611 Configured address rewriting can take place at several different stages of a
22612 message's processing.
22613
22614 .vindex "&$sender_address$&"
22615 At the start of an ACL for MAIL, the sender address may have been rewritten
22616 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22617 ordinary rewrite rules have yet been applied. If, however, the sender address
22618 is verified in the ACL, it is rewritten before verification, and remains
22619 rewritten thereafter. The subsequent value of &$sender_address$& is the
22620 rewritten address. This also applies if sender verification happens in a
22621 RCPT ACL. Otherwise, when the sender address is not verified, it is
22622 rewritten as soon as a message's header lines have been received.
22623
22624 .vindex "&$domain$&"
22625 .vindex "&$local_part$&"
22626 Similarly, at the start of an ACL for RCPT, the current recipient's address
22627 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22628 rewrite rules have yet been applied to it. However, the behaviour is different
22629 from the sender address when a recipient is verified. The address is rewritten
22630 for the verification, but the rewriting is not remembered at this stage. The
22631 value of &$local_part$& and &$domain$& after verification are always the same
22632 as they were before (that is, they contain the unrewritten &-- except for
22633 SMTP-time rewriting &-- address).
22634
22635 As soon as a message's header lines have been received, all the envelope
22636 recipient addresses are permanently rewritten, and rewriting is also applied to
22637 the addresses in the header lines (if configured). This happens before adding
22638 any header lines that were specified in MAIL or RCPT ACLs, and
22639 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22640 before the DATA ACL and &[local_scan()]& functions are run.
22641
22642 When an address is being routed, either for delivery or for verification,
22643 rewriting is applied immediately to child addresses that are generated by
22644 redirection, unless &%no_rewrite%& is set on the router.
22645
22646 .cindex "envelope sender" "rewriting at transport time"
22647 .cindex "rewriting" "at transport time"
22648 .cindex "header lines" "rewriting at transport time"
22649 At transport time, additional rewriting of addresses in header lines can be
22650 specified by setting the generic &%headers_rewrite%& option on a transport.
22651 This option contains rules that are identical in form to those in the rewrite
22652 section of the configuration file. They are applied to the original message
22653 header lines and any that were added by ACLs or a system filter. They are not
22654 applied to header lines that are added by routers or the transport.
22655
22656 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22657 transport option. However, it is not possible to rewrite envelope recipients at
22658 transport time.
22659
22660
22661
22662
22663 .section "Testing the rewriting rules that apply on input" "SECID149"
22664 .cindex "rewriting" "testing"
22665 .cindex "testing" "rewriting"
22666 Exim's input rewriting configuration appears in a part of the run time
22667 configuration file headed by &"begin rewrite"&. It can be tested by the
22668 &%-brw%& command line option. This takes an address (which can be a full RFC
22669 2822 address) as its argument. The output is a list of how the address would be
22670 transformed by the rewriting rules for each of the different places it might
22671 appear in an incoming message, that is, for each different header and for the
22672 envelope sender and recipient fields. For example,
22673 .code
22674 exim -brw ph10@exim.workshop.example
22675 .endd
22676 might produce the output
22677 .code
22678 sender: Philip.Hazel@exim.workshop.example
22679 from: Philip.Hazel@exim.workshop.example
22680 to: ph10@exim.workshop.example
22681 cc: ph10@exim.workshop.example
22682 bcc: ph10@exim.workshop.example
22683 reply-to: Philip.Hazel@exim.workshop.example
22684 env-from: Philip.Hazel@exim.workshop.example
22685 env-to: ph10@exim.workshop.example
22686 .endd
22687 which shows that rewriting has been set up for that address when used in any of
22688 the source fields, but not when it appears as a recipient address. At the
22689 present time, there is no equivalent way of testing rewriting rules that are
22690 set for a particular transport.
22691
22692
22693 .section "Rewriting rules" "SECID150"
22694 .cindex "rewriting" "rules"
22695 The rewrite section of the configuration file consists of lines of rewriting
22696 rules in the form
22697 .display
22698 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22699 .endd
22700 Rewriting rules that are specified for the &%headers_rewrite%& generic
22701 transport option are given as a colon-separated list. Each item in the list
22702 takes the same form as a line in the main rewriting configuration (except that
22703 any colons must be doubled, of course).
22704
22705 The formats of source patterns and replacement strings are described below.
22706 Each is terminated by white space, unless enclosed in double quotes, in which
22707 case normal quoting conventions apply inside the quotes. The flags are single
22708 characters which may appear in any order. Spaces and tabs between them are
22709 ignored.
22710
22711 For each address that could potentially be rewritten, the rules are scanned in
22712 order, and replacements for the address from earlier rules can themselves be
22713 replaced by later rules (but see the &"q"& and &"R"& flags).
22714
22715 The order in which addresses are rewritten is undefined, may change between
22716 releases, and must not be relied on, with one exception: when a message is
22717 received, the envelope sender is always rewritten first, before any header
22718 lines are rewritten. For example, the replacement string for a rewrite of an
22719 address in &'To:'& must not assume that the message's address in &'From:'& has
22720 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22721 that the envelope sender has already been rewritten.
22722
22723 .vindex "&$domain$&"
22724 .vindex "&$local_part$&"
22725 The variables &$local_part$& and &$domain$& can be used in the replacement
22726 string to refer to the address that is being rewritten. Note that lookup-driven
22727 rewriting can be done by a rule of the form
22728 .code
22729 *@*   ${lookup ...
22730 .endd
22731 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22732 refer to the address that is being rewritten.
22733
22734
22735 .section "Rewriting patterns" "SECID151"
22736 .cindex "rewriting" "patterns"
22737 .cindex "address list" "in a rewriting pattern"
22738 The source pattern in a rewriting rule is any item which may appear in an
22739 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22740 single-item address list, which means that it is expanded before being tested
22741 against the address. As always, if you use a regular expression as a pattern,
22742 you must take care to escape dollar and backslash characters, or use the &`\N`&
22743 facility to suppress string expansion within the regular expression.
22744
22745 Domains in patterns should be given in lower case. Local parts in patterns are
22746 case-sensitive. If you want to do case-insensitive matching of local parts, you
22747 can use a regular expression that starts with &`^(?i)`&.
22748
22749 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22750 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22751 depending on the type of match which occurred. These can be used in the
22752 replacement string to insert portions of the incoming address. &$0$& always
22753 refers to the complete incoming address. When a regular expression is used, the
22754 numerical variables are set from its capturing subexpressions. For other types
22755 of pattern they are set as follows:
22756
22757 .ilist
22758 If a local part or domain starts with an asterisk, the numerical variables
22759 refer to the character strings matched by asterisks, with &$1$& associated with
22760 the first asterisk, and &$2$& with the second, if present. For example, if the
22761 pattern
22762 .code
22763 *queen@*.fict.example
22764 .endd
22765 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22766 .code
22767 $0 = hearts-queen@wonderland.fict.example
22768 $1 = hearts-
22769 $2 = wonderland
22770 .endd
22771 Note that if the local part does not start with an asterisk, but the domain
22772 does, it is &$1$& that contains the wild part of the domain.
22773
22774 .next
22775 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22776 of the domain are placed in the next available numerical variables. Suppose,
22777 for example, that the address &'foo@bar.baz.example'& is processed by a
22778 rewriting rule of the form
22779 .display
22780 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22781 .endd
22782 and the key in the file that matches the domain is &`*.baz.example`&. Then
22783 .code
22784 $1 = foo
22785 $2 = bar
22786 $3 = baz.example
22787 .endd
22788 If the address &'foo@baz.example'& is looked up, this matches the same
22789 wildcard file entry, and in this case &$2$& is set to the empty string, but
22790 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22791 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22792 whole domain. For non-partial domain lookups, no numerical variables are set.
22793 .endlist
22794
22795
22796 .section "Rewriting replacements" "SECID152"
22797 .cindex "rewriting" "replacements"
22798 If the replacement string for a rule is a single asterisk, addresses that
22799 match the pattern and the flags are &'not'& rewritten, and no subsequent
22800 rewriting rules are scanned. For example,
22801 .code
22802 hatta@lookingglass.fict.example  *  f
22803 .endd
22804 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22805 &'From:'& headers.
22806
22807 .vindex "&$domain$&"
22808 .vindex "&$local_part$&"
22809 If the replacement string is not a single asterisk, it is expanded, and must
22810 yield a fully qualified address. Within the expansion, the variables
22811 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22812 Any letters they contain retain their original case &-- they are not lower
22813 cased. The numerical variables are set up according to the type of pattern that
22814 matched the address, as described above. If the expansion is forced to fail by
22815 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22816 current rule is abandoned, but subsequent rules may take effect. Any other
22817 expansion failure causes the entire rewriting operation to be abandoned, and an
22818 entry written to the panic log.
22819
22820
22821
22822 .section "Rewriting flags" "SECID153"
22823 There are three different kinds of flag that may appear on rewriting rules:
22824
22825 .ilist
22826 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22827 c, f, h, r, s, t.
22828 .next
22829 A flag that specifies rewriting at SMTP time: S.
22830 .next
22831 Flags that control the rewriting process: Q, q, R, w.
22832 .endlist
22833
22834 For rules that are part of the &%headers_rewrite%& generic transport option,
22835 E, F, T, and S are not permitted.
22836
22837
22838
22839 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22840          "SECID154"
22841 .cindex "rewriting" "flags"
22842 If none of the following flag letters, nor the &"S"& flag (see section
22843 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22844 and to both the sender and recipient fields of the envelope, whereas a
22845 transport-time rewriting rule just applies to all headers. Otherwise, the
22846 rewriting rule is skipped unless the relevant addresses are being processed.
22847 .display
22848 &`E`&       rewrite all envelope fields
22849 &`F`&       rewrite the envelope From field
22850 &`T`&       rewrite the envelope To field
22851 &`b`&       rewrite the &'Bcc:'& header
22852 &`c`&       rewrite the &'Cc:'& header
22853 &`f`&       rewrite the &'From:'& header
22854 &`h`&       rewrite all headers
22855 &`r`&       rewrite the &'Reply-To:'& header
22856 &`s`&       rewrite the &'Sender:'& header
22857 &`t`&       rewrite the &'To:'& header
22858 .endd
22859 "All headers" means all of the headers listed above that can be selected
22860 individually, plus their &'Resent-'& versions. It does not include
22861 other headers such as &'Subject:'& etc.
22862
22863 You should be particularly careful about rewriting &'Sender:'& headers, and
22864 restrict this to special known cases in your own domains.
22865
22866
22867 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22868 .cindex "SMTP" "rewriting malformed addresses"
22869 .cindex "RCPT" "rewriting argument of"
22870 .cindex "MAIL" "rewriting argument of"
22871 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22872 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22873 before any other processing; even before syntax checking. The pattern is
22874 required to be a regular expression, and it is matched against the whole of the
22875 data for the command, including any surrounding angle brackets.
22876
22877 .vindex "&$domain$&"
22878 .vindex "&$local_part$&"
22879 This form of rewrite rule allows for the handling of addresses that are not
22880 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22881 input). Because the input is not required to be a syntactically valid address,
22882 the variables &$local_part$& and &$domain$& are not available during the
22883 expansion of the replacement string. The result of rewriting replaces the
22884 original address in the MAIL or RCPT command.
22885
22886
22887 .section "Flags controlling the rewriting process" "SECID155"
22888 There are four flags which control the way the rewriting process works. These
22889 take effect only when a rule is invoked, that is, when the address is of the
22890 correct type (matches the flags) and matches the pattern:
22891
22892 .ilist
22893 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22894 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22895 absence of &"Q"& the rewritten address must always include a domain.
22896 .next
22897 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22898 even if no rewriting actually takes place because of a &"fail"& in the
22899 expansion. The &"q"& flag is not effective if the address is of the wrong type
22900 (does not match the flags) or does not match the pattern.
22901 .next
22902 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22903 address, up to ten times. It can be combined with the &"q"& flag, to stop
22904 rewriting once it fails to match (after at least one successful rewrite).
22905 .next
22906 .cindex "rewriting" "whole addresses"
22907 When an address in a header is rewritten, the rewriting normally applies only
22908 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22909 left unchanged. For example, rewriting might change
22910 .code
22911 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22912 .endd
22913 into
22914 .code
22915 From: Ford Prefect <prefectf@hitch.fict.example>
22916 .endd
22917 .cindex "RFC 2047"
22918 Sometimes there is a need to replace the whole address item, and this can be
22919 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22920 causes an address in a header line to be rewritten, the entire address is
22921 replaced, not just the working part. The replacement must be a complete RFC
22922 2822 address, including the angle brackets if necessary. If text outside angle
22923 brackets contains a character whose value is greater than 126 or less than 32
22924 (except for tab), the text is encoded according to RFC 2047. The character set
22925 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22926
22927 When the &"w"& flag is set on a rule that causes an envelope address to be
22928 rewritten, all but the working part of the replacement address is discarded.
22929 .endlist
22930
22931
22932 .section "Rewriting examples" "SECID156"
22933 Here is an example of the two common rewriting paradigms:
22934 .code
22935 *@*.hitch.fict.example  $1@hitch.fict.example
22936 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
22937                      {$value}fail}@hitch.fict.example bctfrF
22938 .endd
22939 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22940 the string expansion to fail if the lookup does not succeed. In this context it
22941 has the effect of leaving the original address unchanged, but Exim goes on to
22942 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22943 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22944 explicitly, which would cause the rewritten address to be the same as before,
22945 at the cost of a small bit of processing. Not supplying either of these is an
22946 error, since the rewritten address would then contain no local part.
22947
22948 The first example above replaces the domain with a superior, more general
22949 domain. This may not be desirable for certain local parts. If the rule
22950 .code
22951 root@*.hitch.fict.example  *
22952 .endd
22953 were inserted before the first rule, rewriting would be suppressed for the
22954 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22955
22956 Rewriting can be made conditional on a number of tests, by making use of
22957 &${if$& in the expansion item. For example, to apply a rewriting rule only to
22958 messages that originate outside the local host:
22959 .code
22960 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
22961                          {$1@hitch.fict.example}fail}"
22962 .endd
22963 The replacement string is quoted in this example because it contains white
22964 space.
22965
22966 .cindex "rewriting" "bang paths"
22967 .cindex "bang paths" "rewriting"
22968 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
22969 an address it treats it as an unqualified local part which it qualifies with
22970 the local qualification domain (if the source of the message is local or if the
22971 remote host is permitted to send unqualified addresses). Rewriting can
22972 sometimes be used to handle simple bang paths with a fixed number of
22973 components. For example, the rule
22974 .code
22975 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
22976 .endd
22977 rewrites a two-component bang path &'host.name!user'& as the domain address
22978 &'user@host.name'&. However, there is a security implication in using this as
22979 a global rewriting rule for envelope addresses. It can provide a backdoor
22980 method for using your system as a relay, because the incoming addresses appear
22981 to be local. If the bang path addresses are received via SMTP, it is safer to
22982 use the &"S"& flag to rewrite them as they are received, so that relay checking
22983 can be done on the rewritten addresses.
22984 .ecindex IIDaddrew
22985
22986
22987
22988
22989
22990 . ////////////////////////////////////////////////////////////////////////////
22991 . ////////////////////////////////////////////////////////////////////////////
22992
22993 .chapter "Retry configuration" "CHAPretry"
22994 .scindex IIDretconf1 "retry" "configuration, description of"
22995 .scindex IIDregconf2 "configuration file" "retry section"
22996 The &"retry"& section of the runtime configuration file contains a list of
22997 retry rules that control how often Exim tries to deliver messages that cannot
22998 be delivered at the first attempt. If there are no retry rules (the section is
22999 empty or not present), there are no retries. In this situation, temporary
23000 errors are treated as permanent. The default configuration contains a single,
23001 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23002 line option can be used to test which retry rule will be used for a given
23003 address, domain and error.
23004
23005 The most common cause of retries is temporary failure to deliver to a remote
23006 host because the host is down, or inaccessible because of a network problem.
23007 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23008 address) basis, not on a per-message basis. Thus, if one message has recently
23009 been delayed, delivery of a new message to the same host is not immediately
23010 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23011 log selector is set, the message
23012 .cindex "retry" "time not reached"
23013 &"retry time not reached"& is written to the main log whenever a delivery is
23014 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23015 the handling of errors during remote deliveries.
23016
23017 Retry processing applies to routing as well as to delivering, except as covered
23018 in the next paragraph. The retry rules do not distinguish between these
23019 actions. It is not possible, for example, to specify different behaviour for
23020 failures to route the domain &'snark.fict.example'& and failures to deliver to
23021 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23022 added complication, so did not implement it. However, although they share the
23023 same retry rule, the actual retry times for routing and transporting a given
23024 domain are maintained independently.
23025
23026 When a delivery is not part of a queue run (typically an immediate delivery on
23027 receipt of a message), the routers are always run, and local deliveries are
23028 always attempted, even if retry times are set for them. This makes for better
23029 behaviour if one particular message is causing problems (for example, causing
23030 quota overflow, or provoking an error in a filter file). If such a delivery
23031 suffers a temporary failure, the retry data is updated as normal, and
23032 subsequent delivery attempts from queue runs occur only when the retry time for
23033 the local address is reached.
23034
23035 .section "Changing retry rules" "SECID157"
23036 If you change the retry rules in your configuration, you should consider
23037 whether or not to delete the retry data that is stored in Exim's spool area in
23038 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23039 always safe; that is why they are called &"hints"&.
23040
23041 The hints retry data contains suggested retry times based on the previous
23042 rules. In the case of a long-running problem with a remote host, it might
23043 record the fact that the host has timed out. If your new rules increase the
23044 timeout time for such a host, you should definitely remove the old retry data
23045 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23046 messages that it should now be retaining.
23047
23048
23049
23050 .section "Format of retry rules" "SECID158"
23051 .cindex "retry" "rules"
23052 Each retry rule occupies one line and consists of three or four parts,
23053 separated by white space: a pattern, an error name, an optional list of sender
23054 addresses, and a list of retry parameters. The pattern and sender lists must be
23055 enclosed in double quotes if they contain white space. The rules are searched
23056 in order until one is found where the pattern, error name, and sender list (if
23057 present) match the failing host or address, the error that occurred, and the
23058 message's sender, respectively.
23059
23060
23061 The pattern is any single item that may appear in an address list (see section
23062 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23063 which means that it is expanded before being tested against the address that
23064 has been delayed. A negated address list item is permitted. Address
23065 list processing treats a plain domain name as if it were preceded by &"*@"&,
23066 which makes it possible for many retry rules to start with just a domain. For
23067 example,
23068 .code
23069 lookingglass.fict.example        *  F,24h,30m;
23070 .endd
23071 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23072 whereas
23073 .code
23074 alice@lookingglass.fict.example  *  F,24h,30m;
23075 .endd
23076 applies only to temporary failures involving the local part &%alice%&.
23077 In practice, almost all rules start with a domain name pattern without a local
23078 part.
23079
23080 .cindex "regular expressions" "in retry rules"
23081 &*Warning*&: If you use a regular expression in a routing rule pattern, it
23082 must match a complete address, not just a domain, because that is how regular
23083 expressions work in address lists.
23084 .display
23085 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23086 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23087 .endd
23088
23089
23090 .section "Choosing which retry rule to use for address errors" "SECID159"
23091 When Exim is looking for a retry rule after a routing attempt has failed (for
23092 example, after a DNS timeout), each line in the retry configuration is tested
23093 against the complete address only if &%retry_use_local_part%& is set for the
23094 router. Otherwise, only the domain is used, except when matching against a
23095 regular expression, when the local part of the address is replaced with &"*"&.
23096 A domain on its own can match a domain pattern, or a pattern that starts with
23097 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23098 &%check_local_user%& is true, and false for other routers.
23099
23100 Similarly, when Exim is looking for a retry rule after a local delivery has
23101 failed (for example, after a mailbox full error), each line in the retry
23102 configuration is tested against the complete address only if
23103 &%retry_use_local_part%& is set for the transport (it defaults true for all
23104 local transports).
23105
23106 .cindex "4&'xx'& responses" "retry rules for"
23107 However, when Exim is looking for a retry rule after a remote delivery attempt
23108 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23109 whole address is always used as the key when searching the retry rules. The
23110 rule that is found is used to create a retry time for the combination of the
23111 failing address and the message's sender. It is the combination of sender and
23112 recipient that is delayed in subsequent queue runs until its retry time is
23113 reached. You can delay the recipient without regard to the sender by setting
23114 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23115 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23116 commands.
23117
23118
23119
23120 .section "Choosing which retry rule to use for host and message errors" &&&
23121          "SECID160"
23122 For a temporary error that is not related to an individual address (for
23123 example, a connection timeout), each line in the retry configuration is checked
23124 twice. First, the name of the remote host is used as a domain name (preceded by
23125 &"*@"& when matching a regular expression). If this does not match the line,
23126 the domain from the email address is tried in a similar fashion. For example,
23127 suppose the MX records for &'a.b.c.example'& are
23128 .code
23129 a.b.c.example  MX  5  x.y.z.example
23130                MX  6  p.q.r.example
23131                MX  7  m.n.o.example
23132 .endd
23133 and the retry rules are
23134 .code
23135 p.q.r.example    *      F,24h,30m;
23136 a.b.c.example    *      F,4d,45m;
23137 .endd
23138 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23139 first rule matches neither the host nor the domain, so Exim looks at the second
23140 rule. This does not match the host, but it does match the domain, so it is used
23141 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23142 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23143 first retry rule is used, because it matches the host.
23144
23145 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23146 first rule to determine retry times, but for all the other hosts for the domain
23147 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23148 routing to &'a.b.c.example'& suffers a temporary failure.
23149
23150 &*Note*&: The host name is used when matching the patterns, not its IP address.
23151 However, if a message is routed directly to an IP address without the use of a
23152 host name, for example, if a &(manualroute)& router contains a setting such as:
23153 .code
23154 route_list = *.a.example  192.168.34.23
23155 .endd
23156 then the &"host name"& that is used when searching for a retry rule is the
23157 textual form of the IP address.
23158
23159 .section "Retry rules for specific errors" "SECID161"
23160 .cindex "retry" "specific errors; specifying"
23161 The second field in a retry rule is the name of a particular error, or an
23162 asterisk, which matches any error. The errors that can be tested for are:
23163
23164 .vlist
23165 .vitem &%auth_failed%&
23166 Authentication failed when trying to send to a host in the
23167 &%hosts_require_auth%& list in an &(smtp)& transport.
23168
23169 .vitem &%data_4xx%&
23170 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23171 after the command, or after sending the message's data.
23172
23173 .vitem &%mail_4xx%&
23174 A 4&'xx'& error was received for an outgoing MAIL command.
23175
23176 .vitem &%rcpt_4xx%&
23177 A 4&'xx'& error was received for an outgoing RCPT command.
23178 .endlist
23179
23180 For the three 4&'xx'& errors, either the first or both of the x's can be given
23181 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23182 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23183 and have retries every ten minutes with a one-hour timeout, you could set up a
23184 retry rule of this form:
23185 .code
23186 the.domain.name  rcpt_452   F,1h,10m
23187 .endd
23188 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23189 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23190
23191 .vlist
23192 .vitem &%lost_connection%&
23193 A server unexpectedly closed the SMTP connection. There may, of course,
23194 legitimate reasons for this (host died, network died), but if it repeats a lot
23195 for the same host, it indicates something odd.
23196
23197 .vitem &%refused_MX%&
23198 A connection to a host obtained from an MX record was refused.
23199
23200 .vitem &%refused_A%&
23201 A connection to a host not obtained from an MX record was refused.
23202
23203 .vitem &%refused%&
23204 A connection was refused.
23205
23206 .vitem &%timeout_connect_MX%&
23207 A connection attempt to a host obtained from an MX record timed out.
23208
23209 .vitem &%timeout_connect_A%&
23210 A connection attempt to a host not obtained from an MX record timed out.
23211
23212 .vitem &%timeout_connect%&
23213 A connection attempt timed out.
23214
23215 .vitem &%timeout_MX%&
23216 There was a timeout while connecting or during an SMTP session with a host
23217 obtained from an MX record.
23218
23219 .vitem &%timeout_A%&
23220 There was a timeout while connecting or during an SMTP session with a host not
23221 obtained from an MX record.
23222
23223 .vitem &%timeout%&
23224 There was a timeout while connecting or during an SMTP session.
23225
23226 .vitem &%tls_required%&
23227 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23228 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23229 to STARTTLS, or there was a problem setting up the TLS connection.
23230
23231 .vitem &%quota%&
23232 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23233 transport.
23234
23235 .vitem &%quota_%&<&'time'&>
23236 .cindex "quota" "error testing in retry rule"
23237 .cindex "retry" "quota error testing"
23238 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23239 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23240 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23241 for four days.
23242 .endlist
23243
23244 .cindex "mailbox" "time of last read"
23245 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23246 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23247 it should be based on the last time that the user accessed the mailbox.
23248 However, it is not always possible to determine this. Exim uses the following
23249 heuristic rules:
23250
23251 .ilist
23252 If the mailbox is a single file, the time of last access (the &"atime"&) is
23253 used. As no new messages are being delivered (because the mailbox is over
23254 quota), Exim does not access the file, so this is the time of last user access.
23255 .next
23256 .cindex "maildir format" "time of last read"
23257 For a maildir delivery, the time of last modification of the &_new_&
23258 subdirectory is used. As the mailbox is over quota, no new files are created in
23259 the &_new_& subdirectory, because no new messages are being delivered. Any
23260 change to the &_new_& subdirectory is therefore assumed to be the result of an
23261 MUA moving a new message to the &_cur_& directory when it is first read. The
23262 time that is used is therefore the last time that the user read a new message.
23263 .next
23264 For other kinds of multi-file mailbox, the time of last access cannot be
23265 obtained, so a retry rule that uses this type of error field is never matched.
23266 .endlist
23267
23268 The quota errors apply both to system-enforced quotas and to Exim's own quota
23269 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23270 when a local delivery is deferred because a partition is full (the ENOSPC
23271 error).
23272
23273
23274
23275 .section "Retry rules for specified senders" "SECID162"
23276 .cindex "retry" "rules; sender-specific"
23277 You can specify retry rules that apply only when the failing message has a
23278 specific sender. In particular, this can be used to define retry rules that
23279 apply only to bounce messages. The third item in a retry rule can be of this
23280 form:
23281 .display
23282 &`senders=`&<&'address list'&>
23283 .endd
23284 The retry timings themselves are then the fourth item. For example:
23285 .code
23286 *   rcpt_4xx   senders=:   F,1h,30m
23287 .endd
23288 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23289 host. If the address list contains white space, it must be enclosed in quotes.
23290 For example:
23291 .code
23292 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23293 .endd
23294 &*Warning*&: This facility can be unhelpful if it is used for host errors
23295 (which do not depend on the recipient). The reason is that the sender is used
23296 only to match the retry rule. Once the rule has been found for a host error,
23297 its contents are used to set a retry time for the host, and this will apply to
23298 all messages, not just those with specific senders.
23299
23300 When testing retry rules using &%-brt%&, you can supply a sender using the
23301 &%-f%& command line option, like this:
23302 .code
23303 exim -f "" -brt user@dom.ain
23304 .endd
23305 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23306 list is never matched.
23307
23308
23309
23310
23311
23312 .section "Retry parameters" "SECID163"
23313 .cindex "retry" "parameters in rules"
23314 The third (or fourth, if a senders list is present) field in a retry rule is a
23315 sequence of retry parameter sets, separated by semicolons. Each set consists of
23316 .display
23317 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23318 .endd
23319 The letter identifies the algorithm for computing a new retry time; the cutoff
23320 time is the time beyond which this algorithm no longer applies, and the
23321 arguments vary the algorithm's action. The cutoff time is measured from the
23322 time that the first failure for the domain (combined with the local part if
23323 relevant) was detected, not from the time the message was received.
23324
23325 .cindex "retry" "algorithms"
23326 .cindex "retry" "fixed intervals"
23327 .cindex "retry" "increasing intervals"
23328 .cindex "retry" "random intervals"
23329 The available algorithms are:
23330
23331 .ilist
23332 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23333 the interval.
23334 .next
23335 &'G'&: retry at geometrically increasing intervals. The first argument
23336 specifies a starting value for the interval, and the second a multiplier, which
23337 is used to increase the size of the interval at each retry.
23338 .next
23339 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23340 retry, the previous interval is multiplied by the factor in order to get a
23341 maximum for the next interval. The minimum interval is the first argument of
23342 the parameter, and an actual interval is chosen randomly between them. Such a
23343 rule has been found to be helpful in cluster configurations when all the
23344 members of the cluster restart at once, and may therefore synchronize their
23345 queue processing times.
23346 .endlist
23347
23348 When computing the next retry time, the algorithm definitions are scanned in
23349 order until one whose cutoff time has not yet passed is reached. This is then
23350 used to compute a new retry time that is later than the current time. In the
23351 case of fixed interval retries, this simply means adding the interval to the
23352 current time. For geometrically increasing intervals, retry intervals are
23353 computed from the rule's parameters until one that is greater than the previous
23354 interval is found. The main configuration variable
23355 .cindex "limit" "retry interval"
23356 .cindex "retry" "interval, maximum"
23357 .oindex "&%retry_interval_max%&"
23358 &%retry_interval_max%& limits the maximum interval between retries. It
23359 cannot be set greater than &`24h`&, which is its default value.
23360
23361 A single remote domain may have a number of hosts associated with it, and each
23362 host may have more than one IP address. Retry algorithms are selected on the
23363 basis of the domain name, but are applied to each IP address independently. If,
23364 for example, a host has two IP addresses and one is unusable, Exim will
23365 generate retry times for it and will not try to use it until its next retry
23366 time comes. Thus the good IP address is likely to be tried first most of the
23367 time.
23368
23369 .cindex "hints database" "use for retrying"
23370 Retry times are hints rather than promises. Exim does not make any attempt to
23371 run deliveries exactly at the computed times. Instead, a queue runner process
23372 starts delivery processes for delayed messages periodically, and these attempt
23373 new deliveries only for those addresses that have passed their next retry time.
23374 If a new message arrives for a deferred address, an immediate delivery attempt
23375 occurs only if the address has passed its retry time. In the absence of new
23376 messages, the minimum time between retries is the interval between queue runner
23377 processes. There is not much point in setting retry times of five minutes if
23378 your queue runners happen only once an hour, unless there are a significant
23379 number of incoming messages (which might be the case on a system that is
23380 sending everything to a smart host, for example).
23381
23382 The data in the retry hints database can be inspected by using the
23383 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23384 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23385 &'exinext'& utility script can be used to find out what the next retry times
23386 are for the hosts associated with a particular mail domain, and also for local
23387 deliveries that have been deferred.
23388
23389
23390 .section "Retry rule examples" "SECID164"
23391 Here are some example retry rules:
23392 .code
23393 alice@wonderland.fict.example quota_5d  F,7d,3h
23394 wonderland.fict.example       quota_5d
23395 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23396 lookingglass.fict.example     *         F,24h,30m;
23397 *                 refused_A   F,2h,20m;
23398 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23399 .endd
23400 The first rule sets up special handling for mail to
23401 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23402 mailbox has not been read for at least 5 days. Retries continue every three
23403 hours for 7 days. The second rule handles over-quota errors for all other local
23404 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23405 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23406 fail are bounced immediately if the mailbox has not been read for at least 5
23407 days.
23408
23409 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23410 happen every 15 minutes for an hour, then with geometrically increasing
23411 intervals until two days have passed since a delivery first failed. After the
23412 first hour there is a delay of one hour, then two hours, then four hours, and
23413 so on (this is a rather extreme example).
23414
23415 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23416 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23417 all other domains, with special action for connection refusal from hosts that
23418 were not obtained from an MX record.
23419
23420 The final rule in a retry configuration should always have asterisks in the
23421 first two fields so as to provide a general catch-all for any addresses that do
23422 not have their own special handling. This example tries every 15 minutes for 2
23423 hours, then with intervals starting at one hour and increasing by a factor of
23424 1.5 up to 16 hours, then every 8 hours up to 5 days.
23425
23426
23427
23428 .section "Timeout of retry data" "SECID165"
23429 .cindex "timeout" "of retry data"
23430 .oindex "&%retry_data_expire%&"
23431 .cindex "hints database" "data expiry"
23432 .cindex "retry" "timeout of data"
23433 Exim timestamps the data that it writes to its retry hints database. When it
23434 consults the data during a delivery it ignores any that is older than the value
23435 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23436 been tried for 7 days, Exim will try to deliver to it immediately a message
23437 arrives, and if that fails, it will calculate a retry time as if it were
23438 failing for the first time.
23439
23440 This improves the behaviour for messages routed to rarely-used hosts such as MX
23441 backups. If such a host was down at one time, and happens to be down again when
23442 Exim tries a month later, using the old retry data would imply that it had been
23443 down all the time, which is not a justified assumption.
23444
23445 If a host really is permanently dead, this behaviour causes a burst of retries
23446 every now and again, but only if messages routed to it are rare. If there is a
23447 message at least once every 7 days the retry data never expires.
23448
23449
23450
23451
23452 .section "Long-term failures" "SECID166"
23453 .cindex "delivery failure, long-term"
23454 .cindex "retry" "after long-term failure"
23455 Special processing happens when an email address has been failing for so long
23456 that the cutoff time for the last algorithm is reached. For example, using the
23457 default retry rule:
23458 .code
23459 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23460 .endd
23461 the cutoff time is four days. Reaching the retry cutoff is independent of how
23462 long any specific message has been failing; it is the length of continuous
23463 failure for the recipient address that counts.
23464
23465 When the cutoff time is reached for a local delivery, or for all the IP
23466 addresses associated with a remote delivery, a subsequent delivery failure
23467 causes Exim to give up on the address, and a bounce message is generated.
23468 In order to cater for new messages that use the failing address, a next retry
23469 time is still computed from the final algorithm, and is used as follows:
23470
23471 For local deliveries, one delivery attempt is always made for any subsequent
23472 messages. If this delivery fails, the address fails immediately. The
23473 post-cutoff retry time is not used.
23474
23475 If the delivery is remote, there are two possibilities, controlled by the
23476 .oindex "&%delay_after_cutoff%&"
23477 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23478 default. Until the post-cutoff retry time for one of the IP addresses is
23479 reached, the failing email address is bounced immediately, without a delivery
23480 attempt taking place. After that time, one new delivery attempt is made to
23481 those IP addresses that are past their retry times, and if that still fails,
23482 the address is bounced and new retry times are computed.
23483
23484 In other words, when all the hosts for a given email address have been failing
23485 for a long time, Exim bounces rather then defers until one of the hosts' retry
23486 times is reached. Then it tries once, and bounces if that attempt fails. This
23487 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23488 to a broken destination, but if the host does recover, Exim will eventually
23489 notice.
23490
23491 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23492 addresses are past their final cutoff time, Exim tries to deliver to those IP
23493 addresses that have not been tried since the message arrived. If there are
23494 no suitable IP addresses, or if they all fail, the address is bounced. In other
23495 words, it does not delay when a new message arrives, but tries the expired
23496 addresses immediately, unless they have been tried since the message arrived.
23497 If there is a continuous stream of messages for the failing domains, setting
23498 &%delay_after_cutoff%& false means that there will be many more attempts to
23499 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23500 true.
23501
23502 .section "Deliveries that work intermittently" "SECID167"
23503 .cindex "retry" "intermittently working deliveries"
23504 Some additional logic is needed to cope with cases where a host is
23505 intermittently available, or when a message has some attribute that prevents
23506 its delivery when others to the same address get through. In this situation,
23507 because some messages are successfully delivered, the &"retry clock"& for the
23508 host or address keeps getting reset by the successful deliveries, and so
23509 failing messages remain on the queue for ever because the cutoff time is never
23510 reached.
23511
23512 Two exceptional actions are applied to prevent this happening. The first
23513 applies to errors that are related to a message rather than a remote host.
23514 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23515 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23516 commands, and quota failures. For this type of error, if a message's arrival
23517 time is earlier than the &"first failed"& time for the error, the earlier time
23518 is used when scanning the retry rules to decide when to try next and when to
23519 time out the address.
23520
23521 The exceptional second action applies in all cases. If a message has been on
23522 the queue for longer than the cutoff time of any applicable retry rule for a
23523 given address, a delivery is attempted for that address, even if it is not yet
23524 time, and if this delivery fails, the address is timed out. A new retry time is
23525 not computed in this case, so that other messages for the same address are
23526 considered immediately.
23527 .ecindex IIDretconf1
23528 .ecindex IIDregconf2
23529
23530
23531
23532
23533
23534
23535 . ////////////////////////////////////////////////////////////////////////////
23536 . ////////////////////////////////////////////////////////////////////////////
23537
23538 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23539 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23540 .scindex IIDauthconf2 "authentication"
23541 The &"authenticators"& section of Exim's run time configuration is concerned
23542 with SMTP authentication. This facility is an extension to the SMTP protocol,
23543 described in RFC 2554, which allows a client SMTP host to authenticate itself
23544 to a server. This is a common way for a server to recognize clients that are
23545 permitted to use it as a relay. SMTP authentication is not of relevance to the
23546 transfer of mail between servers that have no managerial connection with each
23547 other.
23548
23549 .cindex "AUTH" "description of"
23550 Very briefly, the way SMTP authentication works is as follows:
23551
23552 .ilist
23553 The server advertises a number of authentication &'mechanisms'& in response to
23554 the client's EHLO command.
23555 .next
23556 The client issues an AUTH command, naming a specific mechanism. The command
23557 may, optionally, contain some authentication data.
23558 .next
23559 The server may issue one or more &'challenges'&, to which the client must send
23560 appropriate responses. In simple authentication mechanisms, the challenges are
23561 just prompts for user names and passwords. The server does not have to issue
23562 any challenges &-- in some mechanisms the relevant data may all be transmitted
23563 with the AUTH command.
23564 .next
23565 The server either accepts or denies authentication.
23566 .next
23567 If authentication succeeds, the client may optionally make use of the AUTH
23568 option on the MAIL command to pass an authenticated sender in subsequent
23569 mail transactions. Authentication lasts for the remainder of the SMTP
23570 connection.
23571 .next
23572 If authentication fails, the client may give up, or it may try a different
23573 authentication mechanism, or it may try transferring mail over the
23574 unauthenticated connection.
23575 .endlist
23576
23577 If you are setting up a client, and want to know which authentication
23578 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23579 SMTP port) on the server, and issue an EHLO command. The response to this
23580 includes the list of supported mechanisms. For example:
23581 .display
23582 &`$ `&&*&`telnet server.example 25`&*&
23583 &`Trying 192.168.34.25...`&
23584 &`Connected to server.example.`&
23585 &`Escape character is &#x0027;^]&#x0027;.`&
23586 &`220 server.example ESMTP Exim 4.20 ...`&
23587 &*&`ehlo client.example`&*&
23588 &`250-server.example Hello client.example [10.8.4.5]`&
23589 &`250-SIZE 52428800`&
23590 &`250-PIPELINING`&
23591 &`250-AUTH PLAIN`&
23592 &`250 HELP`&
23593 .endd
23594 The second-last line of this example output shows that the server supports
23595 authentication using the PLAIN mechanism. In Exim, the different authentication
23596 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23597 routers and transports, which authenticators are included in the binary is
23598 controlled by build-time definitions. The following are currently available,
23599 included by setting
23600 .code
23601 AUTH_CRAM_MD5=yes
23602 AUTH_CYRUS_SASL=yes
23603 .new
23604 AUTH_DOVECOT=yes
23605 AUTH_GSASL=yes
23606 AUTH_HEIMDAL_GSSAPI=yes
23607 .wen
23608 AUTH_PLAINTEXT=yes
23609 AUTH_SPA=yes
23610 .endd
23611 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23612 authentication mechanism (RFC 2195), and the second provides an interface to
23613 the Cyrus SASL authentication library.
23614 .new
23615 The third is an interface to Dovecot's authentication system, delegating the
23616 work via a socket interface.
23617 The fourth provides an interface to the GNU SASL authentication library, which
23618 provides mechanisms but typically not data sources.
23619 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
23620 supporting setting a server keytab.
23621 The sixth can be configured to support
23622 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23623 not formally documented, but used by several MUAs. The seventh authenticator
23624 supports Microsoft's &'Secure Password Authentication'& mechanism.
23625 .wen
23626
23627 The authenticators are configured using the same syntax as other drivers (see
23628 section &<<SECTfordricon>>&). If no authenticators are required, no
23629 authentication section need be present in the configuration file. Each
23630 authenticator can in principle have both server and client functions. When Exim
23631 is receiving SMTP mail, it is acting as a server; when it is sending out
23632 messages over SMTP, it is acting as a client. Authenticator configuration
23633 options are provided for use in both these circumstances.
23634
23635 To make it clear which options apply to which situation, the prefixes
23636 &%server_%& and &%client_%& are used on option names that are specific to
23637 either the server or the client function, respectively. Server and client
23638 functions are disabled if none of their options are set. If an authenticator is
23639 to be used for both server and client functions, a single definition, using
23640 both sets of options, is required. For example:
23641 .code
23642 cram:
23643   driver = cram_md5
23644   public_name = CRAM-MD5
23645   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23646   client_name = ph10
23647   client_secret = secret2
23648 .endd
23649 The &%server_%& option is used when Exim is acting as a server, and the
23650 &%client_%& options when it is acting as a client.
23651
23652 Descriptions of the individual authenticators are given in subsequent chapters.
23653 The remainder of this chapter covers the generic options for the
23654 authenticators, followed by general discussion of the way authentication works
23655 in Exim.
23656
23657 .new
23658 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
23659 per-mechanism basis.  Please read carefully to determine which variables hold
23660 account labels such as usercodes and which hold passwords or other
23661 authenticating data.
23662
23663 Note that some mechanisms support two different identifiers for accounts: the
23664 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
23665 and &'authz'& are commonly encountered.  The American spelling is standard here.
23666 Conceptually, authentication data such as passwords are tied to the identifier
23667 used to authenticate; servers may have rules to permit one user to act as a
23668 second user, so that after login the session is treated as though that second
23669 user had logged in.  That second user is the &'authorization id'&.  A robust
23670 configuration might confirm that the &'authz'& field is empty or matches the
23671 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
23672 as verified data, the &'authz'& as an unverified request which the server might
23673 choose to honour.
23674
23675 A &'realm'& is a text string, typically a domain name, presented by a server
23676 to a client to help it select an account and credentials to use.  In some
23677 mechanisms, the client and server provably agree on the realm, but clients
23678 typically can not treat the realm as secure data to be blindly trusted.
23679 .wen
23680
23681
23682
23683 .section "Generic options for authenticators" "SECID168"
23684 .cindex "authentication" "generic options"
23685 .cindex "options" "generic; for authenticators"
23686
23687 .option client_condition authenticators string&!! unset
23688 When Exim is authenticating as a client, it skips any authenticator whose
23689 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23690 used, for example, to skip plain text authenticators when the connection is not
23691 encrypted by a setting such as:
23692 .code
23693 client_condition = ${if !eq{$tls_cipher}{}}
23694 .endd
23695 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23696 used for incoming messages. In fact, during SMTP delivery, it contains the
23697 cipher used for the delivery.)
23698
23699
23700 .option driver authenticators string unset
23701 This option must always be set. It specifies which of the available
23702 authenticators is to be used.
23703
23704
23705 .option public_name authenticators string unset
23706 This option specifies the name of the authentication mechanism that the driver
23707 implements, and by which it is known to the outside world. These names should
23708 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23709 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23710 defaults to the driver's instance name.
23711
23712
23713 .option server_advertise_condition authenticators string&!! unset
23714 When a server is about to advertise an authentication mechanism, the condition
23715 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23716 mechanism is not advertised.
23717 If the expansion fails, the mechanism is not advertised. If the failure was not
23718 forced, and was not caused by a lookup defer, the incident is logged.
23719 See section &<<SECTauthexiser>>& below for further discussion.
23720
23721
23722 .option server_condition authenticators string&!! unset
23723 This option must be set for a &%plaintext%& server authenticator, where it
23724 is used directly to control authentication. See section &<<SECTplainserver>>&
23725 for details.
23726
23727 .new
23728 For the &(gsasl)& authenticator, this option is required for various
23729 mechanisms; see chapter &<<CHAPgsasl>>& for details.
23730 .wen
23731
23732 For the other authenticators, &%server_condition%& can be used as an additional
23733 authentication or authorization mechanism that is applied after the other
23734 authenticator conditions succeed. If it is set, it is expanded when the
23735 authenticator would otherwise return a success code. If the expansion is forced
23736 to fail, authentication fails. Any other expansion failure causes a temporary
23737 error code to be returned. If the result of a successful expansion is an empty
23738 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23739 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23740 other result, a temporary error code is returned, with the expanded string as
23741 the error text.
23742
23743
23744 .option server_debug_print authenticators string&!! unset
23745 If this option is set and authentication debugging is enabled (see the &%-d%&
23746 command line option), the string is expanded and included in the debugging
23747 output when the authenticator is run as a server. This can help with checking
23748 out the values of variables.
23749 If expansion of the string fails, the error message is written to the debugging
23750 output, and Exim carries on processing.
23751
23752
23753 .option server_set_id authenticators string&!! unset
23754 .vindex "&$authenticated_id$&"
23755 When an Exim server successfully authenticates a client, this string is
23756 expanded using data from the authentication, and preserved for any incoming
23757 messages in the variable &$authenticated_id$&. It is also included in the log
23758 lines for incoming messages. For example, a user/password authenticator
23759 configuration might preserve the user name that was used to authenticate, and
23760 refer to it subsequently during delivery of the message.
23761 If expansion fails, the option is ignored.
23762
23763
23764 .option server_mail_auth_condition authenticators string&!! unset
23765 This option allows a server to discard authenticated sender addresses supplied
23766 as part of MAIL commands in SMTP connections that are authenticated by the
23767 driver on which &%server_mail_auth_condition%& is set. The option is not used
23768 as part of the authentication process; instead its (unexpanded) value is
23769 remembered for later use.
23770 How it is used is described in the following section.
23771
23772
23773
23774
23775
23776 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23777 .cindex "authentication" "sender; authenticated"
23778 .cindex "AUTH" "on MAIL command"
23779 When a client supplied an AUTH= item on a MAIL command, Exim applies
23780 the following checks before accepting it as the authenticated sender of the
23781 message:
23782
23783 .ilist
23784 If the connection is not using extended SMTP (that is, HELO was used rather
23785 than EHLO), the use of AUTH= is a syntax error.
23786 .next
23787 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23788 .next
23789 .vindex "&$authenticated_sender$&"
23790 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23791 running, the value of &$authenticated_sender$& is set to the value obtained
23792 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23793 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23794 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23795 given for the MAIL command.
23796 .next
23797 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23798 is accepted and placed in &$authenticated_sender$& only if the client has
23799 authenticated.
23800 .next
23801 If the AUTH= value was accepted by either of the two previous rules, and
23802 the client has authenticated, and the authenticator has a setting for the
23803 &%server_mail_auth_condition%&, the condition is checked at this point. The
23804 valued that was saved from the authenticator is expanded. If the expansion
23805 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23806 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23807 the value of &$authenticated_sender$& is retained and passed on with the
23808 message.
23809 .endlist
23810
23811
23812 When &$authenticated_sender$& is set for a message, it is passed on to other
23813 hosts to which Exim authenticates as a client. Do not confuse this value with
23814 &$authenticated_id$&, which is a string obtained from the authentication
23815 process, and which is not usually a complete email address.
23816
23817 .vindex "&$sender_address$&"
23818 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23819 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23820 therefore make use of &$authenticated_sender$&. The converse is not true: the
23821 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23822 ACL is run.
23823
23824
23825
23826 .section "Authentication on an Exim server" "SECTauthexiser"
23827 .cindex "authentication" "on an Exim server"
23828 When Exim receives an EHLO command, it advertises the public names of those
23829 authenticators that are configured as servers, subject to the following
23830 conditions:
23831
23832 .ilist
23833 The client host must match &%auth_advertise_hosts%& (default *).
23834 .next
23835 It the &%server_advertise_condition%& option is set, its expansion must not
23836 yield the empty string, &"0"&, &"no"&, or &"false"&.
23837 .endlist
23838
23839 The order in which the authenticators are defined controls the order in which
23840 the mechanisms are advertised.
23841
23842 Some mail clients (for example, some versions of Netscape) require the user to
23843 provide a name and password for authentication whenever AUTH is advertised,
23844 even though authentication may not in fact be needed (for example, Exim may be
23845 set up to allow unconditional relaying from the client by an IP address check).
23846 You can make such clients more friendly by not advertising AUTH to them.
23847 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23848 that runs for RCPT) to relay without authentication, you should set
23849 .code
23850 auth_advertise_hosts = ! 10.9.8.0/24
23851 .endd
23852 so that no authentication mechanisms are advertised to them.
23853
23854 The &%server_advertise_condition%& controls the advertisement of individual
23855 authentication mechanisms. For example, it can be used to restrict the
23856 advertisement of a particular mechanism to encrypted connections, by a setting
23857 such as:
23858 .code
23859 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23860 .endd
23861 .vindex "&$tls_cipher$&"
23862 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23863 yields &"yes"&, which allows the advertisement to happen.
23864
23865 When an Exim server receives an AUTH command from a client, it rejects it
23866 immediately if AUTH was not advertised in response to an earlier EHLO
23867 command. This is the case if
23868
23869 .ilist
23870 The client host does not match &%auth_advertise_hosts%&; or
23871 .next
23872 No authenticators are configured with server options; or
23873 .next
23874 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23875 server authenticators.
23876 .endlist
23877
23878
23879 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23880 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23881 AUTH is accepted from any client host.
23882
23883 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23884 server authentication mechanism that was advertised in response to EHLO and
23885 that matches the one named in the AUTH command. If it finds one, it runs
23886 the appropriate authentication protocol, and authentication either succeeds or
23887 fails. If there is no matching advertised mechanism, the AUTH command is
23888 rejected with a 504 error.
23889
23890 .vindex "&$received_protocol$&"
23891 .vindex "&$sender_host_authenticated$&"
23892 When a message is received from an authenticated host, the value of
23893 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23894 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23895 public name) of the authenticator driver that successfully authenticated the
23896 client from which the message was received. This variable is empty if there was
23897 no successful authentication.
23898
23899
23900
23901
23902 .section "Testing server authentication" "SECID169"
23903 .cindex "authentication" "testing a server"
23904 .cindex "AUTH" "testing a server"
23905 .cindex "base64 encoding" "creating authentication test data"
23906 Exim's &%-bh%& option can be useful for testing server authentication
23907 configurations. The data for the AUTH command has to be sent using base64
23908 encoding. A quick way to produce such data for testing is the following Perl
23909 script:
23910 .code
23911 use MIME::Base64;
23912 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23913 .endd
23914 .cindex "binary zero" "in authentication data"
23915 This interprets its argument as a Perl string, and then encodes it. The
23916 interpretation as a Perl string allows binary zeros, which are required for
23917 some kinds of authentication, to be included in the data. For example, a
23918 command line to run this script on such data might be
23919 .code
23920 encode '\0user\0password'
23921 .endd
23922 Note the use of single quotes to prevent the shell interpreting the
23923 backslashes, so that they can be interpreted by Perl to specify characters
23924 whose code value is zero.
23925
23926 &*Warning 1*&: If either of the user or password strings starts with an octal
23927 digit, you must use three zeros instead of one after the leading backslash. If
23928 you do not, the octal digit that starts your string will be incorrectly
23929 interpreted as part of the code for the first character.
23930
23931 &*Warning 2*&: If there are characters in the strings that Perl interprets
23932 specially, you must use a Perl escape to prevent them being misinterpreted. For
23933 example, a command such as
23934 .code
23935 encode '\0user@domain.com\0pas$$word'
23936 .endd
23937 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23938
23939 If you have the &%mimencode%& command installed, another way to do produce
23940 base64-encoded strings is to run the command
23941 .code
23942 echo -e -n `\0user\0password' | mimencode
23943 .endd
23944 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23945 in the argument, and the &%-n%& option specifies no newline at the end of its
23946 output. However, not all versions of &%echo%& recognize these options, so you
23947 should check your version before relying on this suggestion.
23948
23949
23950
23951 .section "Authentication by an Exim client" "SECID170"
23952 .cindex "authentication" "on an Exim client"
23953 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23954 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23955 announces support for authentication, and the host matches an entry in either
23956 of these options, Exim (as a client) tries to authenticate as follows:
23957
23958 .ilist
23959 For each authenticator that is configured as a client, in the order in which
23960 they are defined in the configuration, it searches the authentication
23961 mechanisms announced by the server for one whose name matches the public name
23962 of the authenticator.
23963 .next
23964 .vindex "&$host$&"
23965 .vindex "&$host_address$&"
23966 When it finds one that matches, it runs the authenticator's client code. The
23967 variables &$host$& and &$host_address$& are available for any string expansions
23968 that the client might do. They are set to the server's name and IP address. If
23969 any expansion is forced to fail, the authentication attempt is abandoned, and
23970 Exim moves on to the next authenticator. Otherwise an expansion failure causes
23971 delivery to be deferred.
23972 .next
23973 If the result of the authentication attempt is a temporary error or a timeout,
23974 Exim abandons trying to send the message to the host for the moment. It will
23975 try again later. If there are any backup hosts available, they are tried in the
23976 usual way.
23977 .next
23978 If the response to authentication is a permanent error (5&'xx'& code), Exim
23979 carries on searching the list of authenticators and tries another one if
23980 possible. If all authentication attempts give permanent errors, or if there are
23981 no attempts because no mechanisms match (or option expansions force failure),
23982 what happens depends on whether the host matches &%hosts_require_auth%& or
23983 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
23984 delivery is deferred. The error can be detected in the retry rules, and thereby
23985 turned into a permanent error if you wish. In the second case, Exim tries to
23986 deliver the message unauthenticated.
23987 .endlist
23988
23989 .cindex "AUTH" "on MAIL command"
23990 When Exim has authenticated itself to a remote server, it adds the AUTH
23991 parameter to the MAIL commands it sends, if it has an authenticated sender for
23992 the message. If the message came from a remote host, the authenticated sender
23993 is the one that was receiving on an incoming MAIL command, provided that the
23994 incoming connection was authenticated and the &%server_mail_auth%& condition
23995 allowed the authenticated sender to be retained. If a local process calls Exim
23996 to send a message, the sender address that is built from the login name and
23997 &%qualify_domain%& is treated as authenticated. However, if the
23998 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
23999 the authenticated sender that was received with the message.
24000 .ecindex IIDauthconf1
24001 .ecindex IIDauthconf2
24002
24003
24004
24005
24006
24007
24008 . ////////////////////////////////////////////////////////////////////////////
24009 . ////////////////////////////////////////////////////////////////////////////
24010
24011 .chapter "The plaintext authenticator" "CHAPplaintext"
24012 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24013 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24014 The &(plaintext)& authenticator can be configured to support the PLAIN and
24015 LOGIN authentication mechanisms, both of which transfer authentication data as
24016 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24017 security risk; you are strongly advised to insist on the use of SMTP encryption
24018 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24019 use unencrypted plain text, you should not use the same passwords for SMTP
24020 connections as you do for login accounts.
24021
24022 .section "Plaintext options" "SECID171"
24023 .cindex "options" "&(plaintext)& authenticator (server)"
24024 When configured as a server, &(plaintext)& uses the following options:
24025
24026 .option server_condition authenticators string&!! unset
24027 This is actually a global authentication option, but it must be set in order to
24028 configure the &(plaintext)& driver as a server. Its use is described below.
24029
24030 .option server_prompts plaintext string&!! unset
24031 The contents of this option, after expansion, must be a colon-separated list of
24032 prompt strings. If expansion fails, a temporary authentication rejection is
24033 given.
24034
24035 .section "Using plaintext in a server" "SECTplainserver"
24036 .cindex "AUTH" "in &(plaintext)& authenticator"
24037 .cindex "binary zero" "in &(plaintext)& authenticator"
24038 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24039         "in &(plaintext)& authenticator"
24040 .vindex "&$auth1$&, &$auth2$&, etc"
24041 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24042
24043 When running as a server, &(plaintext)& performs the authentication test by
24044 expanding a string. The data sent by the client with the AUTH command, or in
24045 response to subsequent prompts, is base64 encoded, and so may contain any byte
24046 values when decoded. If any data is supplied with the command, it is treated as
24047 a list of strings, separated by NULs (binary zeros), the first three of which
24048 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24049 (neither LOGIN nor PLAIN uses more than three strings).
24050
24051 For compatibility with previous releases of Exim, the values are also placed in
24052 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24053 variables for this purpose is now deprecated, as it can lead to confusion in
24054 string expansions that also use them for other things.
24055
24056 If there are more strings in &%server_prompts%& than the number of strings
24057 supplied with the AUTH command, the remaining prompts are used to obtain more
24058 data. Each response from the client may be a list of NUL-separated strings.
24059
24060 .vindex "&$authenticated_id$&"
24061 Once a sufficient number of data strings have been received,
24062 &%server_condition%& is expanded. If the expansion is forced to fail,
24063 authentication fails. Any other expansion failure causes a temporary error code
24064 to be returned. If the result of a successful expansion is an empty string,
24065 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24066 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24067 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24068 For any other result, a temporary error code is returned, with the expanded
24069 string as the error text.
24070
24071 &*Warning*&: If you use a lookup in the expansion to find the user's
24072 password, be sure to make the authentication fail if the user is unknown.
24073 There are good and bad examples at the end of the next section.
24074
24075
24076
24077 .section "The PLAIN authentication mechanism" "SECID172"
24078 .cindex "PLAIN authentication mechanism"
24079 .cindex "authentication" "PLAIN mechanism"
24080 .cindex "binary zero" "in &(plaintext)& authenticator"
24081 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24082 sent as one item of data (that is, one combined string containing two NUL
24083 separators). The data is sent either as part of the AUTH command, or
24084 subsequently in response to an empty prompt from the server.
24085
24086 The second and third strings are a user name and a corresponding password.
24087 Using a single fixed user name and password as an example, this could be
24088 configured as follows:
24089 .code
24090 fixed_plain:
24091   driver = plaintext
24092   public_name = PLAIN
24093   server_prompts = :
24094   server_condition = \
24095     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24096   server_set_id = $auth2
24097 .endd
24098 Note that the default result strings from &%if%& (&"true"& or an empty string)
24099 are exactly what we want here, so they need not be specified. Obviously, if the
24100 password contains expansion-significant characters such as dollar, backslash,
24101 or closing brace, they have to be escaped.
24102
24103 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24104 the end of a string list are ignored). If all the data comes as part of the
24105 AUTH command, as is commonly the case, the prompt is not used. This
24106 authenticator is advertised in the response to EHLO as
24107 .code
24108 250-AUTH PLAIN
24109 .endd
24110 and a client host can authenticate itself by sending the command
24111 .code
24112 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24113 .endd
24114 As this contains three strings (more than the number of prompts), no further
24115 data is required from the client. Alternatively, the client may just send
24116 .code
24117 AUTH PLAIN
24118 .endd
24119 to initiate authentication, in which case the server replies with an empty
24120 prompt. The client must respond with the combined data string.
24121
24122 The data string is base64 encoded, as required by the RFC. This example,
24123 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24124 represents a zero byte. This is split up into three strings, the first of which
24125 is empty. The &%server_condition%& option in the authenticator checks that the
24126 second two are &`username`& and &`mysecret`& respectively.
24127
24128 Having just one fixed user name and password, as in this example, is not very
24129 realistic, though for a small organization with only a handful of
24130 authenticating clients it could make sense.
24131
24132 A more sophisticated instance of this authenticator could use the user name in
24133 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24134 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24135 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24136 This is an incorrect example:
24137 .code
24138 server_condition = \
24139   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24140 .endd
24141 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24142 which it then compares to the supplied password (&$auth3$&). Why is this example
24143 incorrect? It works fine for existing users, but consider what happens if a
24144 non-existent user name is given. The lookup fails, but as no success/failure
24145 strings are given for the lookup, it yields an empty string. Thus, to defeat
24146 the authentication, all a client has to do is to supply a non-existent user
24147 name and an empty password. The correct way of writing this test is:
24148 .code
24149 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24150   {${if eq{$value}{$auth3}}} {false}}
24151 .endd
24152 In this case, if the lookup succeeds, the result is checked; if the lookup
24153 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24154 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24155 always fails if its second argument is empty. However, the second way of
24156 writing the test makes the logic clearer.
24157
24158
24159 .section "The LOGIN authentication mechanism" "SECID173"
24160 .cindex "LOGIN authentication mechanism"
24161 .cindex "authentication" "LOGIN mechanism"
24162 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24163 in a number of programs. No data is sent with the AUTH command. Instead, a
24164 user name and password are supplied separately, in response to prompts. The
24165 plaintext authenticator can be configured to support this as in this example:
24166 .code
24167 fixed_login:
24168   driver = plaintext
24169   public_name = LOGIN
24170   server_prompts = User Name : Password
24171   server_condition = \
24172     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24173   server_set_id = $auth1
24174 .endd
24175 Because of the way plaintext operates, this authenticator accepts data supplied
24176 with the AUTH command (in contravention of the specification of LOGIN), but
24177 if the client does not supply it (as is the case for LOGIN clients), the prompt
24178 strings are used to obtain two data items.
24179
24180 Some clients are very particular about the precise text of the prompts. For
24181 example, Outlook Express is reported to recognize only &"Username:"& and
24182 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24183 strings. It uses the &%ldapauth%& expansion condition to check the user
24184 name and password by binding to an LDAP server:
24185 .code
24186 login:
24187   driver = plaintext
24188   public_name = LOGIN
24189   server_prompts = Username:: : Password::
24190   server_condition = ${if and{{ \
24191     !eq{}{$auth1} }{ \
24192     ldapauth{\
24193       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24194       pass=${quote:$auth2} \
24195       ldap://ldap.example.org/} }} }
24196   server_set_id = uid=$auth1,ou=people,o=example.org
24197 .endd
24198 We have to check that the username is not empty before using it, because LDAP
24199 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24200 operator to correctly quote the DN for authentication. However, the basic
24201 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24202 correct one to use for the password, because quoting is needed only to make
24203 the password conform to the Exim syntax. At the LDAP level, the password is an
24204 uninterpreted string.
24205
24206
24207 .section "Support for different kinds of authentication" "SECID174"
24208 A number of string expansion features are provided for the purpose of
24209 interfacing to different ways of user authentication. These include checking
24210 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24211 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24212 &<<SECTexpcond>>&.
24213
24214
24215
24216
24217 .section "Using plaintext in a client" "SECID175"
24218 .cindex "options" "&(plaintext)& authenticator (client)"
24219 The &(plaintext)& authenticator has two client options:
24220
24221 .option client_ignore_invalid_base64 plaintext boolean false
24222 If the client receives a server prompt that is not a valid base64 string,
24223 authentication is abandoned by default. However, if this option is set true,
24224 the error in the challenge is ignored and the client sends the response as
24225 usual.
24226
24227 .option client_send plaintext string&!! unset
24228 The string is a colon-separated list of authentication data strings. Each
24229 string is independently expanded before being sent to the server. The first
24230 string is sent with the AUTH command; any more strings are sent in response
24231 to prompts from the server. Before each string is expanded, the value of the
24232 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24233 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24234 way. Thus, the prompt that is received in response to sending the first string
24235 (with the AUTH command) can be used in the expansion of the second string, and
24236 so on. If an invalid base64 string is received when
24237 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24238 &$auth$&<&'n'&> variable.
24239
24240 &*Note*&: You cannot use expansion to create multiple strings, because
24241 splitting takes priority and happens first.
24242
24243 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24244 the data, further processing is applied to each string before it is sent. If
24245 there are any single circumflex characters in the string, they are converted to
24246 NULs. Should an actual circumflex be required as data, it must be doubled in
24247 the string.
24248
24249 This is an example of a client configuration that implements the PLAIN
24250 authentication mechanism with a fixed user name and password:
24251 .code
24252 fixed_plain:
24253   driver = plaintext
24254   public_name = PLAIN
24255   client_send = ^username^mysecret
24256 .endd
24257 The lack of colons means that the entire text is sent with the AUTH
24258 command, with the circumflex characters converted to NULs. A similar example
24259 that uses the LOGIN mechanism is:
24260 .code
24261 fixed_login:
24262   driver = plaintext
24263   public_name = LOGIN
24264   client_send = : username : mysecret
24265 .endd
24266 The initial colon means that the first string is empty, so no data is sent with
24267 the AUTH command itself. The remaining strings are sent in response to
24268 prompts.
24269 .ecindex IIDplaiauth1
24270 .ecindex IIDplaiauth2
24271
24272
24273
24274
24275 . ////////////////////////////////////////////////////////////////////////////
24276 . ////////////////////////////////////////////////////////////////////////////
24277
24278 .chapter "The cram_md5 authenticator" "CHID9"
24279 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24280 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24281 .cindex "CRAM-MD5 authentication mechanism"
24282 .cindex "authentication" "CRAM-MD5 mechanism"
24283 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24284 sends a challenge string to the client, and the response consists of a user
24285 name and the CRAM-MD5 digest of the challenge string combined with a secret
24286 string (password) which is known to both server and client. Thus, the secret
24287 is not sent over the network as plain text, which makes this authenticator more
24288 secure than &(plaintext)&. However, the downside is that the secret has to be
24289 available in plain text at either end.
24290
24291
24292 .section "Using cram_md5 as a server" "SECID176"
24293 .cindex "options" "&(cram_md5)& authenticator (server)"
24294 This authenticator has one server option, which must be set to configure the
24295 authenticator as a server:
24296
24297 .option server_secret cram_md5 string&!! unset
24298 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24299 When the server receives the client's response, the user name is placed in
24300 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24301 obtain the password for that user. The server then computes the CRAM-MD5 digest
24302 that the client should have sent, and checks that it received the correct
24303 string. If the expansion of &%server_secret%& is forced to fail, authentication
24304 fails. If the expansion fails for some other reason, a temporary error code is
24305 returned to the client.
24306
24307 For compatibility with previous releases of Exim, the user name is also placed
24308 in &$1$&. However, the use of this variables for this purpose is now
24309 deprecated, as it can lead to confusion in string expansions that also use
24310 numeric variables for other things.
24311
24312 For example, the following authenticator checks that the user name given by the
24313 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24314 user name, authentication fails.
24315 .code
24316 fixed_cram:
24317   driver = cram_md5
24318   public_name = CRAM-MD5
24319   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24320   server_set_id = $auth1
24321 .endd
24322 .vindex "&$authenticated_id$&"
24323 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24324 name in &$authenticated_id$&. A more typical configuration might look up the
24325 secret string in a file, using the user name as the key. For example:
24326 .code
24327 lookup_cram:
24328   driver = cram_md5
24329   public_name = CRAM-MD5
24330   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24331                   {$value}fail}
24332   server_set_id = $auth1
24333 .endd
24334 Note that this expansion explicitly forces failure if the lookup fails
24335 because &$auth1$& contains an unknown user name.
24336
24337 .new
24338 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24339 using the relevant libraries, you need to know the realm to specify in the
24340 lookup and then ask for the &"userPassword"& attribute for that user in that
24341 realm, with:
24342 .code
24343 cyrusless_crammd5:
24344   driver = cram_md5
24345   public_name = CRAM-MD5
24346   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24347                   dbmjz{/etc/sasldb2}}
24348   server_set_id = $auth1
24349 .endd
24350 .wen
24351
24352 .section "Using cram_md5 as a client" "SECID177"
24353 .cindex "options" "&(cram_md5)& authenticator (client)"
24354 When used as a client, the &(cram_md5)& authenticator has two options:
24355
24356
24357
24358 .option client_name cram_md5 string&!! "the primary host name"
24359 This string is expanded, and the result used as the user name data when
24360 computing the response to the server's challenge.
24361
24362
24363 .option client_secret cram_md5 string&!! unset
24364 This option must be set for the authenticator to work as a client. Its value is
24365 expanded and the result used as the secret string when computing the response.
24366
24367
24368 .vindex "&$host$&"
24369 .vindex "&$host_address$&"
24370 Different user names and secrets can be used for different servers by referring
24371 to &$host$& or &$host_address$& in the options. Forced failure of either
24372 expansion string is treated as an indication that this authenticator is not
24373 prepared to handle this case. Exim moves on to the next configured client
24374 authenticator. Any other expansion failure causes Exim to give up trying to
24375 send the message to the current server.
24376
24377 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24378 strings, is:
24379 .code
24380 fixed_cram:
24381   driver = cram_md5
24382   public_name = CRAM-MD5
24383   client_name = ph10
24384   client_secret = secret
24385 .endd
24386 .ecindex IIDcramauth1
24387 .ecindex IIDcramauth2
24388
24389
24390
24391 . ////////////////////////////////////////////////////////////////////////////
24392 . ////////////////////////////////////////////////////////////////////////////
24393
24394 .chapter "The cyrus_sasl authenticator" "CHID10"
24395 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24396 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24397 .cindex "Cyrus" "SASL library"
24398 .cindex "Kerberos"
24399 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24400 Digital Ltd (&url(http://www.aldigital.co.uk)).
24401
24402 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24403 library implementation of the RFC 2222 (&"Simple Authentication and Security
24404 Layer"&). This library supports a number of authentication mechanisms,
24405 including PLAIN and LOGIN, but also several others that Exim does not support
24406 directly. In particular, there is support for Kerberos authentication.
24407
24408 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24409 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24410 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24411 name of the driver to determine which mechanism to support.
24412
24413 Where access to some kind of secret file is required, for example in GSSAPI
24414 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24415 user, and that the Cyrus SASL library has no way of escalating privileges
24416 by default. You may also find you need to set environment variables,
24417 depending on the driver you are using.
24418
24419 The application name provided by Exim is &"exim"&, so various SASL options may
24420 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24421 Kerberos, note that because of limitations in the GSSAPI interface,
24422 changing the server keytab might need to be communicated down to the Kerberos
24423 layer independently. The mechanism for doing so is dependent upon the Kerberos
24424 implementation.
24425 .new
24426 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
24427 may be set to point to an alternative keytab file. Exim will pass this
24428 variable through from its own inherited environment when started as root or the
24429 Exim user. The keytab file needs to be readable by the Exim user.
24430 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
24431 environment variable.  In practice, for those releases, the Cyrus authenticator
24432 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
24433 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
24434 .wen
24435
24436
24437 .section "Using cyrus_sasl as a server" "SECID178"
24438 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24439 (on a successful authentication) into &$auth1$&. For compatibility with
24440 previous releases of Exim, the username is also placed in &$1$&. However, the
24441 use of this variable for this purpose is now deprecated, as it can lead to
24442 confusion in string expansions that also use numeric variables for other
24443 things.
24444
24445
24446 .option server_hostname cyrus_sasl string&!! "see below"
24447 This option selects the hostname that is used when communicating with the
24448 library. The default value is &`$primary_hostname`&. It is up to the underlying
24449 SASL plug-in what it does with this data.
24450
24451
24452 .option server_mech cyrus_sasl string "see below"
24453 This option selects the authentication mechanism this driver should use. The
24454 default is the value of the generic &%public_name%& option. This option allows
24455 you to use a different underlying mechanism from the advertised name. For
24456 example:
24457 .code
24458 sasl:
24459   driver = cyrus_sasl
24460   public_name = X-ANYTHING
24461   server_mech = CRAM-MD5
24462   server_set_id = $auth1
24463 .endd
24464
24465 .new
24466 .option server_realm cyrus_sasl string&!! unset
24467 This specifies the SASL realm that the server claims to be in.
24468 .wen
24469
24470
24471 .option server_service cyrus_sasl string &`smtp`&
24472 This is the SASL service that the server claims to implement.
24473
24474
24475 For straightforward cases, you do not need to set any of the authenticator's
24476 private options. All you need to do is to specify an appropriate mechanism as
24477 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24478 PLAIN, you could have two authenticators as follows:
24479 .code
24480 sasl_cram_md5:
24481   driver = cyrus_sasl
24482   public_name = CRAM-MD5
24483   server_set_id = $auth1
24484
24485 sasl_plain:
24486   driver = cyrus_sasl
24487   public_name = PLAIN
24488   server_set_id = $auth2
24489 .endd
24490 Cyrus SASL does implement the LOGIN authentication method, even though it is
24491 not a standard method. It is disabled by default in the source distribution,
24492 but it is present in many binary distributions.
24493 .ecindex IIDcyrauth1
24494 .ecindex IIDcyrauth2
24495
24496
24497
24498
24499 . ////////////////////////////////////////////////////////////////////////////
24500 . ////////////////////////////////////////////////////////////////////////////
24501 .chapter "The dovecot authenticator" "CHAPdovecot"
24502 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24503 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24504 This authenticator is an interface to the authentication facility of the
24505 Dovecot POP/IMAP server, which can support a number of authentication methods.
24506 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24507 to use the same mechanisms for SMTP authentication. This is a server
24508 authenticator only. There is only one option:
24509
24510 .option server_socket dovecot string unset
24511
24512 This option must specify the socket that is the interface to Dovecot
24513 authentication. The &%public_name%& option must specify an authentication
24514 mechanism that Dovecot is configured to support. You can have several
24515 authenticators for different mechanisms. For example:
24516 .code
24517 dovecot_plain:
24518   driver = dovecot
24519   public_name = PLAIN
24520   server_socket = /var/run/dovecot/auth-client
24521   server_set_id = $auth2
24522
24523 dovecot_ntlm:
24524   driver = dovecot
24525   public_name = NTLM
24526   server_socket = /var/run/dovecot/auth-client
24527   server_set_id = $auth1
24528 .endd
24529 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24530 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24531 option is passed in the Dovecot authentication command. If, for a TLS
24532 connection, a client certificate has been verified, the &"valid-client-cert"&
24533 option is passed. When authentication succeeds, the identity of the user
24534 who authenticated is placed in &$auth1$&.
24535 .ecindex IIDdcotauth1
24536 .ecindex IIDdcotauth2
24537
24538
24539 . ////////////////////////////////////////////////////////////////////////////
24540 . ////////////////////////////////////////////////////////////////////////////
24541 .new
24542 .chapter "The gsasl authenticator" "CHAPgsasl"
24543 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
24544 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
24545 .cindex "authentication" "GNU SASL"
24546 .cindex "authentication" "SASL"
24547 .cindex "authentication" "EXTERNAL"
24548 .cindex "authentication" "ANONYMOUS"
24549 .cindex "authentication" "PLAIN"
24550 .cindex "authentication" "LOGIN"
24551 .cindex "authentication" "DIGEST-MD5"
24552 .cindex "authentication" "CRAM-MD5"
24553 .cindex "authentication" "SCRAM-SHA-1"
24554 The &(gsasl)& authenticator provides server integration for the GNU SASL
24555 library and the mechanisms it provides.  This is new as of the 4.78 release
24556 and there are a few areas where the library does not let Exim smoothly
24557 scale to handle future authentication mechanisms, so no guarantee can be
24558 made that any particular new authentication mechanism will be supported
24559 without code changes in Exim.
24560
24561
24562 .option server_channelbinding gsasl bool false
24563 Some authentication mechanisms are able to use external context at both ends
24564 of the session to bind the authentication to that context, and fail the
24565 authentication process if that context differs.  Specifically, some TLS
24566 ciphersuites can provide identifying information about the cryptographic
24567 context.
24568
24569 This means that certificate identity and verification becomes a non-issue,
24570 as a man-in-the-middle attack will cause the correct client and server to
24571 see different identifiers and authentication will fail.
24572
24573 This is currently only supported when using the GnuTLS library.  This is
24574 only usable by mechanisms which support "channel binding"; at time of
24575 writing, that's the SCRAM family.
24576
24577 This defaults off to ensure smooth upgrade across Exim releases, in case
24578 this option causes some clients to start failing.  Some future release
24579 of Exim may switch the default to be true.
24580
24581
24582 .option server_hostname gsasl string&!! "see below"
24583 This option selects the hostname that is used when communicating with the
24584 library. The default value is &`$primary_hostname`&.
24585 Some mechanisms will use this data.
24586
24587
24588 .option server_mech gsasl string "see below"
24589 This option selects the authentication mechanism this driver should use. The
24590 default is the value of the generic &%public_name%& option. This option allows
24591 you to use a different underlying mechanism from the advertised name. For
24592 example:
24593 .code
24594 sasl:
24595   driver = gsasl
24596   public_name = X-ANYTHING
24597   server_mech = CRAM-MD5
24598   server_set_id = $auth1
24599 .endd
24600
24601
24602 .option server_password gsasl string&!! unset
24603 Various mechanisms need access to the cleartext password on the server, so
24604 that proof-of-possession can be demonstrated on the wire, without sending
24605 the password itself.
24606
24607 The data available for lookup varies per mechanism.
24608 In all cases, &$auth1$& is set to the &'authentication id'&.
24609 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
24610 if available, else the empty string.
24611 The &$auth3$& variable will always be the &'realm'& if available,
24612 else the empty string.
24613
24614 A forced failure will cause authentication to defer.
24615
24616 If using this option, it may make sense to set the &%server_condition%&
24617 option to be simply "true".
24618
24619
24620 .option server_realm gsasl string&!! unset
24621 This specifies the SASL realm that the server claims to be in.
24622 Some mechanisms will use this data.
24623
24624
24625 .option server_scram_iter gsasl string&!! unset
24626 This option provides data for the SCRAM family of mechanisms.
24627 &$auth1$& is not available at evaluation time.
24628 (This may change, as we receive feedback on use)
24629
24630
24631 .option server_scram_salt gsasl string&!! unset
24632 This option provides data for the SCRAM family of mechanisms.
24633 &$auth1$& is not available at evaluation time.
24634 (This may change, as we receive feedback on use)
24635
24636
24637 .option server_service gsasl string &`smtp`&
24638 This is the SASL service that the server claims to implement.
24639 Some mechanisms will use this data.
24640
24641
24642 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
24643 .vindex "&$auth1$&, &$auth2$&, etc"
24644 These may be set when evaluating specific options, as detailed above.
24645 They will also be set when evaluating &%server_condition%&.
24646
24647 Unless otherwise stated below, the &(gsasl)& integration will use the following
24648 meanings for these variables:
24649
24650 .ilist
24651 .vindex "&$auth1$&"
24652 &$auth1$&: the &'authentication id'&
24653 .next
24654 .vindex "&$auth2$&"
24655 &$auth2$&: the &'authorization id'&
24656 .next
24657 .vindex "&$auth3$&"
24658 &$auth3$&: the &'realm'&
24659 .endlist
24660
24661 On a per-mechanism basis:
24662
24663 .ilist
24664 .cindex "authentication" "EXTERNAL"
24665 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
24666 the &%server_condition%& option must be present.
24667 .next
24668 .cindex "authentication" "ANONYMOUS"
24669 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
24670 the &%server_condition%& option must be present.
24671 .next
24672 .cindex "authentication" "GSSAPI"
24673 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
24674 &$auth2$& will be set to the &'authorization id'&,
24675 the &%server_condition%& option must be present.
24676 .endlist
24677
24678 An &'anonymous token'& is something passed along as an unauthenticated
24679 identifier; this is analogous to FTP anonymous authentication passing an
24680 email address, or software-identifier@, as the "password".
24681
24682
24683 An example showing the password having the realm specified in the callback
24684 and demonstrating a Cyrus SASL to GSASL migration approach is:
24685 .code
24686 gsasl_cyrusless_crammd5:
24687   driver = gsasl
24688   public_name = CRAM-MD5
24689   server_realm = imap.example.org
24690   server_password = ${lookup{$auth1:$auth3:userPassword}\
24691                     dbmjz{/etc/sasldb2}{$value}fail}
24692   server_set_id = ${quote:$auth1}
24693   server_condition = yes
24694 .endd
24695
24696 .wen
24697
24698 . ////////////////////////////////////////////////////////////////////////////
24699 . ////////////////////////////////////////////////////////////////////////////
24700
24701 .new
24702 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
24703 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
24704 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
24705 .cindex "authentication" "GSSAPI"
24706 .cindex "authentication" "Kerberos"
24707 The &(heimdal_gssapi)& authenticator provides server integration for the
24708 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
24709 reliably.
24710
24711 .option server_hostname heimdal_gssapi string&!! "see below"
24712 This option selects the hostname that is used, with &%server_service%&,
24713 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
24714 identifier.  The default value is &`$primary_hostname`&.
24715
24716 .option server_keytab heimdal_gssapi string&!! unset
24717 If set, then Heimdal will not use the system default keytab (typically
24718 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
24719 The value should be a pathname, with no &"file:"& prefix.
24720
24721 .option server_service heimdal_gssapi string&!! "smtp"
24722 This option specifies the service identifier used, in conjunction with
24723 &%server_hostname%&, for building the identifer for finding credentials
24724 from the keytab.
24725
24726
24727 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
24728 Beware that these variables will typically include a realm, thus will appear
24729 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
24730 not verified, so a malicious client can set it to anything.
24731
24732 The &$auth1$& field should be safely trustable as a value from the Key
24733 Distribution Center.  Note that these are not quite email addresses.
24734 Each identifier is for a role, and so the left-hand-side may include a
24735 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
24736
24737 .vindex "&$auth1$&, &$auth2$&, etc"
24738 .ilist
24739 .vindex "&$auth1$&"
24740 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
24741 .next
24742 .vindex "&$auth2$&"
24743 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
24744 authentication.  If that was empty, this will also be set to the
24745 GSS Display Name.
24746 .endlist
24747
24748 .wen
24749
24750 . ////////////////////////////////////////////////////////////////////////////
24751 . ////////////////////////////////////////////////////////////////////////////
24752
24753 .chapter "The spa authenticator" "CHAPspa"
24754 .scindex IIDspaauth1 "&(spa)& authenticator"
24755 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24756 .cindex "authentication" "Microsoft Secure Password"
24757 .cindex "authentication" "NTLM"
24758 .cindex "Microsoft Secure Password Authentication"
24759 .cindex "NTLM authentication"
24760 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24761 Password Authentication'& mechanism,
24762 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24763 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24764 taken from the Samba project (&url(http://www.samba.org)). The code for the
24765 server side was subsequently contributed by Tom Kistner. The mechanism works as
24766 follows:
24767
24768 .ilist
24769 After the AUTH command has been accepted, the client sends an SPA
24770 authentication request based on the user name and optional domain.
24771 .next
24772 The server sends back a challenge.
24773 .next
24774 The client builds a challenge response which makes use of the user's password
24775 and sends it to the server, which then accepts or rejects it.
24776 .endlist
24777
24778 Encryption is used to protect the password in transit.
24779
24780
24781
24782 .section "Using spa as a server" "SECID179"
24783 .cindex "options" "&(spa)& authenticator (server)"
24784 The &(spa)& authenticator has just one server option:
24785
24786 .option server_password spa string&!! unset
24787 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24788 This option is expanded, and the result must be the cleartext password for the
24789 authenticating user, whose name is at this point in &$auth1$&. For
24790 compatibility with previous releases of Exim, the user name is also placed in
24791 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24792 it can lead to confusion in string expansions that also use numeric variables
24793 for other things. For example:
24794 .code
24795 spa:
24796   driver = spa
24797   public_name = NTLM
24798   server_password = \
24799     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24800 .endd
24801 If the expansion is forced to fail, authentication fails. Any other expansion
24802 failure causes a temporary error code to be returned.
24803
24804
24805
24806
24807
24808 .section "Using spa as a client" "SECID180"
24809 .cindex "options" "&(spa)& authenticator (client)"
24810 The &(spa)& authenticator has the following client options:
24811
24812
24813
24814 .option client_domain spa string&!! unset
24815 This option specifies an optional domain for the authentication.
24816
24817
24818 .option client_password spa string&!! unset
24819 This option specifies the user's password, and must be set.
24820
24821
24822 .option client_username spa string&!! unset
24823 This option specifies the user name, and must be set. Here is an example of a
24824 configuration of this authenticator for use with the mail servers at
24825 &'msn.com'&:
24826 .code
24827 msn:
24828   driver = spa
24829   public_name = MSN
24830   client_username = msn/msn_username
24831   client_password = msn_plaintext_password
24832   client_domain = DOMAIN_OR_UNSET
24833 .endd
24834 .ecindex IIDspaauth1
24835 .ecindex IIDspaauth2
24836
24837
24838
24839
24840
24841 . ////////////////////////////////////////////////////////////////////////////
24842 . ////////////////////////////////////////////////////////////////////////////
24843
24844 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24845          "Encrypted SMTP connections"
24846 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24847 .scindex IIDencsmtp2 "SMTP" "encryption"
24848 .cindex "TLS" "on SMTP connection"
24849 .cindex "OpenSSL"
24850 .cindex "GnuTLS"
24851 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24852 Sockets Layer), is implemented by making use of the OpenSSL library or the
24853 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24854 cryptographic code in the Exim distribution itself for implementing TLS. In
24855 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24856 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24857 You also need to understand the basic concepts of encryption at a managerial
24858 level, and in particular, the way that public keys, private keys, and
24859 certificates are used.
24860
24861 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24862 connection is established, the client issues a STARTTLS command. If the
24863 server accepts this, the client and the server negotiate an encryption
24864 mechanism. If the negotiation succeeds, the data that subsequently passes
24865 between them is encrypted.
24866
24867 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24868 and if so, what cipher suite is in use, whether the client supplied a
24869 certificate, and whether or not that certificate was verified. This makes it
24870 possible for an Exim server to deny or accept certain commands based on the
24871 encryption state.
24872
24873 &*Warning*&: Certain types of firewall and certain anti-virus products can
24874 disrupt TLS connections. You need to turn off SMTP scanning for these products
24875 in order to get TLS to work.
24876
24877
24878
24879 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24880          "SECID284"
24881 .cindex "ssmtp protocol"
24882 .cindex "smtps protocol"
24883 .cindex "SMTP" "ssmtp protocol"
24884 .cindex "SMTP" "smtps protocol"
24885 Early implementations of encrypted SMTP used a different TCP port from normal
24886 SMTP, and expected an encryption negotiation to start immediately, instead of
24887 waiting for a STARTTLS command from the client using the standard SMTP
24888 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24889 allocated for this purpose.
24890
24891 This approach was abandoned when encrypted SMTP was standardized, but there are
24892 still some legacy clients that use it. Exim supports these clients by means of
24893 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24894 numbers; the most common use is expected to be:
24895 .code
24896 tls_on_connect_ports = 465
24897 .endd
24898 The port numbers specified by this option apply to all SMTP connections, both
24899 via the daemon and via &'inetd'&. You still need to specify all the ports that
24900 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24901 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24902 an extra port &-- rather, it specifies different behaviour on a port that is
24903 defined elsewhere.
24904
24905 There is also a &%-tls-on-connect%& command line option. This overrides
24906 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24907
24908
24909
24910
24911
24912
24913 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24914 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24915 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24916 followed later, when the first versions of GnuTLS were released. To build Exim
24917 to use GnuTLS, you need to set
24918 .code
24919 USE_GNUTLS=yes
24920 .endd
24921 in Local/Makefile, in addition to
24922 .code
24923 SUPPORT_TLS=yes
24924 .endd
24925 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24926 include files and libraries for GnuTLS can be found.
24927
24928 There are some differences in usage when using GnuTLS instead of OpenSSL:
24929
24930 .ilist
24931 The &%tls_verify_certificates%& option must contain the name of a file, not the
24932 name of a directory (for OpenSSL it can be either).
24933 .next
24934 The &%tls_dhparam%& option is ignored, because early versions of GnuTLS had no
24935 facility for varying its Diffie-Hellman parameters. I understand that this has
24936 changed, but Exim has not been updated to provide this facility.
24937 .next
24938 .vindex "&$tls_peerdn$&"
24939 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24940 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24941 affects the value of the &$tls_peerdn$& variable.
24942 .next
24943 OpenSSL identifies cipher suites using hyphens as separators, for example:
24944 DES-CBC3-SHA. GnuTLS uses underscores, for example: RSA_ARCFOUR_SHA. What is
24945 more, OpenSSL complains if underscores are present in a cipher list. To make
24946 life simpler, Exim changes underscores to hyphens for OpenSSL and hyphens to
24947 underscores for GnuTLS when processing lists of cipher suites in the
24948 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24949 option).
24950 .next
24951 The &%tls_require_ciphers%& options operate differently, as described in the
24952 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24953 .new
24954 .next
24955 Some other recently added features may only be available in one or the other.
24956 This should be documented with the feature.  If the documentation does not
24957 explicitly state that the feature is infeasible in the other TLS
24958 implementation, then patches are welcome.
24959 .wen
24960 .endlist
24961
24962
24963 .section "GnuTLS parameter computation" "SECID181"
24964 .new
24965 GnuTLS uses D-H parameters that may take a substantial amount of time
24966 to compute. It is unreasonable to re-compute them for every TLS session.
24967 Therefore, Exim keeps this data in a file in its spool directory, called
24968 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
24969 of bits requested.
24970 The file is owned by the Exim user and is readable only by
24971 its owner. Every Exim process that start up GnuTLS reads the D-H
24972 parameters from this file. If the file does not exist, the first Exim process
24973 that needs it computes the data and writes it to a temporary file which is
24974 renamed once it is complete. It does not matter if several Exim processes do
24975 this simultaneously (apart from wasting a few resources). Once a file is in
24976 place, new Exim processes immediately start using it.
24977
24978 For maximum security, the parameters that are stored in this file should be
24979 recalculated periodically, the frequency depending on your paranoia level.
24980 Arranging this is easy in principle; just delete the file when you want new
24981 values to be computed. However, there may be a problem. The calculation of new
24982 parameters needs random numbers, and these are obtained from &_/dev/random_&.
24983 If the system is not very active, &_/dev/random_& may delay returning data
24984 until enough randomness (entropy) is available. This may cause Exim to hang for
24985 a substantial amount of time, causing timeouts on incoming connections.
24986
24987 The solution is to generate the parameters externally to Exim. They are stored
24988 in &_gnutls-params-N_& in PEM format, which means that they can be
24989 generated externally using the &(certtool)& command that is part of GnuTLS.
24990
24991 To replace the parameters with new ones, instead of deleting the file
24992 and letting Exim re-create it, you can generate new parameters using
24993 &(certtool)& and, when this has been done, replace Exim's cache file by
24994 renaming. The relevant commands are something like this:
24995 .code
24996 # ls
24997 [ look for file; assume gnutls-params-1024 is the most recent ]
24998 # rm -f new-params
24999 # touch new-params
25000 # chown exim:exim new-params
25001 # chmod 0600 new-params
25002 # certtool --generate-dh-params --bits 1024 >>new-params
25003 # chmod 0400 new-params
25004 # mv new-params gnutls-params-1024
25005 .endd
25006 If Exim never has to generate the parameters itself, the possibility of
25007 stalling is removed.
25008
25009 The filename changed in Exim 4.78, to gain the -bits suffix.  The value which
25010 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25011 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25012 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25013 and Exim does so.  Exim thus removes itself from the policy decision, and the
25014 filename and bits used change as the GnuTLS maintainers change the value for
25015 their parameter &`GNUTLS_SEC_PARAM_NORMAL`&.  At the time of writing, this
25016 gives 2432 bits.
25017 .wen
25018
25019
25020 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25021 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25022 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25023 There is a function in the OpenSSL library that can be passed a list of cipher
25024 suites before the cipher negotiation takes place. This specifies which ciphers
25025 are acceptable. The list is colon separated and may contain names like
25026 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25027 directly to this function call. The following quotation from the OpenSSL
25028 documentation specifies what forms of item are allowed in the cipher string:
25029
25030 .ilist
25031 It can consist of a single cipher suite such as RC4-SHA.
25032 .next
25033 It can represent a list of cipher suites containing a certain algorithm,
25034 or cipher suites of a certain type. For example SHA1 represents all
25035 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25036 SSL v3 algorithms.
25037 .next
25038 Lists of cipher suites can be combined in a single cipher string using
25039 the + character. This is used as a logical and operation. For example
25040 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25041 algorithms.
25042 .endlist
25043
25044 Each cipher string can be optionally preceded by one of the characters &`!`&,
25045 &`-`& or &`+`&.
25046 .ilist
25047 If &`!`& is used, the ciphers are permanently deleted from the list. The
25048 ciphers deleted can never reappear in the list even if they are explicitly
25049 stated.
25050 .next
25051 If &`-`& is used, the ciphers are deleted from the list, but some or all
25052 of the ciphers can be added again by later options.
25053 .next
25054 If &`+`& is used, the ciphers are moved to the end of the list. This
25055 option does not add any new ciphers; it just moves matching existing ones.
25056 .endlist
25057
25058 If none of these characters is present, the string is interpreted as
25059 a list of ciphers to be appended to the current preference list. If the list
25060 includes any ciphers already present they will be ignored: that is, they will
25061 not be moved to the end of the list.
25062 .endlist
25063
25064
25065
25066 .new
25067 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25068          "SECTreqciphgnu"
25069 .cindex "GnuTLS" "specifying parameters for"
25070 .cindex "TLS" "specifying ciphers (GnuTLS)"
25071 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25072 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25073 .cindex "TLS" "specifying protocols (GnuTLS)"
25074 .cindex "TLS" "specifying priority string (GnuTLS)"
25075 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25076 The GnuTLS library allows the caller to provide a "priority string", documented
25077 as part of the &[gnutls_priority_init]& function.  This is very similar to the
25078 ciphersuite specification in OpenSSL.
25079
25080 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
25081
25082 The &%tls_require_ciphers%& option is available both as an global option,
25083 controlling how Exim behaves as a server, and also as an option of the
25084 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
25085 the value is string expanded.  The resulting string is not an Exim list and
25086 the string is given to the GnuTLS library, so that Exim does not need to be
25087 aware of future feature enhancements of GnuTLS.
25088
25089 Documentation of the strings accepted may be found in the GnuTLS manual, under
25090 "Priority strings".  This is online as
25091 &url(http://www.gnu.org/software/gnutls/manual/html_node/Priority-Strings.html).
25092
25093 Prior to Exim 4.78, an older API of GnuTLS was used, and Exim supported three
25094 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
25095 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
25096 .wen
25097
25098
25099 .section "Configuring an Exim server to use TLS" "SECID182"
25100 .cindex "TLS" "configuring an Exim server"
25101 When Exim has been built with TLS support, it advertises the availability of
25102 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25103 but not to any others. The default value of this option is unset, which means
25104 that STARTTLS is not advertised at all. This default is chosen because you
25105 need to set some other options in order to make TLS available, and also it is
25106 sensible for systems that want to use TLS only as a client.
25107
25108 If a client issues a STARTTLS command and there is some configuration
25109 problem in the server, the command is rejected with a 454 error. If the client
25110 persists in trying to issue SMTP commands, all except QUIT are rejected
25111 with the error
25112 .code
25113 554 Security failure
25114 .endd
25115 If a STARTTLS command is issued within an existing TLS session, it is
25116 rejected with a 554 error code.
25117
25118 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25119 match some hosts. You can, of course, set it to * to match all hosts.
25120 However, this is not all you need to do. TLS sessions to a server won't work
25121 without some further configuration at the server end.
25122
25123 It is rumoured that all existing clients that support TLS/SSL use RSA
25124 encryption. To make this work you need to set, in the server,
25125 .code
25126 tls_certificate = /some/file/name
25127 tls_privatekey = /some/file/name
25128 .endd
25129 These options are, in fact, expanded strings, so you can make them depend on
25130 the identity of the client that is connected if you wish. The first file
25131 contains the server's X509 certificate, and the second contains the private key
25132 that goes with it. These files need to be readable by the Exim user, and must
25133 always be given as full path names. They can be the same file if both the
25134 certificate and the key are contained within it. If &%tls_privatekey%& is not
25135 set, or if its expansion is forced to fail or results in an empty string, this
25136 is assumed to be the case. The certificate file may also contain intermediate
25137 certificates that need to be sent to the client to enable it to authenticate
25138 the server's certificate.
25139
25140 If you do not understand about certificates and keys, please try to find a
25141 source of this background information, which is not Exim-specific. (There are a
25142 few comments below in section &<<SECTcerandall>>&.)
25143
25144 &*Note*&: These options do not apply when Exim is operating as a client &--
25145 they apply only in the case of a server. If you need to use a certificate in an
25146 Exim client, you must set the options of the same names in an &(smtp)&
25147 transport.
25148
25149 With just these options, an Exim server will be able to use TLS. It does not
25150 require the client to have a certificate (but see below for how to insist on
25151 this). There is one other option that may be needed in other situations. If
25152 .code
25153 tls_dhparam = /some/file/name
25154 .endd
25155 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25156 with the parameters contained in the file. This increases the set of cipher
25157 suites that the server supports. See the command
25158 .code
25159 openssl dhparam
25160 .endd
25161 for a way of generating this data. At present, &%tls_dhparam%& is used only
25162 when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used.
25163
25164 The strings supplied for these three options are expanded every time a client
25165 host connects. It is therefore possible to use different certificates and keys
25166 for different hosts, if you so wish, by making use of the client's IP address
25167 in &$sender_host_address$& to control the expansion. If a string expansion is
25168 forced to fail, Exim behaves as if the option is not set.
25169
25170 .cindex "cipher" "logging"
25171 .cindex "log" "TLS cipher"
25172 .vindex "&$tls_cipher$&"
25173 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
25174 an incoming TLS connection. It is included in the &'Received:'& header of an
25175 incoming message (by default &-- you can, of course, change this), and it is
25176 also included in the log line that records a message's arrival, keyed by
25177 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25178 condition can be used to test for specific cipher suites in ACLs.
25179 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
25180 &<<SECID185>>&.)
25181
25182 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25183 can check the name of the cipher suite and vary their actions accordingly. The
25184 cipher suite names vary, depending on which TLS library is being used. For
25185 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25186 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25187 documentation for more details.
25188
25189
25190 .section "Requesting and verifying client certificates" "SECID183"
25191 .cindex "certificate" "verification of client"
25192 .cindex "TLS" "client certificate verification"
25193 If you want an Exim server to request a certificate when negotiating a TLS
25194 session with a client, you must set either &%tls_verify_hosts%& or
25195 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25196 apply to all TLS connections. For any host that matches one of these options,
25197 Exim requests a certificate as part of the setup of the TLS session. The
25198 contents of the certificate are verified by comparing it with a list of
25199 expected certificates. These must be available in a file or,
25200 for OpenSSL only (not GnuTLS), a directory, identified by
25201 &%tls_verify_certificates%&.
25202
25203 A file can contain multiple certificates, concatenated end to end. If a
25204 directory is used
25205 (OpenSSL only),
25206 each certificate must be in a separate file, with a name (or a symbolic link)
25207 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25208 certificate. You can compute the relevant hash by running the command
25209 .code
25210 openssl x509 -hash -noout -in /cert/file
25211 .endd
25212 where &_/cert/file_& contains a single certificate.
25213
25214 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25215 what happens if the client does not supply a certificate, or if the certificate
25216 does not match any of the certificates in the collection named by
25217 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25218 attempt to set up a TLS session is aborted, and the incoming connection is
25219 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25220 session continues. ACLs that run for subsequent SMTP commands can detect the
25221 fact that no certificate was verified, and vary their actions accordingly. For
25222 example, you can insist on a certificate before accepting a message for
25223 relaying, but not when the message is destined for local delivery.
25224
25225 .vindex "&$tls_peerdn$&"
25226 When a client supplies a certificate (whether it verifies or not), the value of
25227 the Distinguished Name of the certificate is made available in the variable
25228 &$tls_peerdn$& during subsequent processing of the message.
25229
25230 .cindex "log" "distinguished name"
25231 Because it is often a long text string, it is not included in the log line or
25232 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25233 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25234 &%received_header_text%& to change the &'Received:'& header. When no
25235 certificate is supplied, &$tls_peerdn$& is empty.
25236
25237
25238 .section "Revoked certificates" "SECID184"
25239 .cindex "TLS" "revoked certificates"
25240 .cindex "revocation list"
25241 .cindex "certificate" "revocation list"
25242 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25243 certificates are revoked. If you have such a list, you can pass it to an Exim
25244 server using the global option called &%tls_crl%& and to an Exim client using
25245 an identically named option for the &(smtp)& transport. In each case, the value
25246 of the option is expanded and must then be the name of a file that contains a
25247 CRL in PEM format.
25248
25249
25250 .section "Configuring an Exim client to use TLS" "SECID185"
25251 .cindex "cipher" "logging"
25252 .cindex "log" "TLS cipher"
25253 .cindex "log" "distinguished name"
25254 .cindex "TLS" "configuring an Exim client"
25255 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25256 deliveries as well as to incoming, the latter one causing logging of the
25257 server certificate's DN. The remaining client configuration for TLS is all
25258 within the &(smtp)& transport.
25259
25260 It is not necessary to set any options to have TLS work in the &(smtp)&
25261 transport. If Exim is built with TLS support, and TLS is advertised by a
25262 server, the &(smtp)& transport always tries to start a TLS session. However,
25263 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25264 transport) to a list of server hosts for which TLS should not be used.
25265
25266 If you do not want Exim to attempt to send messages unencrypted when an attempt
25267 to set up an encrypted connection fails in any way, you can set
25268 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25269 those hosts, delivery is always deferred if an encrypted connection cannot be
25270 set up. If there are any other hosts for the address, they are tried in the
25271 usual way.
25272
25273 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25274 the message unencrypted. It always does this if the response to STARTTLS is
25275 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25276 session after a success response code, what happens is controlled by the
25277 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25278 delivery to this host is deferred, and other hosts (if available) are tried. If
25279 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25280 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25281 negotiation fails, Exim closes the current connection (because it is in an
25282 unknown state), opens a new one to the same host, and then tries the delivery
25283 unencrypted.
25284
25285 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25286 transport provide the client with a certificate, which is passed to the server
25287 if it requests it. If the server is Exim, it will request a certificate only if
25288 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25289
25290 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25291 must name a file or,
25292 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25293 expected server certificates. The client verifies the server's certificate
25294 against this collection, taking into account any revoked certificates that are
25295 in the list defined by &%tls_crl%&.
25296
25297 If
25298 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25299 list of permitted cipher suites. If either of these checks fails, delivery to
25300 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25301 alternative hosts, if any.
25302
25303  &*Note*&:
25304 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25305 is operating as a client. Exim does not assume that a server certificate (set
25306 by the global options of the same name) should also be used when operating as a
25307 client.
25308
25309 .vindex "&$host$&"
25310 .vindex "&$host_address$&"
25311 All the TLS options in the &(smtp)& transport are expanded before use, with
25312 &$host$& and &$host_address$& containing the name and address of the server to
25313 which the client is connected. Forced failure of an expansion causes Exim to
25314 behave as if the relevant option were unset.
25315
25316 .vindex &$tls_bits$&
25317 .vindex &$tls_cipher$&
25318 .vindex &$tls_peerdn$&
25319 .vindex &$tls_sni$&
25320 Before an SMTP connection is established, the
25321 &$tls_bits$&, &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25322 variables are emptied. (Until the first connection, they contain the values
25323 that were set when the message was received.) If STARTTLS is subsequently
25324 successfully obeyed, these variables are set to the relevant values for the
25325 outgoing connection.
25326
25327
25328
25329 .new
25330 .section "Use of TLS Server Name Indication" "SECTtlssni"
25331 .cindex "TLS" "Server Name Indication"
25332 .vindex "&$tls_sni$&"
25333 .oindex "&%tls_sni%&"
25334 With TLS1.0 or above, there is an extension mechanism by which extra
25335 information can be included at various points in the protocol.  One of these
25336 extensions, documented in RFC 6066 (and before that RFC 4366) is
25337 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
25338 client in the initial handshake, so that the server can examine the servername
25339 within and possibly choose to use different certificates and keys (and more)
25340 for this session.
25341
25342 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
25343 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
25344 address.
25345
25346 With SMTP to MX, there are the same problems here as in choosing the identity
25347 against which to validate a certificate: you can't rely on insecure DNS to
25348 provide the identity which you then cryptographically verify.  So this will
25349 be of limited use in that environment.
25350
25351 With SMTP to Submission, there is a well-defined hostname which clients are
25352 connecting to and can validate certificates against.  Thus clients &*can*&
25353 choose to include this information in the TLS negotiation.  If this becomes
25354 wide-spread, then hosters can choose to present different certificates to
25355 different clients.  Or even negotiate different cipher suites.
25356
25357 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
25358 if not empty, will be sent on a TLS session as part of the handshake.  There's
25359 nothing more to it.  Choosing a sensible value not derived insecurely is the
25360 only point of caution.  The &$tls_sni$& variable will be set to this string
25361 for the lifetime of the client connection (including during authentication).
25362
25363 Except during SMTP client sessions, if &$tls_sni$& is set then it is a string
25364 received from a client.
25365 It can be logged with the &%log_selector%& item &`+tls_sni`&.
25366
25367 If the string &`tls_sni`& appears in the main section's &%tls_certificate%&
25368 option (prior to expansion) then the following options will be re-expanded
25369 during TLS session handshake, to permit alternative values to be chosen:
25370
25371 .ilist
25372 .vindex "&%tls_certificate%&"
25373 &%tls_certificate%&
25374 .next
25375 .vindex "&%tls_crl%&"
25376 &%tls_crl%&
25377 .next
25378 .vindex "&%tls_privatekey%&"
25379 &%tls_privatekey%&
25380 .next
25381 .vindex "&%tls_verify_certificates%&"
25382 &%tls_verify_certificates%&
25383 .endlist
25384
25385 Great care should be taken to deal with matters of case, various injection
25386 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
25387 can always be referenced; it is important to remember that &$tls_sni$& is
25388 arbitrary unverified data provided prior to authentication.
25389
25390 The Exim developers are proceeding cautiously and so far no other TLS options
25391 are re-expanded.
25392
25393 When Exim is built againt OpenSSL, OpenSSL must have been built with support
25394 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
25395 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
25396 see &`-servername`& in the output, then OpenSSL has support.
25397
25398 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
25399 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
25400 built, then you have SNI support).
25401 .wen
25402
25403
25404
25405 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
25406          "SECTmulmessam"
25407 .cindex "multiple SMTP deliveries with TLS"
25408 .cindex "TLS" "multiple message deliveries"
25409 Exim sends multiple messages down the same TCP/IP connection by starting up
25410 an entirely new delivery process for each message, passing the socket from
25411 one process to the next. This implementation does not fit well with the use
25412 of TLS, because there is quite a lot of state information associated with a TLS
25413 connection, not just a socket identification. Passing all the state information
25414 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
25415 session before passing the socket to a new process. The new process may then
25416 try to start a new TLS session, and if successful, may try to re-authenticate
25417 if AUTH is in use, before sending the next message.
25418
25419 The RFC is not clear as to whether or not an SMTP session continues in clear
25420 after TLS has been shut down, or whether TLS may be restarted again later, as
25421 just described. However, if the server is Exim, this shutdown and
25422 reinitialization works. It is not known which (if any) other servers operate
25423 successfully if the client closes a TLS session and continues with unencrypted
25424 SMTP, but there are certainly some that do not work. For such servers, Exim
25425 should not pass the socket to another process, because the failure of the
25426 subsequent attempt to use it would cause Exim to record a temporary host error,
25427 and delay other deliveries to that host.
25428
25429 To test for this case, Exim sends an EHLO command to the server after
25430 closing down the TLS session. If this fails in any way, the connection is
25431 closed instead of being passed to a new delivery process, but no retry
25432 information is recorded.
25433
25434 There is also a manual override; you can set &%hosts_nopass_tls%& on the
25435 &(smtp)& transport to match those hosts for which Exim should not pass
25436 connections to new processes if TLS has been used.
25437
25438
25439
25440
25441 .section "Certificates and all that" "SECTcerandall"
25442 .cindex "certificate" "references to discussion"
25443 In order to understand fully how TLS works, you need to know about
25444 certificates, certificate signing, and certificate authorities. This is not the
25445 place to give a tutorial, especially as I do not know very much about it
25446 myself. Some helpful introduction can be found in the FAQ for the SSL addition
25447 to Apache, currently at
25448 .display
25449 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
25450 .endd
25451 Other parts of the &'modssl'& documentation are also helpful, and have
25452 links to further files.
25453 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
25454 0-201-61598-3), contains both introductory and more in-depth descriptions.
25455 Some sample programs taken from the book are available from
25456 .display
25457 &url(http://www.rtfm.com/openssl-examples/)
25458 .endd
25459
25460
25461 .section "Certificate chains" "SECID186"
25462 The file named by &%tls_certificate%& may contain more than one
25463 certificate. This is useful in the case where the certificate that is being
25464 sent is validated by an intermediate certificate which the other end does
25465 not have. Multiple certificates must be in the correct order in the file.
25466 First the host's certificate itself, then the first intermediate
25467 certificate to validate the issuer of the host certificate, then the next
25468 intermediate certificate to validate the issuer of the first intermediate
25469 certificate, and so on, until finally (optionally) the root certificate.
25470 The root certificate must already be trusted by the recipient for
25471 validation to succeed, of course, but if it's not preinstalled, sending the
25472 root certificate along with the rest makes it available for the user to
25473 install if the receiving end is a client MUA that can interact with a user.
25474
25475
25476 .section "Self-signed certificates" "SECID187"
25477 .cindex "certificate" "self-signed"
25478 You can create a self-signed certificate using the &'req'& command provided
25479 with OpenSSL, like this:
25480 .code
25481 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
25482             -days 9999 -nodes
25483 .endd
25484 &_file1_& and &_file2_& can be the same file; the key and the certificate are
25485 delimited and so can be identified independently. The &%-days%& option
25486 specifies a period for which the certificate is valid. The &%-nodes%& option is
25487 important: if you do not set it, the key is encrypted with a passphrase
25488 that you are prompted for, and any use that is made of the key causes more
25489 prompting for the passphrase. This is not helpful if you are going to use
25490 this certificate and key in an MTA, where prompting is not possible.
25491
25492 A self-signed certificate made in this way is sufficient for testing, and
25493 may be adequate for all your requirements if you are mainly interested in
25494 encrypting transfers, and not in secure identification.
25495
25496 However, many clients require that the certificate presented by the server be a
25497 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
25498 certificate. In this situation, the self-signed certificate described above
25499 must be installed on the client host as a trusted root &'certification
25500 authority'& (CA), and the certificate used by Exim must be a user certificate
25501 signed with that self-signed certificate.
25502
25503 For information on creating self-signed CA certificates and using them to sign
25504 user certificates, see the &'General implementation overview'& chapter of the
25505 Open-source PKI book, available online at
25506 &url(http://ospkibook.sourceforge.net/).
25507 .ecindex IIDencsmtp1
25508 .ecindex IIDencsmtp2
25509
25510
25511
25512 . ////////////////////////////////////////////////////////////////////////////
25513 . ////////////////////////////////////////////////////////////////////////////
25514
25515 .chapter "Access control lists" "CHAPACL"
25516 .scindex IIDacl "&ACL;" "description"
25517 .cindex "control of incoming mail"
25518 .cindex "message" "controlling incoming"
25519 .cindex "policy control" "access control lists"
25520 Access Control Lists (ACLs) are defined in a separate section of the run time
25521 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
25522 name, terminated by a colon. Here is a complete ACL section that contains just
25523 one very small ACL:
25524 .code
25525 begin acl
25526 small_acl:
25527   accept   hosts = one.host.only
25528 .endd
25529 You can have as many lists as you like in the ACL section, and the order in
25530 which they appear does not matter. The lists are self-terminating.
25531
25532 The majority of ACLs are used to control Exim's behaviour when it receives
25533 certain SMTP commands. This applies both to incoming TCP/IP connections, and
25534 when a local process submits a message using SMTP by specifying the &%-bs%&
25535 option. The most common use is for controlling which recipients are accepted
25536 in incoming messages. In addition, you can define an ACL that is used to check
25537 local non-SMTP messages. The default configuration file contains an example of
25538 a realistic ACL for checking RCPT commands. This is discussed in chapter
25539 &<<CHAPdefconfil>>&.
25540
25541
25542 .section "Testing ACLs" "SECID188"
25543 The &%-bh%& command line option provides a way of testing your ACL
25544 configuration locally by running a fake SMTP session with which you interact.
25545 The host &'relay-test.mail-abuse.org'& provides a service for checking your
25546 relaying configuration (see section &<<SECTcheralcon>>& for more details).
25547
25548
25549
25550 .section "Specifying when ACLs are used" "SECID189"
25551 .cindex "&ACL;" "options for specifying"
25552 In order to cause an ACL to be used, you have to name it in one of the relevant
25553 options in the main part of the configuration. These options are:
25554 .cindex "AUTH" "ACL for"
25555 .cindex "DATA" "ACLs for"
25556 .cindex "ETRN" "ACL for"
25557 .cindex "EXPN" "ACL for"
25558 .cindex "HELO" "ACL for"
25559 .cindex "EHLO" "ACL for"
25560 .cindex "MAIL" "ACL for"
25561 .cindex "QUIT, ACL for"
25562 .cindex "RCPT" "ACL for"
25563 .cindex "STARTTLS, ACL for"
25564 .cindex "VRFY" "ACL for"
25565 .cindex "SMTP" "connection, ACL for"
25566 .cindex "non-SMTP messages" "ACLs for"
25567 .cindex "MIME content scanning" "ACL for"
25568
25569 .table2 140pt
25570 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
25571 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
25572 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
25573 .irow &%acl_smtp_auth%&        "ACL for AUTH"
25574 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
25575 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
25576 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
25577 .irow &%acl_smtp_expn%&        "ACL for EXPN"
25578 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
25579 .irow &%acl_smtp_mail%&        "ACL for MAIL"
25580 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
25581 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
25582 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
25583 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
25584 .irow &%acl_smtp_quit%&        "ACL for QUIT"
25585 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
25586 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
25587 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
25588 .endtable
25589
25590 For example, if you set
25591 .code
25592 acl_smtp_rcpt = small_acl
25593 .endd
25594 the little ACL defined above is used whenever Exim receives a RCPT command
25595 in an SMTP dialogue. The majority of policy tests on incoming messages can be
25596 done when RCPT commands arrive. A rejection of RCPT should cause the
25597 sending MTA to give up on the recipient address contained in the RCPT
25598 command, whereas rejection at other times may cause the client MTA to keep on
25599 trying to deliver the message. It is therefore recommended that you do as much
25600 testing as possible at RCPT time.
25601
25602
25603 .section "The non-SMTP ACLs" "SECID190"
25604 .cindex "non-SMTP messages" "ACLs for"
25605 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
25606 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
25607 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
25608 the state of the SMTP connection such as encryption and authentication) are not
25609 relevant and are forbidden in these ACLs. However, the sender and recipients
25610 are known, so the &%senders%& and &%sender_domains%& conditions and the
25611 &$sender_address$& and &$recipients$& variables can be used. Variables such as
25612 &$authenticated_sender$& are also available. You can specify added header lines
25613 in any of these ACLs.
25614
25615 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
25616 non-SMTP message, before any of the message has been read. (This is the
25617 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
25618 batched SMTP input, it runs after the DATA command has been reached. The
25619 result of this ACL is ignored; it cannot be used to reject a message. If you
25620 really need to, you could set a value in an ACL variable here and reject based
25621 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
25622 controls, and in particular, it can be used to set
25623 .code
25624 control = suppress_local_fixups
25625 .endd
25626 This cannot be used in the other non-SMTP ACLs because by the time they are
25627 run, it is too late.
25628
25629 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
25630 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25631
25632 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
25633 kind of rejection is treated as permanent, because there is no way of sending a
25634 temporary error for these kinds of message.
25635
25636
25637 .section "The SMTP connect ACL" "SECID191"
25638 .cindex "SMTP" "connection, ACL for"
25639 .oindex &%smtp_banner%&
25640 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
25641 session, after the test specified by &%host_reject_connection%& (which is now
25642 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
25643 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
25644 the message override the banner message that is otherwise specified by the
25645 &%smtp_banner%& option.
25646
25647
25648 .section "The EHLO/HELO ACL" "SECID192"
25649 .cindex "EHLO" "ACL for"
25650 .cindex "HELO" "ACL for"
25651 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
25652 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
25653 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
25654 Note that a client may issue more than one EHLO or HELO command in an SMTP
25655 session, and indeed is required to issue a new EHLO or HELO after successfully
25656 setting up encryption following a STARTTLS command.
25657
25658 If the command is accepted by an &%accept%& verb that has a &%message%&
25659 modifier, the message may not contain more than one line (it will be truncated
25660 at the first newline and a panic logged if it does). Such a message cannot
25661 affect the EHLO options that are listed on the second and subsequent lines of
25662 an EHLO response.
25663
25664
25665 .section "The DATA ACLs" "SECID193"
25666 .cindex "DATA" "ACLs for"
25667 Two ACLs are associated with the DATA command, because it is two-stage
25668 command, with two responses being sent to the client.
25669 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
25670 is obeyed. This gives you control after all the RCPT commands, but before
25671 the message itself is received. It offers the opportunity to give a negative
25672 response to the DATA command before the data is transmitted. Header lines
25673 added by MAIL or RCPT ACLs are not visible at this time, but any that
25674 are defined here are visible when the &%acl_smtp_data%& ACL is run.
25675
25676 You cannot test the contents of the message, for example, to verify addresses
25677 in the headers, at RCPT time or when the DATA command is received. Such
25678 tests have to appear in the ACL that is run after the message itself has been
25679 received, before the final response to the DATA command is sent. This is
25680 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
25681 associated with the DATA command.
25682
25683 For both of these ACLs, it is not possible to reject individual recipients. An
25684 error response rejects the entire message. Unfortunately, it is known that some
25685 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
25686 before or after the data) correctly &-- they keep the message on their queues
25687 and try again later, but that is their problem, though it does waste some of
25688 your resources.
25689
25690
25691 .section "The SMTP DKIM ACL" "SECTDKIMACL"
25692 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
25693 enabled (which is the default).
25694
25695 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
25696 received, and is executed for each DKIM signature found in a message.  If not
25697 otherwise specified, the default action is to accept.
25698
25699 For details on the operation of DKIM, see chapter &<<CHID12>>&.
25700
25701
25702 .section "The SMTP MIME ACL" "SECID194"
25703 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
25704 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25705
25706
25707 .section "The QUIT ACL" "SECTQUITACL"
25708 .cindex "QUIT, ACL for"
25709 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
25710 does not affect the response code to QUIT, which is always 221. Thus, the ACL
25711 does not in fact control any access. For this reason, the only verbs that are
25712 permitted are &%accept%& and &%warn%&.
25713
25714 This ACL can be used for tasks such as custom logging at the end of an SMTP
25715 session. For example, you can use ACL variables in other ACLs to count
25716 messages, recipients, etc., and log the totals at QUIT time using one or
25717 more &%logwrite%& modifiers on a &%warn%& verb.
25718
25719 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
25720 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
25721
25722 You do not need to have a final &%accept%&, but if you do, you can use a
25723 &%message%& modifier to specify custom text that is sent as part of the 221
25724 response to QUIT.
25725
25726 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
25727 failure (for example, failure to open a log file, or when Exim is bombing out
25728 because it has detected an unrecoverable error), all SMTP commands from the
25729 client are given temporary error responses until QUIT is received or the
25730 connection is closed. In these special cases, the QUIT ACL does not run.
25731
25732
25733 .section "The not-QUIT ACL" "SECTNOTQUITACL"
25734 .vindex &$acl_smtp_notquit$&
25735 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
25736 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
25737 trouble, such as being unable to write to its log files, this ACL is not run,
25738 because it might try to do things (such as write to log files) that make the
25739 situation even worse.
25740
25741 Like the QUIT ACL, this ACL is provided to make it possible to do customized
25742 logging or to gather statistics, and its outcome is ignored. The &%delay%&
25743 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
25744 and &%warn%&.
25745
25746 .vindex &$smtp_notquit_reason$&
25747 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
25748 to a string that indicates the reason for the termination of the SMTP
25749 connection. The possible values are:
25750 .table2
25751 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
25752 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
25753 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
25754 .irow &`connection-lost`&          "The SMTP connection has been lost"
25755 .irow &`data-timeout`&             "Timeout while reading message data"
25756 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
25757 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
25758 .irow &`signal-exit`&              "SIGTERM or SIGINT"
25759 .irow &`synchronization-error`&    "SMTP synchronization error"
25760 .irow &`tls-failed`&               "TLS failed to start"
25761 .endtable
25762 In most cases when an SMTP connection is closed without having received QUIT,
25763 Exim sends an SMTP response message before actually closing the connection.
25764 With the exception of the &`acl-drop`& case, the default message can be
25765 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
25766 &%drop%& verb in another ACL, it is the message from the other ACL that is
25767 used.
25768
25769
25770 .section "Finding an ACL to use" "SECID195"
25771 .cindex "&ACL;" "finding which to use"
25772 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
25773 you can use different ACLs in different circumstances. For example,
25774 .code
25775 acl_smtp_rcpt = ${if ={25}{$interface_port} \
25776                      {acl_check_rcpt} {acl_check_rcpt_submit} }
25777 .endd
25778 In the default configuration file there are some example settings for
25779 providing an RFC 4409 message submission service on port 587 and a
25780 non-standard &"smtps"& service on port 465. You can use a string
25781 expansion like this to choose an ACL for MUAs on these ports which is
25782 more appropriate for this purpose than the default ACL on port 25.
25783
25784 The expanded string does not have to be the name of an ACL in the
25785 configuration file; there are other possibilities. Having expanded the
25786 string, Exim searches for an ACL as follows:
25787
25788 .ilist
25789 If the string begins with a slash, Exim uses it as a file name, and reads its
25790 contents as an ACL. The lines are processed in the same way as lines in the
25791 Exim configuration file. In particular, continuation lines are supported, blank
25792 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
25793 If the file does not exist or cannot be read, an error occurs (typically
25794 causing a temporary failure of whatever caused the ACL to be run). For example:
25795 .code
25796 acl_smtp_data = /etc/acls/\
25797   ${lookup{$sender_host_address}lsearch\
25798   {/etc/acllist}{$value}{default}}
25799 .endd
25800 This looks up an ACL file to use on the basis of the host's IP address, falling
25801 back to a default if the lookup fails. If an ACL is successfully read from a
25802 file, it is retained in memory for the duration of the Exim process, so that it
25803 can be re-used without having to re-read the file.
25804 .next
25805 If the string does not start with a slash, and does not contain any spaces,
25806 Exim searches the ACL section of the configuration for an ACL whose name
25807 matches the string.
25808 .next
25809 If no named ACL is found, or if the string contains spaces, Exim parses
25810 the string as an inline ACL. This can save typing in cases where you just
25811 want to have something like
25812 .code
25813 acl_smtp_vrfy = accept
25814 .endd
25815 in order to allow free use of the VRFY command. Such a string may contain
25816 newlines; it is processed in the same way as an ACL that is read from a file.
25817 .endlist
25818
25819
25820
25821
25822 .section "ACL return codes" "SECID196"
25823 .cindex "&ACL;" "return codes"
25824 Except for the QUIT ACL, which does not affect the SMTP return code (see
25825 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25826 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25827 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25828 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25829 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25830 This also causes a 4&'xx'& return code.
25831
25832 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25833 &"deny"&, because there is no mechanism for passing temporary errors to the
25834 submitters of non-SMTP messages.
25835
25836
25837 ACLs that are relevant to message reception may also return &"discard"&. This
25838 has the effect of &"accept"&, but causes either the entire message or an
25839 individual recipient address to be discarded. In other words, it is a
25840 blackholing facility. Use it with care.
25841
25842 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25843 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25844 RCPT ACL is to discard just the one recipient address. If there are no
25845 recipients left when the message's data is received, the DATA ACL is not
25846 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25847 remaining recipients. The &"discard"& return is not permitted for the
25848 &%acl_smtp_predata%& ACL.
25849
25850
25851 .cindex "&[local_scan()]& function" "when all recipients discarded"
25852 The &[local_scan()]& function is always run, even if there are no remaining
25853 recipients; it may create new recipients.
25854
25855
25856
25857 .section "Unset ACL options" "SECID197"
25858 .cindex "&ACL;" "unset options"
25859 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25860 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25861 not defined at all. For any defined ACL, the default action when control
25862 reaches the end of the ACL statements is &"deny"&.
25863
25864 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25865 these two are ACLs that are used only for their side effects. They cannot be
25866 used to accept or reject anything.
25867
25868 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25869 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25870 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25871 when the ACL is not defined is &"accept"&.
25872
25873 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25874 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25875 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25876 messages over an SMTP connection. For an example, see the ACL in the default
25877 configuration file.
25878
25879
25880
25881
25882 .section "Data for message ACLs" "SECID198"
25883 .cindex "&ACL;" "data for message ACL"
25884 .vindex &$domain$&
25885 .vindex &$local_part$&
25886 .vindex &$sender_address$&
25887 .vindex &$sender_host_address$&
25888 .vindex &$smtp_command$&
25889 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
25890 that contain information about the host and the message's sender (for example,
25891 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
25892 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
25893 &$local_part$& are set from the argument address. The entire SMTP command
25894 is available in &$smtp_command$&.
25895
25896 When an ACL for the AUTH parameter of MAIL is running, the variables that
25897 contain information about the host are set, but &$sender_address$& is not yet
25898 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25899 how it is used.
25900
25901 .vindex "&$message_size$&"
25902 The &$message_size$& variable is set to the value of the SIZE parameter on
25903 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25904 that parameter is not given. The value is updated to the true message size by
25905 the time the final DATA ACL is run (after the message data has been
25906 received).
25907
25908 .vindex "&$rcpt_count$&"
25909 .vindex "&$recipients_count$&"
25910 The &$rcpt_count$& variable increases by one for each RCPT command received.
25911 The &$recipients_count$& variable increases by one each time a RCPT command is
25912 accepted, so while an ACL for RCPT is being processed, it contains the number
25913 of previously accepted recipients. At DATA time (for both the DATA ACLs),
25914 &$rcpt_count$& contains the total number of RCPT commands, and
25915 &$recipients_count$& contains the total number of accepted recipients.
25916
25917
25918
25919
25920
25921 .section "Data for non-message ACLs" "SECTdatfornon"
25922 .cindex "&ACL;" "data for non-message ACL"
25923 .vindex &$smtp_command_argument$&
25924 .vindex &$smtp_command$&
25925 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
25926 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
25927 and the entire SMTP command is available in &$smtp_command$&.
25928 These variables can be tested using a &%condition%& condition. For example,
25929 here is an ACL for use with AUTH, which insists that either the session is
25930 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
25931 does not permit authentication methods that use cleartext passwords on
25932 unencrypted connections.
25933 .code
25934 acl_check_auth:
25935   accept encrypted = *
25936   accept condition = ${if eq{${uc:$smtp_command_argument}}\
25937                      {CRAM-MD5}}
25938   deny   message   = TLS encryption or CRAM-MD5 required
25939 .endd
25940 (Another way of applying this restriction is to arrange for the authenticators
25941 that use cleartext passwords not to be advertised when the connection is not
25942 encrypted. You can use the generic &%server_advertise_condition%& authenticator
25943 option to do this.)
25944
25945
25946
25947 .section "Format of an ACL" "SECID199"
25948 .cindex "&ACL;" "format of"
25949 .cindex "&ACL;" "verbs, definition of"
25950 An individual ACL consists of a number of statements. Each statement starts
25951 with a verb, optionally followed by a number of conditions and &"modifiers"&.
25952 Modifiers can change the way the verb operates, define error and log messages,
25953 set variables, insert delays, and vary the processing of accepted messages.
25954
25955 If all the conditions are met, the verb is obeyed. The same condition may be
25956 used (with different arguments) more than once in the same statement. This
25957 provides a means of specifying an &"and"& conjunction between conditions. For
25958 example:
25959 .code
25960 deny  dnslists = list1.example
25961 dnslists = list2.example
25962 .endd
25963 If there are no conditions, the verb is always obeyed. Exim stops evaluating
25964 the conditions and modifiers when it reaches a condition that fails. What
25965 happens then depends on the verb (and in one case, on a special modifier). Not
25966 all the conditions make sense at every testing point. For example, you cannot
25967 test a sender address in the ACL that is run for a VRFY command.
25968
25969
25970 .section "ACL verbs" "SECID200"
25971 The ACL verbs are as follows:
25972
25973 .ilist
25974 .cindex "&%accept%& ACL verb"
25975 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
25976 of the conditions are not met, what happens depends on whether &%endpass%&
25977 appears among the conditions (for syntax see below). If the failing condition
25978 is before &%endpass%&, control is passed to the next ACL statement; if it is
25979 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
25980 check a RCPT command:
25981 .code
25982 accept domains = +local_domains
25983 endpass
25984 verify = recipient
25985 .endd
25986 If the recipient domain does not match the &%domains%& condition, control
25987 passes to the next statement. If it does match, the recipient is verified, and
25988 the command is accepted if verification succeeds. However, if verification
25989 fails, the ACL yields &"deny"&, because the failing condition is after
25990 &%endpass%&.
25991
25992 The &%endpass%& feature has turned out to be confusing to many people, so its
25993 use is not recommended nowadays. It is always possible to rewrite an ACL so
25994 that &%endpass%& is not needed, and it is no longer used in the default
25995 configuration.
25996
25997 .cindex "&%message%& ACL modifier" "with &%accept%&"
25998 If a &%message%& modifier appears on an &%accept%& statement, its action
25999 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26000 (when an &%accept%& verb either accepts or passes control to the next
26001 statement), &%message%& can be used to vary the message that is sent when an
26002 SMTP command is accepted. For example, in a RCPT ACL you could have:
26003 .display
26004 &`accept  `&<&'some conditions'&>
26005 &`        message = OK, I will allow you through today`&
26006 .endd
26007 You can specify an SMTP response code, optionally followed by an &"extended
26008 response code"& at the start of the message, but the first digit must be the
26009 same as would be sent by default, which is 2 for an &%accept%& verb.
26010
26011 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26012 an error message that is used when access is denied. This behaviour is retained
26013 for backward compatibility, but current &"best practice"& is to avoid the use
26014 of &%endpass%&.
26015
26016
26017 .next
26018 .cindex "&%defer%& ACL verb"
26019 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26020 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26021 &%defer%& is the same as &%deny%&, because there is no way of sending a
26022 temporary error. For a RCPT command, &%defer%& is much the same as using a
26023 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26024 be used in any ACL, and even for a recipient it might be a simpler approach.
26025
26026
26027 .next
26028 .cindex "&%deny%& ACL verb"
26029 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26030 the conditions are not met, control is passed to the next ACL statement. For
26031 example,
26032 .code
26033 deny dnslists = blackholes.mail-abuse.org
26034 .endd
26035 rejects commands from hosts that are on a DNS black list.
26036
26037
26038 .next
26039 .cindex "&%discard%& ACL verb"
26040 &%discard%&: This verb behaves like &%accept%&, except that it returns
26041 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26042 that are concerned with receiving messages. When all the conditions are true,
26043 the sending entity receives a &"success"& response. However, &%discard%& causes
26044 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26045 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26046 message's recipients are discarded. Recipients that are discarded before DATA
26047 do not appear in the log line when the &%received_recipients%& log selector is set.
26048
26049 If the &%log_message%& modifier is set when &%discard%& operates,
26050 its contents are added to the line that is automatically written to the log.
26051 The &%message%& modifier operates exactly as it does for &%accept%&.
26052
26053
26054 .next
26055 .cindex "&%drop%& ACL verb"
26056 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26057 forcibly closed after the 5&'xx'& error message has been sent. For example:
26058 .code
26059 drop   message   = I don't take more than 20 RCPTs
26060        condition = ${if > {$rcpt_count}{20}}
26061 .endd
26062 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26063 The connection is always dropped after sending a 550 response.
26064
26065 .next
26066 .cindex "&%require%& ACL verb"
26067 &%require%&: If all the conditions are met, control is passed to the next ACL
26068 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26069 example, when checking a RCPT command,
26070 .code
26071 require message = Sender did not verify
26072         verify  = sender
26073 .endd
26074 passes control to subsequent statements only if the message's sender can be
26075 verified. Otherwise, it rejects the command. Note the positioning of the
26076 &%message%& modifier, before the &%verify%& condition. The reason for this is
26077 discussed in section &<<SECTcondmodproc>>&.
26078
26079 .next
26080 .cindex "&%warn%& ACL verb"
26081 &%warn%&: If all the conditions are true, a line specified by the
26082 &%log_message%& modifier is written to Exim's main log. Control always passes
26083 to the next ACL statement. If any condition is false, the log line is not
26084 written. If an identical log line is requested several times in the same
26085 message, only one copy is actually written to the log. If you want to force
26086 duplicates to be written, use the &%logwrite%& modifier instead.
26087
26088 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26089 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26090 &%logwrite%&, and &%add_header%&) that appear before the first failing
26091 condition. There is more about adding header lines in section
26092 &<<SECTaddheadacl>>&.
26093
26094 If any condition on a &%warn%& statement cannot be completed (that is, there is
26095 some sort of defer), the log line specified by &%log_message%& is not written.
26096 This does not include the case of a forced failure from a lookup, which
26097 is considered to be a successful completion. After a defer, no further
26098 conditions or modifiers in the &%warn%& statement are processed. The incident
26099 is logged, and the ACL continues to be processed, from the next statement
26100 onwards.
26101
26102
26103 .vindex "&$acl_verify_message$&"
26104 When one of the &%warn%& conditions is an address verification that fails, the
26105 text of the verification failure message is in &$acl_verify_message$&. If you
26106 want this logged, you must set it up explicitly. For example:
26107 .code
26108 warn   !verify = sender
26109        log_message = sender verify failed: $acl_verify_message
26110 .endd
26111 .endlist
26112
26113 At the end of each ACL there is an implicit unconditional &%deny%&.
26114
26115 As you can see from the examples above, the conditions and modifiers are
26116 written one to a line, with the first one on the same line as the verb, and
26117 subsequent ones on following lines. If you have a very long condition, you can
26118 continue it onto several physical lines by the usual backslash continuation
26119 mechanism. It is conventional to align the conditions vertically.
26120
26121
26122
26123 .section "ACL variables" "SECTaclvariables"
26124 .cindex "&ACL;" "variables"
26125 There are some special variables that can be set during ACL processing. They
26126 can be used to pass information between different ACLs, different invocations
26127 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26128 transports, and filters that are used to deliver a message. The names of these
26129 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26130 an underscore, but the remainder of the name can be any sequence of
26131 alphanumeric characters and underscores that you choose. There is no limit on
26132 the number of ACL variables. The two sets act as follows:
26133 .ilist
26134 The values of those variables whose names begin with &$acl_c$& persist
26135 throughout an SMTP connection. They are never reset. Thus, a value that is set
26136 while receiving one message is still available when receiving the next message
26137 on the same SMTP connection.
26138 .next
26139 The values of those variables whose names begin with &$acl_m$& persist only
26140 while a message is being received. They are reset afterwards. They are also
26141 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26142 .endlist
26143
26144 When a message is accepted, the current values of all the ACL variables are
26145 preserved with the message and are subsequently made available at delivery
26146 time. The ACL variables are set by a modifier called &%set%&. For example:
26147 .code
26148 accept hosts = whatever
26149        set acl_m4 = some value
26150 accept authenticated = *
26151        set acl_c_auth = yes
26152 .endd
26153 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26154 be set. If you want to set a variable without taking any action, you can use a
26155 &%warn%& verb without any other modifiers or conditions.
26156
26157 .oindex &%strict_acl_vars%&
26158 What happens if a syntactically valid but undefined ACL variable is
26159 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26160 false (the default), an empty string is substituted; if it is true, an
26161 error is generated.
26162
26163 Versions of Exim before 4.64 have a limited set of numbered variables, but
26164 their names are compatible, so there is no problem with upgrading.
26165
26166
26167 .section "Condition and modifier processing" "SECTcondmodproc"
26168 .cindex "&ACL;" "conditions; processing"
26169 .cindex "&ACL;" "modifiers; processing"
26170 An exclamation mark preceding a condition negates its result. For example:
26171 .code
26172 deny   domains = *.dom.example
26173       !verify  = recipient
26174 .endd
26175 causes the ACL to return &"deny"& if the recipient domain ends in
26176 &'dom.example'& and the recipient address cannot be verified. Sometimes
26177 negation can be used on the right-hand side of a condition. For example, these
26178 two statements are equivalent:
26179 .code
26180 deny  hosts = !192.168.3.4
26181 deny !hosts =  192.168.3.4
26182 .endd
26183 However, for many conditions (&%verify%& being a good example), only left-hand
26184 side negation of the whole condition is possible.
26185
26186 The arguments of conditions and modifiers are expanded. A forced failure
26187 of an expansion causes a condition to be ignored, that is, it behaves as if the
26188 condition is true. Consider these two statements:
26189 .code
26190 accept  senders = ${lookup{$host_name}lsearch\
26191                   {/some/file}{$value}fail}
26192 accept  senders = ${lookup{$host_name}lsearch\
26193                   {/some/file}{$value}{}}
26194 .endd
26195 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26196 the returned list is searched, but if the lookup fails the behaviour is
26197 different in the two cases. The &%fail%& in the first statement causes the
26198 condition to be ignored, leaving no further conditions. The &%accept%& verb
26199 therefore succeeds. The second statement, however, generates an empty list when
26200 the lookup fails. No sender can match an empty list, so the condition fails,
26201 and therefore the &%accept%& also fails.
26202
26203 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26204 specify actions that are taken as the conditions for a statement are checked;
26205 others specify text for messages that are used when access is denied or a
26206 warning is generated. The &%control%& modifier affects the way an incoming
26207 message is handled.
26208
26209 The positioning of the modifiers in an ACL statement important, because the
26210 processing of a verb ceases as soon as its outcome is known. Only those
26211 modifiers that have already been encountered will take effect. For example,
26212 consider this use of the &%message%& modifier:
26213 .code
26214 require message = Can't verify sender
26215         verify  = sender
26216         message = Can't verify recipient
26217         verify  = recipient
26218         message = This message cannot be used
26219 .endd
26220 If sender verification fails, Exim knows that the result of the statement is
26221 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26222 so its text is used as the error message. If sender verification succeeds, but
26223 recipient verification fails, the second message is used. If recipient
26224 verification succeeds, the third message becomes &"current"&, but is never used
26225 because there are no more conditions to cause failure.
26226
26227 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26228 modifier that is used, because all the conditions must be true for rejection to
26229 happen. Specifying more than one &%message%& modifier does not make sense, and
26230 the message can even be specified after all the conditions. For example:
26231 .code
26232 deny   hosts = ...
26233       !senders = *@my.domain.example
26234        message = Invalid sender from client host
26235 .endd
26236 The &"deny"& result does not happen until the end of the statement is reached,
26237 by which time Exim has set up the message.
26238
26239
26240
26241 .section "ACL modifiers" "SECTACLmodi"
26242 .cindex "&ACL;" "modifiers; list of"
26243 The ACL modifiers are as follows:
26244
26245 .vlist
26246 .vitem &*add_header*&&~=&~<&'text'&>
26247 This modifier specifies one or more header lines that are to be added to an
26248 incoming message, assuming, of course, that the message is ultimately
26249 accepted. For details, see section &<<SECTaddheadacl>>&.
26250
26251 .vitem &*continue*&&~=&~<&'text'&>
26252 .cindex "&%continue%& ACL modifier"
26253 .cindex "database" "updating in ACL"
26254 This modifier does nothing of itself, and processing of the ACL always
26255 continues with the next condition or modifier. The value of &%continue%& is in
26256 the side effects of expanding its argument. Typically this could be used to
26257 update a database. It is really just a syntactic tidiness, to avoid having to
26258 write rather ugly lines like this:
26259 .display
26260 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26261 .endd
26262 Instead, all you need is
26263 .display
26264 &`continue = `&<&'some expansion'&>
26265 .endd
26266
26267 .vitem &*control*&&~=&~<&'text'&>
26268 .cindex "&%control%& ACL modifier"
26269 This modifier affects the subsequent processing of the SMTP connection or of an
26270 incoming message that is accepted. The effect of the first type of control
26271 lasts for the duration of the connection, whereas the effect of the second type
26272 lasts only until the current message has been received. The message-specific
26273 controls always apply to the whole message, not to individual recipients,
26274 even if the &%control%& modifier appears in a RCPT ACL.
26275
26276 As there are now quite a few controls that can be applied, they are described
26277 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26278 in several different ways. For example:
26279
26280 . ==== As this is a nested list, any displays it contains must be indented
26281 . ==== as otherwise they are too far to the left. That comment applies only
26282 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26283 . ==== way.
26284
26285 .ilist
26286 It can be at the end of an &%accept%& statement:
26287 .code
26288     accept  ...some conditions
26289             control = queue_only
26290 .endd
26291 In this case, the control is applied when this statement yields &"accept"&, in
26292 other words, when the conditions are all true.
26293
26294 .next
26295 It can be in the middle of an &%accept%& statement:
26296 .code
26297     accept  ...some conditions...
26298             control = queue_only
26299             ...some more conditions...
26300 .endd
26301 If the first set of conditions are true, the control is applied, even if the
26302 statement does not accept because one of the second set of conditions is false.
26303 In this case, some subsequent statement must yield &"accept"& for the control
26304 to be relevant.
26305
26306 .next
26307 It can be used with &%warn%& to apply the control, leaving the
26308 decision about accepting or denying to a subsequent verb. For
26309 example:
26310 .code
26311     warn    ...some conditions...
26312             control = freeze
26313     accept  ...
26314 .endd
26315 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
26316 &%logwrite%&, so it does not add anything to the message and does not write a
26317 log entry.
26318
26319 .next
26320 If you want to apply a control unconditionally, you can use it with a
26321 &%require%& verb. For example:
26322 .code
26323     require  control = no_multiline_responses
26324 .endd
26325 .endlist
26326
26327 .vitem &*delay*&&~=&~<&'time'&>
26328 .cindex "&%delay%& ACL modifier"
26329 .oindex "&%-bh%&"
26330 This modifier may appear in any ACL. It causes Exim to wait for the time
26331 interval before proceeding. However, when testing Exim using the &%-bh%&
26332 option, the delay is not actually imposed (an appropriate message is output
26333 instead). The time is given in the usual Exim notation, and the delay happens
26334 as soon as the modifier is processed. In an SMTP session, pending output is
26335 flushed before the delay is imposed.
26336
26337 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
26338 example:
26339 .code
26340 deny    ...some conditions...
26341         delay = 30s
26342 .endd
26343 The delay happens if all the conditions are true, before the statement returns
26344 &"deny"&. Compare this with:
26345 .code
26346 deny    delay = 30s
26347         ...some conditions...
26348 .endd
26349 which waits for 30s before processing the conditions. The &%delay%& modifier
26350 can also be used with &%warn%& and together with &%control%&:
26351 .code
26352 warn    ...some conditions...
26353         delay = 2m
26354         control = freeze
26355 accept  ...
26356 .endd
26357
26358 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
26359 responses to several commands are no longer buffered and sent in one packet (as
26360 they would normally be) because all output is flushed before imposing the
26361 delay. This optimization is disabled so that a number of small delays do not
26362 appear to the client as one large aggregated delay that might provoke an
26363 unwanted timeout. You can, however, disable output flushing for &%delay%& by
26364 using a &%control%& modifier to set &%no_delay_flush%&.
26365
26366
26367 .vitem &*endpass*&
26368 .cindex "&%endpass%& ACL modifier"
26369 This modifier, which has no argument, is recognized only in &%accept%& and
26370 &%discard%& statements. It marks the boundary between the conditions whose
26371 failure causes control to pass to the next statement, and the conditions whose
26372 failure causes the ACL to return &"deny"&. This concept has proved to be
26373 confusing to some people, so the use of &%endpass%& is no longer recommended as
26374 &"best practice"&. See the description of &%accept%& above for more details.
26375
26376
26377 .vitem &*log_message*&&~=&~<&'text'&>
26378 .cindex "&%log_message%& ACL modifier"
26379 This modifier sets up a message that is used as part of the log message if the
26380 ACL denies access or a &%warn%& statement's conditions are true. For example:
26381 .code
26382 require log_message = wrong cipher suite $tls_cipher
26383         encrypted   = DES-CBC3-SHA
26384 .endd
26385 &%log_message%& is also used when recipients are discarded by &%discard%&. For
26386 example:
26387 .display
26388 &`discard `&<&'some conditions'&>
26389 &`        log_message = Discarded $local_part@$domain because...`&
26390 .endd
26391 When access is denied, &%log_message%& adds to any underlying error message
26392 that may exist because of a condition failure. For example, while verifying a
26393 recipient address, a &':fail:'& redirection might have already set up a
26394 message.
26395
26396 The message may be defined before the conditions to which it applies, because
26397 the string expansion does not happen until Exim decides that access is to be
26398 denied. This means that any variables that are set by the condition are
26399 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
26400 variables are set after a DNS black list lookup succeeds. If the expansion of
26401 &%log_message%& fails, or if the result is an empty string, the modifier is
26402 ignored.
26403
26404 .vindex "&$acl_verify_message$&"
26405 If you want to use a &%warn%& statement to log the result of an address
26406 verification, you can use &$acl_verify_message$& to include the verification
26407 error message.
26408
26409 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
26410 the start of the logged message. If the same warning log message is requested
26411 more than once while receiving  a single email message, only one copy is
26412 actually logged. If you want to log multiple copies, use &%logwrite%& instead
26413 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
26414 is logged for a successful &%warn%& statement.
26415
26416 If &%log_message%& is not present and there is no underlying error message (for
26417 example, from the failure of address verification), but &%message%& is present,
26418 the &%message%& text is used for logging rejections. However, if any text for
26419 logging contains newlines, only the first line is logged. In the absence of
26420 both &%log_message%& and &%message%&, a default built-in message is used for
26421 logging rejections.
26422
26423
26424 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
26425 .cindex "&%log_reject_target%& ACL modifier"
26426 .cindex "logging in ACL" "specifying which log"
26427 This modifier makes it possible to specify which logs are used for messages
26428 about ACL rejections. Its argument is a colon-separated list of words that can
26429 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
26430 may be empty, in which case a rejection is not logged at all. For example, this
26431 ACL fragment writes no logging information when access is denied:
26432 .display
26433 &`deny `&<&'some conditions'&>
26434 &`     log_reject_target =`&
26435 .endd
26436 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
26437 permanent and temporary rejections. Its effect lasts for the rest of the
26438 current ACL.
26439
26440
26441 .vitem &*logwrite*&&~=&~<&'text'&>
26442 .cindex "&%logwrite%& ACL modifier"
26443 .cindex "logging in ACL" "immediate"
26444 This modifier writes a message to a log file as soon as it is encountered when
26445 processing an ACL. (Compare &%log_message%&, which, except in the case of
26446 &%warn%& and &%discard%&, is used only if the ACL statement denies
26447 access.) The &%logwrite%& modifier can be used to log special incidents in
26448 ACLs. For example:
26449 .display
26450 &`accept `&<&'some special conditions'&>
26451 &`       control  = freeze`&
26452 &`       logwrite = froze message because ...`&
26453 .endd
26454 By default, the message is written to the main log. However, it may begin
26455 with a colon, followed by a comma-separated list of log names, and then
26456 another colon, to specify exactly which logs are to be written. For
26457 example:
26458 .code
26459 logwrite = :main,reject: text for main and reject logs
26460 logwrite = :panic: text for panic log only
26461 .endd
26462
26463
26464 .vitem &*message*&&~=&~<&'text'&>
26465 .cindex "&%message%& ACL modifier"
26466 This modifier sets up a text string that is expanded and used as a response
26467 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
26468 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
26469 there is some complication if &%endpass%& is involved; see the description of
26470 &%accept%& for details.)
26471
26472 The expansion of the message happens at the time Exim decides that the ACL is
26473 to end, not at the time it processes &%message%&. If the expansion fails, or
26474 generates an empty string, the modifier is ignored. Here is an example where
26475 &%message%& must be specified first, because the ACL ends with a rejection if
26476 the &%hosts%& condition fails:
26477 .code
26478 require  message = Host not recognized
26479          hosts = 10.0.0.0/8
26480 .endd
26481 (Once a condition has failed, no further conditions or modifiers are
26482 processed.)
26483
26484 .cindex "SMTP" "error codes"
26485 .oindex "&%smtp_banner%&
26486 For ACLs that are triggered by SMTP commands, the message is returned as part
26487 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
26488 is meaningful only for SMTP, as no message is returned when a non-SMTP message
26489 is accepted. In the case of the connect ACL, accepting with a message modifier
26490 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
26491 accept message may not contain more than one line (otherwise it will be
26492 truncated at the first newline and a panic logged), and it cannot affect the
26493 EHLO options.
26494
26495 When SMTP is involved, the message may begin with an overriding response code,
26496 consisting of three digits optionally followed by an &"extended response code"&
26497 of the form &'n.n.n'&, each code being followed by a space. For example:
26498 .code
26499 deny  message = 599 1.2.3 Host not welcome
26500       hosts = 192.168.34.0/24
26501 .endd
26502 The first digit of the supplied response code must be the same as would be sent
26503 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
26504 access, but for the predata ACL, note that the default success code is 354, not
26505 2&'xx'&.
26506
26507 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
26508 the message modifier cannot override the 221 response code.
26509
26510 The text in a &%message%& modifier is literal; any quotes are taken as
26511 literals, but because the string is expanded, backslash escapes are processed
26512 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
26513 response.
26514
26515 .vindex "&$acl_verify_message$&"
26516 If &%message%& is used on a statement that verifies an address, the message
26517 specified overrides any message that is generated by the verification process.
26518 However, the original message is available in the variable
26519 &$acl_verify_message$&, so you can incorporate it into your message if you
26520 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
26521 routers to be passed back as part of the SMTP response, you should either not
26522 use a &%message%& modifier, or make use of &$acl_verify_message$&.
26523
26524 For compatibility with previous releases of Exim, a &%message%& modifier that
26525 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
26526 modifier, but this usage is now deprecated. However, &%message%& acts only when
26527 all the conditions are true, wherever it appears in an ACL command, whereas
26528 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
26529 &%warn%& in an ACL that is not concerned with receiving a message, it has no
26530 effect.
26531
26532
26533 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
26534 .cindex "&%set%& ACL modifier"
26535 This modifier puts a value into one of the ACL variables (see section
26536 &<<SECTaclvariables>>&).
26537 .endlist
26538
26539
26540
26541
26542
26543 .section "Use of the control modifier" "SECTcontrols"
26544 .cindex "&%control%& ACL modifier"
26545 The &%control%& modifier supports the following settings:
26546
26547 .vlist
26548 .vitem &*control&~=&~allow_auth_unadvertised*&
26549 This modifier allows a client host to use the SMTP AUTH command even when it
26550 has not been advertised in response to EHLO. Furthermore, because there are
26551 apparently some really broken clients that do this, Exim will accept AUTH after
26552 HELO (rather than EHLO) when this control is set. It should be used only if you
26553 really need it, and you should limit its use to those broken clients that do
26554 not work without it. For example:
26555 .code
26556 warn hosts   = 192.168.34.25
26557      control = allow_auth_unadvertised
26558 .endd
26559 Normally, when an Exim server receives an AUTH command, it checks the name of
26560 the authentication mechanism that is given in the command to ensure that it
26561 matches an advertised mechanism. When this control is set, the check that a
26562 mechanism has been advertised is bypassed. Any configured mechanism can be used
26563 by the client. This control is permitted only in the connection and HELO ACLs.
26564
26565
26566 .vitem &*control&~=&~caseful_local_part*& &&&
26567        &*control&~=&~caselower_local_part*&
26568 .cindex "&ACL;" "case of local part in"
26569 .cindex "case of local parts"
26570 .vindex "&$local_part$&"
26571 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
26572 (that is, during RCPT processing). By default, the contents of &$local_part$&
26573 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
26574 any uppercase letters in the original local part are restored in &$local_part$&
26575 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
26576 is encountered.
26577
26578 These controls affect only the current recipient. Moreover, they apply only to
26579 local part handling that takes place directly in the ACL (for example, as a key
26580 in lookups). If a test to verify the recipient is obeyed, the case-related
26581 handling of the local part during the verification is controlled by the router
26582 configuration (see the &%caseful_local_part%& generic router option).
26583
26584 This facility could be used, for example, to add a spam score to local parts
26585 containing upper case letters. For example, using &$acl_m4$& to accumulate the
26586 spam score:
26587 .code
26588 warn  control = caseful_local_part
26589       set acl_m4 = ${eval:\
26590                      $acl_m4 + \
26591                      ${if match{$local_part}{[A-Z]}{1}{0}}\
26592                     }
26593       control = caselower_local_part
26594 .endd
26595 Notice that we put back the lower cased version afterwards, assuming that
26596 is what is wanted for subsequent tests.
26597
26598
26599 .vitem &*control&~=&~debug/*&<&'options'&>
26600 .cindex "&ACL;" "enabling debug logging"
26601 .cindex "debugging" "enabling from an ACL"
26602 This control turns on debug logging, almost as though Exim had been invoked
26603 with &`-d`&, with the output going to a new logfile, by default called
26604 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
26605 may access any variables already defined.  The logging may be adjusted with
26606 the &'opts'& option, which takes the same values as the &`-d`& command-line
26607 option.  Some examples (which depend on variables that don't exist in all
26608 contexts):
26609 .code
26610       control = debug
26611       control = debug/tag=.$sender_host_address
26612       control = debug/opts=+expand+acl
26613       control = debug/tag=.$message_exim_id/opts=+expand
26614 .endd
26615
26616
26617 .vitem &*control&~=&~enforce_sync*& &&&
26618        &*control&~=&~no_enforce_sync*&
26619 .cindex "SMTP" "synchronization checking"
26620 .cindex "synchronization checking in SMTP"
26621 These controls make it possible to be selective about when SMTP synchronization
26622 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
26623 state of the switch (it is true by default). See the description of this option
26624 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
26625
26626 The effect of these two controls lasts for the remainder of the SMTP
26627 connection. They can appear in any ACL except the one for the non-SMTP
26628 messages. The most straightforward place to put them is in the ACL defined by
26629 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
26630 before the first synchronization check. The expected use is to turn off the
26631 synchronization checks for badly-behaved hosts that you nevertheless need to
26632 work with.
26633
26634
26635 .vitem &*control&~=&~fakedefer/*&<&'message'&>
26636 .cindex "fake defer"
26637 .cindex "defer, fake"
26638 This control works in exactly the same way as &%fakereject%& (described below)
26639 except that it causes an SMTP 450 response after the message data instead of a
26640 550 response. You must take care when using &%fakedefer%& because it causes the
26641 messages to be duplicated when the sender retries. Therefore, you should not
26642 use &%fakedefer%& if the message is to be delivered normally.
26643
26644 .vitem &*control&~=&~fakereject/*&<&'message'&>
26645 .cindex "fake rejection"
26646 .cindex "rejection, fake"
26647 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
26648 words, only when an SMTP message is being received. If Exim accepts the
26649 message, instead the final 250 response, a 550 rejection message is sent.
26650 However, Exim proceeds to deliver the message as normal. The control applies
26651 only to the current message, not to any subsequent ones that may be received in
26652 the same SMTP connection.
26653
26654 The text for the 550 response is taken from the &%control%& modifier. If no
26655 message is supplied, the following is used:
26656 .code
26657 550-Your message has been rejected but is being
26658 550-kept for evaluation.
26659 550-If it was a legitimate message, it may still be
26660 550 delivered to the target recipient(s).
26661 .endd
26662 This facility should be used with extreme caution.
26663
26664 .vitem &*control&~=&~freeze*&
26665 .cindex "frozen messages" "forcing in ACL"
26666 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26667 other words, only when a message is being received. If the message is accepted,
26668 it is placed on Exim's queue and frozen. The control applies only to the
26669 current message, not to any subsequent ones that may be received in the same
26670 SMTP connection.
26671
26672 This modifier can optionally be followed by &`/no_tell`&. If the global option
26673 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
26674 is told about the freezing), provided all the &*control=freeze*& modifiers that
26675 are obeyed for the current message have the &`/no_tell`& option.
26676
26677 .vitem &*control&~=&~no_delay_flush*&
26678 .cindex "SMTP" "output flushing, disabling for delay"
26679 Exim normally flushes SMTP output before implementing a delay in an ACL, to
26680 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26681 use. This control, as long as it is encountered before the &%delay%& modifier,
26682 disables such output flushing.
26683
26684 .vitem &*control&~=&~no_callout_flush*&
26685 .cindex "SMTP" "output flushing, disabling for callout"
26686 Exim normally flushes SMTP output before performing a callout in an ACL, to
26687 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26688 use. This control, as long as it is encountered before the &%verify%& condition
26689 that causes the callout, disables such output flushing.
26690
26691 .vitem &*control&~=&~no_mbox_unspool*&
26692 This control is available when Exim is compiled with the content scanning
26693 extension. Content scanning may require a copy of the current message, or parts
26694 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
26695 or spam scanner. Normally, such copies are deleted when they are no longer
26696 needed. If this control is set, the copies are not deleted. The control applies
26697 only to the current message, not to any subsequent ones that may be received in
26698 the same SMTP connection. It is provided for debugging purposes and is unlikely
26699 to be useful in production.
26700
26701 .vitem &*control&~=&~no_multiline_responses*&
26702 .cindex "multiline responses, suppressing"
26703 This control is permitted for any ACL except the one for non-SMTP messages.
26704 It seems that there are broken clients in use that cannot handle multiline
26705 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
26706
26707 If this control is set, multiline SMTP responses from ACL rejections are
26708 suppressed. One way of doing this would have been to put out these responses as
26709 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
26710 (&"use multiline responses for more"& it says &-- ha!), and some of the
26711 responses might get close to that. So this facility, which is after all only a
26712 sop to broken clients, is implemented by doing two very easy things:
26713
26714 .ilist
26715 Extra information that is normally output as part of a rejection caused by
26716 sender verification failure is omitted. Only the final line (typically &"sender
26717 verification failed"&) is sent.
26718 .next
26719 If a &%message%& modifier supplies a multiline response, only the first
26720 line is output.
26721 .endlist
26722
26723 The setting of the switch can, of course, be made conditional on the
26724 calling host. Its effect lasts until the end of the SMTP connection.
26725
26726 .vitem &*control&~=&~no_pipelining*&
26727 .cindex "PIPELINING" "suppressing advertising"
26728 This control turns off the advertising of the PIPELINING extension to SMTP in
26729 the current session. To be useful, it must be obeyed before Exim sends its
26730 response to an EHLO command. Therefore, it should normally appear in an ACL
26731 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
26732 &%pipelining_advertise_hosts%&.
26733
26734 .vitem &*control&~=&~queue_only*&
26735 .oindex "&%queue_only%&"
26736 .cindex "queueing incoming messages"
26737 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26738 other words, only when a message is being received. If the message is accepted,
26739 it is placed on Exim's queue and left there for delivery by a subsequent queue
26740 runner. No immediate delivery process is started. In other words, it has the
26741 effect as the &%queue_only%& global option. However, the control applies only
26742 to the current message, not to any subsequent ones that may be received in the
26743 same SMTP connection.
26744
26745 .vitem &*control&~=&~submission/*&<&'options'&>
26746 .cindex "message" "submission"
26747 .cindex "submission mode"
26748 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
26749 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
26750 the current message is a submission from a local MUA. In this case, Exim
26751 operates in &"submission mode"&, and applies certain fixups to the message if
26752 necessary. For example, it adds a &'Date:'& header line if one is not present.
26753 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
26754 late (the message has already been created).
26755
26756 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
26757 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
26758 submission mode; the available options for this control are described there.
26759 The control applies only to the current message, not to any subsequent ones
26760 that may be received in the same SMTP connection.
26761
26762 .vitem &*control&~=&~suppress_local_fixups*&
26763 .cindex "submission fixups, suppressing"
26764 This control applies to locally submitted (non TCP/IP) messages, and is the
26765 complement of &`control = submission`&. It disables the fixups that are
26766 normally applied to locally-submitted messages. Specifically:
26767
26768 .ilist
26769 Any &'Sender:'& header line is left alone (in this respect, it is a
26770 dynamic version of &%local_sender_retain%&).
26771 .next
26772 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
26773 .next
26774 There is no check that &'From:'& corresponds to the actual sender.
26775 .endlist ilist
26776
26777 This control may be useful when a remotely-originated message is accepted,
26778 passed to some scanning program, and then re-submitted for delivery. It can be
26779 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
26780 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
26781 data is read.
26782
26783 &*Note:*& This control applies only to the current message, not to any others
26784 that are being submitted at the same time using &%-bs%& or &%-bS%&.
26785 .endlist vlist
26786
26787
26788 .section "Summary of message fixup control" "SECTsummesfix"
26789 All four possibilities for message fixups can be specified:
26790
26791 .ilist
26792 Locally submitted, fixups applied: the default.
26793 .next
26794 Locally submitted, no fixups applied: use
26795 &`control = suppress_local_fixups`&.
26796 .next
26797 Remotely submitted, no fixups applied: the default.
26798 .next
26799 Remotely submitted, fixups applied: use &`control = submission`&.
26800 .endlist
26801
26802
26803
26804 .section "Adding header lines in ACLs" "SECTaddheadacl"
26805 .cindex "header lines" "adding in an ACL"
26806 .cindex "header lines" "position of added lines"
26807 .cindex "&%message%& ACL modifier"
26808 The &%add_header%& modifier can be used to add one or more extra header lines
26809 to an incoming message, as in this example:
26810 .code
26811 warn dnslists = sbl.spamhaus.org : \
26812                 dialup.mail-abuse.org
26813      add_header = X-blacklisted-at: $dnslist_domain
26814 .endd
26815 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
26816 MIME, and non-SMTP ACLs (in other words, those that are concerned with
26817 receiving a message). The message must ultimately be accepted for
26818 &%add_header%& to have any significant effect. You can use &%add_header%& with
26819 any ACL verb, including &%deny%& (though this is potentially useful only in a
26820 RCPT ACL).
26821
26822 If the data for the &%add_header%& modifier contains one or more newlines that
26823 are not followed by a space or a tab, it is assumed to contain multiple header
26824 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26825 front of any line that is not a valid header line.
26826
26827 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26828 They are added to the message before processing the DATA and MIME ACLs.
26829 However, if an identical header line is requested more than once, only one copy
26830 is actually added to the message. Further header lines may be accumulated
26831 during the DATA and MIME ACLs, after which they are added to the message, again
26832 with duplicates suppressed. Thus, it is possible to add two identical header
26833 lines to an SMTP message, but only if one is added before DATA and one after.
26834 In the case of non-SMTP messages, new headers are accumulated during the
26835 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26836 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26837 are included in the entry that is written to the reject log.
26838
26839 .cindex "header lines" "added; visibility of"
26840 Header lines are not visible in string expansions until they are added to the
26841 message. It follows that header lines defined in the MAIL, RCPT, and predata
26842 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26843 header lines that are added by the DATA or MIME ACLs are not visible in those
26844 ACLs. Because of this restriction, you cannot use header lines as a way of
26845 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26846 this, you can use ACL variables, as described in section
26847 &<<SECTaclvariables>>&.
26848
26849 The &%add_header%& modifier acts immediately it is encountered during the
26850 processing of an ACL. Notice the difference between these two cases:
26851 .display
26852 &`accept add_header = ADDED: some text`&
26853 &`       `&<&'some condition'&>
26854
26855 &`accept `&<&'some condition'&>
26856 &`       add_header = ADDED: some text`&
26857 .endd
26858 In the first case, the header line is always added, whether or not the
26859 condition is true. In the second case, the header line is added only if the
26860 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26861 ACL statement. All those that are encountered before a condition fails are
26862 honoured.
26863
26864 .cindex "&%warn%& ACL verb"
26865 For compatibility with previous versions of Exim, a &%message%& modifier for a
26866 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26867 effect only if all the conditions are true, even if it appears before some of
26868 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26869 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26870 are present on a &%warn%& verb, both are processed according to their
26871 specifications.
26872
26873 By default, new header lines are added to a message at the end of the existing
26874 header lines. However, you can specify that any particular header line should
26875 be added right at the start (before all the &'Received:'& lines), immediately
26876 after the first block of &'Received:'& lines, or immediately before any line
26877 that is not a &'Received:'& or &'Resent-something:'& header.
26878
26879 This is done by specifying &":at_start:"&, &":after_received:"&, or
26880 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26881 header line, respectively. (Header text cannot start with a colon, as there has
26882 to be a header name first.) For example:
26883 .code
26884 warn add_header = \
26885        :after_received:X-My-Header: something or other...
26886 .endd
26887 If more than one header line is supplied in a single &%add_header%& modifier,
26888 each one is treated independently and can therefore be placed differently. If
26889 you add more than one line at the start, or after the Received: block, they end
26890 up in reverse order.
26891
26892 &*Warning*&: This facility currently applies only to header lines that are
26893 added in an ACL. It does NOT work for header lines that are added in a
26894 system filter or in a router or transport.
26895
26896
26897
26898
26899 .section "ACL conditions" "SECTaclconditions"
26900 .cindex "&ACL;" "conditions; list of"
26901 Some of conditions listed in this section are available only when Exim is
26902 compiled with the content-scanning extension. They are included here briefly
26903 for completeness. More detailed descriptions can be found in the discussion on
26904 content scanning in chapter &<<CHAPexiscan>>&.
26905
26906 Not all conditions are relevant in all circumstances. For example, testing
26907 senders and recipients does not make sense in an ACL that is being run as the
26908 result of the arrival of an ETRN command, and checks on message headers can be
26909 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
26910 can use the same condition (with different parameters) more than once in the
26911 same ACL statement. This provides a way of specifying an &"and"& conjunction.
26912 The conditions are as follows:
26913
26914
26915 .vlist
26916 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
26917 .cindex "&ACL;" "nested"
26918 .cindex "&ACL;" "indirect"
26919 .cindex "&%acl%& ACL condition"
26920 The possible values of the argument are the same as for the
26921 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
26922 &"accept"& the condition is true; if it returns &"deny"& the condition is
26923 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
26924 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
26925 condition false. This means that further processing of the &%warn%& verb
26926 ceases, but processing of the ACL continues.
26927
26928 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
26929 the connection is dropped. If it returns &"discard"&, the verb must be
26930 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
26931 conditions are tested.
26932
26933 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
26934 loops. This condition allows you to use different ACLs in different
26935 circumstances. For example, different ACLs can be used to handle RCPT commands
26936 for different local users or different local domains.
26937
26938 .vitem &*authenticated&~=&~*&<&'string&~list'&>
26939 .cindex "&%authenticated%& ACL condition"
26940 .cindex "authentication" "ACL checking"
26941 .cindex "&ACL;" "testing for authentication"
26942 If the SMTP connection is not authenticated, the condition is false. Otherwise,
26943 the name of the authenticator is tested against the list. To test for
26944 authentication by any authenticator, you can set
26945 .code
26946 authenticated = *
26947 .endd
26948
26949 .vitem &*condition&~=&~*&<&'string'&>
26950 .cindex "&%condition%& ACL condition"
26951 .cindex "customizing" "ACL condition"
26952 .cindex "&ACL;" "customized test"
26953 .cindex "&ACL;" "testing, customized"
26954 This feature allows you to make up custom conditions. If the result of
26955 expanding the string is an empty string, the number zero, or one of the strings
26956 &"no"& or &"false"&, the condition is false. If the result is any non-zero
26957 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
26958 any other value, some error is assumed to have occurred, and the ACL returns
26959 &"defer"&. However, if the expansion is forced to fail, the condition is
26960 ignored. The effect is to treat it as true, whether it is positive or
26961 negative.
26962
26963 .vitem &*decode&~=&~*&<&'location'&>
26964 .cindex "&%decode%& ACL condition"
26965 This condition is available only when Exim is compiled with the
26966 content-scanning extension, and it is allowed only in the ACL defined by
26967 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
26968 If all goes well, the condition is true. It is false only if there are
26969 problems such as a syntax error or a memory shortage. For more details, see
26970 chapter &<<CHAPexiscan>>&.
26971
26972 .vitem &*demime&~=&~*&<&'extension&~list'&>
26973 .cindex "&%demime%& ACL condition"
26974 This condition is available only when Exim is compiled with the
26975 content-scanning extension. Its use is described in section
26976 &<<SECTdemimecond>>&.
26977
26978 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
26979 .cindex "&%dnslists%& ACL condition"
26980 .cindex "DNS list" "in ACL"
26981 .cindex "black list (DNS)"
26982 .cindex "&ACL;" "testing a DNS list"
26983 This condition checks for entries in DNS black lists. These are also known as
26984 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
26985 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
26986 different variants of this condition to describe briefly here. See sections
26987 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
26988
26989 .vitem &*domains&~=&~*&<&'domain&~list'&>
26990 .cindex "&%domains%& ACL condition"
26991 .cindex "domain" "ACL checking"
26992 .cindex "&ACL;" "testing a recipient domain"
26993 .vindex "&$domain_data$&"
26994 This condition is relevant only after a RCPT command. It checks that the domain
26995 of the recipient address is in the domain list. If percent-hack processing is
26996 enabled, it is done before this test is done. If the check succeeds with a
26997 lookup, the result of the lookup is placed in &$domain_data$& until the next
26998 &%domains%& test.
26999
27000 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27001 use &%domains%& in a DATA ACL.
27002
27003
27004 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27005 .cindex "&%encrypted%& ACL condition"
27006 .cindex "encryption" "checking in an ACL"
27007 .cindex "&ACL;" "testing for encryption"
27008 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27009 name of the cipher suite in use is tested against the list. To test for
27010 encryption without testing for any specific cipher suite(s), set
27011 .code
27012 encrypted = *
27013 .endd
27014
27015
27016 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
27017 .cindex "&%hosts%& ACL condition"
27018 .cindex "host" "ACL checking"
27019 .cindex "&ACL;" "testing the client host"
27020 This condition tests that the calling host matches the host list. If you have
27021 name lookups or wildcarded host names and IP addresses in the same host list,
27022 you should normally put the IP addresses first. For example, you could have:
27023 .code
27024 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27025 .endd
27026 The lookup in this example uses the host name for its key. This is implied by
27027 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27028 and it wouldn't matter which way round you had these two items.)
27029
27030 The reason for the problem with host names lies in the left-to-right way that
27031 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27032 but when it reaches an item that requires a host name, it fails if it cannot
27033 find a host name to compare with the pattern. If the above list is given in the
27034 opposite order, the &%accept%& statement fails for a host whose name cannot be
27035 found, even if its IP address is 10.9.8.7.
27036
27037 If you really do want to do the name check first, and still recognize the IP
27038 address even if the name lookup fails, you can rewrite the ACL like this:
27039 .code
27040 accept hosts = dbm;/etc/friendly/hosts
27041 accept hosts = 10.9.8.7
27042 .endd
27043 The default action on failing to find the host name is to assume that the host
27044 is not in the list, so the first &%accept%& statement fails. The second
27045 statement can then check the IP address.
27046
27047 .vindex "&$host_data$&"
27048 If a &%hosts%& condition is satisfied by means of a lookup, the result
27049 of the lookup is made available in the &$host_data$& variable. This
27050 allows you, for example, to set up a statement like this:
27051 .code
27052 deny  hosts = net-lsearch;/some/file
27053 message = $host_data
27054 .endd
27055 which gives a custom error message for each denied host.
27056
27057 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27058 .cindex "&%local_parts%& ACL condition"
27059 .cindex "local part" "ACL checking"
27060 .cindex "&ACL;" "testing a local part"
27061 .vindex "&$local_part_data$&"
27062 This condition is relevant only after a RCPT command. It checks that the local
27063 part of the recipient address is in the list. If percent-hack processing is
27064 enabled, it is done before this test. If the check succeeds with a lookup, the
27065 result of the lookup is placed in &$local_part_data$&, which remains set until
27066 the next &%local_parts%& test.
27067
27068 .vitem &*malware&~=&~*&<&'option'&>
27069 .cindex "&%malware%& ACL condition"
27070 .cindex "&ACL;" "virus scanning"
27071 .cindex "&ACL;" "scanning for viruses"
27072 This condition is available only when Exim is compiled with the
27073 content-scanning extension. It causes the incoming message to be scanned for
27074 viruses. For details, see chapter &<<CHAPexiscan>>&.
27075
27076 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27077 .cindex "&%mime_regex%& ACL condition"
27078 .cindex "&ACL;" "testing by regex matching"
27079 This condition is available only when Exim is compiled with the
27080 content-scanning extension, and it is allowed only in the ACL defined by
27081 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27082 with any of the regular expressions. For details, see chapter
27083 &<<CHAPexiscan>>&.
27084
27085 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27086 .cindex "rate limiting"
27087 This condition can be used to limit the rate at which a user or host submits
27088 messages. Details are given in section &<<SECTratelimiting>>&.
27089
27090 .vitem &*recipients&~=&~*&<&'address&~list'&>
27091 .cindex "&%recipients%& ACL condition"
27092 .cindex "recipient" "ACL checking"
27093 .cindex "&ACL;" "testing a recipient"
27094 This condition is relevant only after a RCPT command. It checks the entire
27095 recipient address against a list of recipients.
27096
27097 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27098 .cindex "&%regex%& ACL condition"
27099 .cindex "&ACL;" "testing by regex matching"
27100 This condition is available only when Exim is compiled with the
27101 content-scanning extension, and is available only in the DATA, MIME, and
27102 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27103 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27104
27105 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27106 .cindex "&%sender_domains%& ACL condition"
27107 .cindex "sender" "ACL checking"
27108 .cindex "&ACL;" "testing a sender domain"
27109 .vindex "&$domain$&"
27110 .vindex "&$sender_address_domain$&"
27111 This condition tests the domain of the sender of the message against the given
27112 domain list. &*Note*&: The domain of the sender address is in
27113 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27114 of this condition. This is an exception to the general rule for testing domain
27115 lists. It is done this way so that, if this condition is used in an ACL for a
27116 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27117 influence the sender checking.
27118
27119 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27120 relaying, because sender addresses are easily, and commonly, forged.
27121
27122 .vitem &*senders&~=&~*&<&'address&~list'&>
27123 .cindex "&%senders%& ACL condition"
27124 .cindex "sender" "ACL checking"
27125 .cindex "&ACL;" "testing a sender"
27126 This condition tests the sender of the message against the given list. To test
27127 for a bounce message, which has an empty sender, set
27128 .code
27129 senders = :
27130 .endd
27131 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27132 relaying, because sender addresses are easily, and commonly, forged.
27133
27134 .vitem &*spam&~=&~*&<&'username'&>
27135 .cindex "&%spam%& ACL condition"
27136 .cindex "&ACL;" "scanning for spam"
27137 This condition is available only when Exim is compiled with the
27138 content-scanning extension. It causes the incoming message to be scanned by
27139 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
27140
27141 .vitem &*verify&~=&~certificate*&
27142 .cindex "&%verify%& ACL condition"
27143 .cindex "TLS" "client certificate verification"
27144 .cindex "certificate" "verification of client"
27145 .cindex "&ACL;" "certificate verification"
27146 .cindex "&ACL;" "testing a TLS certificate"
27147 This condition is true in an SMTP session if the session is encrypted, and a
27148 certificate was received from the client, and the certificate was verified. The
27149 server requests a certificate only if the client matches &%tls_verify_hosts%&
27150 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
27151
27152 .vitem &*verify&~=&~csa*&
27153 .cindex "CSA verification"
27154 This condition checks whether the sending host (the client) is authorized to
27155 send email. Details of how this works are given in section
27156 &<<SECTverifyCSA>>&.
27157
27158 .vitem &*verify&~=&~header_sender/*&<&'options'&>
27159 .cindex "&%verify%& ACL condition"
27160 .cindex "&ACL;" "verifying sender in the header"
27161 .cindex "header lines" "verifying the sender in"
27162 .cindex "sender" "verifying in header"
27163 .cindex "verifying" "sender in header"
27164 This condition is relevant only in an ACL that is run after a message has been
27165 received, that is, in an ACL specified by &%acl_smtp_data%& or
27166 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
27167 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
27168 is loosely thought of as a &"sender"& address (hence the name of the test).
27169 However, an address that appears in one of these headers need not be an address
27170 that accepts bounce messages; only sender addresses in envelopes are required
27171 to accept bounces. Therefore, if you use the callout option on this check, you
27172 might want to arrange for a non-empty address in the MAIL command.
27173
27174 Details of address verification and the options are given later, starting at
27175 section &<<SECTaddressverification>>& (callouts are described in section
27176 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
27177 condition to restrict it to bounce messages only:
27178 .code
27179 deny    senders = :
27180         message = A valid sender header is required for bounces
27181        !verify  = header_sender
27182 .endd
27183
27184 .vitem &*verify&~=&~header_syntax*&
27185 .cindex "&%verify%& ACL condition"
27186 .cindex "&ACL;" "verifying header syntax"
27187 .cindex "header lines" "verifying syntax"
27188 .cindex "verifying" "header syntax"
27189 This condition is relevant only in an ACL that is run after a message has been
27190 received, that is, in an ACL specified by &%acl_smtp_data%& or
27191 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
27192 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
27193 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
27194 permitted only in locally generated messages and from hosts that match
27195 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
27196 appropriate.
27197
27198 Note that this condition is a syntax check only. However, a common spamming
27199 ploy used to be to send syntactically invalid headers such as
27200 .code
27201 To: @
27202 .endd
27203 and this condition can be used to reject such messages, though they are not as
27204 common as they used to be.
27205
27206 .vitem &*verify&~=&~helo*&
27207 .cindex "&%verify%& ACL condition"
27208 .cindex "&ACL;" "verifying HELO/EHLO"
27209 .cindex "HELO" "verifying"
27210 .cindex "EHLO" "verifying"
27211 .cindex "verifying" "EHLO"
27212 .cindex "verifying" "HELO"
27213 This condition is true if a HELO or EHLO command has been received from the
27214 client host, and its contents have been verified. If there has been no previous
27215 attempt to verify the HELO/EHLO contents, it is carried out when this
27216 condition is encountered. See the description of the &%helo_verify_hosts%& and
27217 &%helo_try_verify_hosts%& options for details of how to request verification
27218 independently of this condition.
27219
27220 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
27221 option), this condition is always true.
27222
27223
27224 .vitem &*verify&~=&~not_blind*&
27225 .cindex "verifying" "not blind"
27226 .cindex "bcc recipients, verifying none"
27227 This condition checks that there are no blind (bcc) recipients in the message.
27228 Every envelope recipient must appear either in a &'To:'& header line or in a
27229 &'Cc:'& header line for this condition to be true. Local parts are checked
27230 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
27231 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
27232 used only in a DATA or non-SMTP ACL.
27233
27234 There are, of course, many legitimate messages that make use of blind (bcc)
27235 recipients. This check should not be used on its own for blocking messages.
27236
27237
27238 .vitem &*verify&~=&~recipient/*&<&'options'&>
27239 .cindex "&%verify%& ACL condition"
27240 .cindex "&ACL;" "verifying recipient"
27241 .cindex "recipient" "verifying"
27242 .cindex "verifying" "recipient"
27243 .vindex "&$address_data$&"
27244 This condition is relevant only after a RCPT command. It verifies the current
27245 recipient. Details of address verification are given later, starting at section
27246 &<<SECTaddressverification>>&. After a recipient has been verified, the value
27247 of &$address_data$& is the last value that was set while routing the address.
27248 This applies even if the verification fails. When an address that is being
27249 verified is redirected to a single address, verification continues with the new
27250 address, and in that case, the subsequent value of &$address_data$& is the
27251 value for the child address.
27252
27253 .vitem &*verify&~=&~reverse_host_lookup*&
27254 .cindex "&%verify%& ACL condition"
27255 .cindex "&ACL;" "verifying host reverse lookup"
27256 .cindex "host" "verifying reverse lookup"
27257 This condition ensures that a verified host name has been looked up from the IP
27258 address of the client host. (This may have happened already if the host name
27259 was needed for checking a host list, or if the host matched &%host_lookup%&.)
27260 Verification ensures that the host name obtained from a reverse DNS lookup, or
27261 one of its aliases, does, when it is itself looked up in the DNS, yield the
27262 original IP address.
27263
27264 If this condition is used for a locally generated message (that is, when there
27265 is no client host involved), it always succeeds.
27266
27267 .vitem &*verify&~=&~sender/*&<&'options'&>
27268 .cindex "&%verify%& ACL condition"
27269 .cindex "&ACL;" "verifying sender"
27270 .cindex "sender" "verifying"
27271 .cindex "verifying" "sender"
27272 This condition is relevant only after a MAIL or RCPT command, or after a
27273 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
27274 the message's sender is empty (that is, this is a bounce message), the
27275 condition is true. Otherwise, the sender address is verified.
27276
27277 .vindex "&$address_data$&"
27278 .vindex "&$sender_address_data$&"
27279 If there is data in the &$address_data$& variable at the end of routing, its
27280 value is placed in &$sender_address_data$& at the end of verification. This
27281 value can be used in subsequent conditions and modifiers in the same ACL
27282 statement. It does not persist after the end of the current statement. If you
27283 want to preserve the value for longer, you can save it in an ACL variable.
27284
27285 Details of verification are given later, starting at section
27286 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
27287 to avoid doing it more than once per message.
27288
27289 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
27290 .cindex "&%verify%& ACL condition"
27291 This is a variation of the previous option, in which a modified address is
27292 verified as a sender.
27293 .endlist
27294
27295
27296
27297 .section "Using DNS lists" "SECTmorednslists"
27298 .cindex "DNS list" "in ACL"
27299 .cindex "black list (DNS)"
27300 .cindex "&ACL;" "testing a DNS list"
27301 In its simplest form, the &%dnslists%& condition tests whether the calling host
27302 is on at least one of a number of DNS lists by looking up the inverted IP
27303 address in one or more DNS domains. (Note that DNS list domains are not mail
27304 domains, so the &`+`& syntax for named lists doesn't work - it is used for
27305 special options instead.) For example, if the calling host's IP
27306 address is 192.168.62.43, and the ACL statement is
27307 .code
27308 deny dnslists = blackholes.mail-abuse.org : \
27309                 dialups.mail-abuse.org
27310 .endd
27311 the following records are looked up:
27312 .code
27313 43.62.168.192.blackholes.mail-abuse.org
27314 43.62.168.192.dialups.mail-abuse.org
27315 .endd
27316 As soon as Exim finds an existing DNS record, processing of the list stops.
27317 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
27318 to test that a host is on more than one list (an &"and"& conjunction), you can
27319 use two separate conditions:
27320 .code
27321 deny dnslists = blackholes.mail-abuse.org
27322      dnslists = dialups.mail-abuse.org
27323 .endd
27324 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
27325 behaves as if the host does not match the list item, that is, as if the DNS
27326 record does not exist. If there are further items in the DNS list, they are
27327 processed.
27328
27329 This is usually the required action when &%dnslists%& is used with &%deny%&
27330 (which is the most common usage), because it prevents a DNS failure from
27331 blocking mail. However, you can change this behaviour by putting one of the
27332 following special items in the list:
27333 .display
27334 &`+include_unknown `&   behave as if the item is on the list
27335 &`+exclude_unknown `&   behave as if the item is not on the list (default)
27336 &`+defer_unknown   `&   give a temporary error
27337 .endd
27338 .cindex "&`+include_unknown`&"
27339 .cindex "&`+exclude_unknown`&"
27340 .cindex "&`+defer_unknown`&"
27341 Each of these applies to any subsequent items on the list. For example:
27342 .code
27343 deny dnslists = +defer_unknown : foo.bar.example
27344 .endd
27345 Testing the list of domains stops as soon as a match is found. If you want to
27346 warn for one list and block for another, you can use two different statements:
27347 .code
27348 deny  dnslists = blackholes.mail-abuse.org
27349 warn  message  = X-Warn: sending host is on dialups list
27350       dnslists = dialups.mail-abuse.org
27351 .endd
27352 DNS list lookups are cached by Exim for the duration of the SMTP session,
27353 so a lookup based on the IP address is done at most once for any incoming
27354 connection. Exim does not share information between multiple incoming
27355 connections (but your local name server cache should be active).
27356
27357
27358
27359 .section "Specifying the IP address for a DNS list lookup" "SECID201"
27360 .cindex "DNS list" "keyed by explicit IP address"
27361 By default, the IP address that is used in a DNS list lookup is the IP address
27362 of the calling host. However, you can specify another IP address by listing it
27363 after the domain name, introduced by a slash. For example:
27364 .code
27365 deny dnslists = black.list.tld/192.168.1.2
27366 .endd
27367 This feature is not very helpful with explicit IP addresses; it is intended for
27368 use with IP addresses that are looked up, for example, the IP addresses of the
27369 MX hosts or nameservers of an email sender address. For an example, see section
27370 &<<SECTmulkeyfor>>& below.
27371
27372
27373
27374
27375 .section "DNS lists keyed on domain names" "SECID202"
27376 .cindex "DNS list" "keyed by domain name"
27377 There are some lists that are keyed on domain names rather than inverted IP
27378 addresses (see for example the &'domain based zones'& link at
27379 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
27380 with these lists. You can change the name that is looked up in a DNS list by
27381 listing it after the domain name, introduced by a slash. For example,
27382 .code
27383 deny  message  = Sender's domain is listed at $dnslist_domain
27384       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
27385 .endd
27386 This particular example is useful only in ACLs that are obeyed after the
27387 RCPT or DATA commands, when a sender address is available. If (for
27388 example) the message's sender is &'user@tld.example'& the name that is looked
27389 up by this example is
27390 .code
27391 tld.example.dsn.rfc-ignorant.org
27392 .endd
27393 A single &%dnslists%& condition can contain entries for both names and IP
27394 addresses. For example:
27395 .code
27396 deny dnslists = sbl.spamhaus.org : \
27397                 dsn.rfc-ignorant.org/$sender_address_domain
27398 .endd
27399 The first item checks the sending host's IP address; the second checks a domain
27400 name. The whole condition is true if either of the DNS lookups succeeds.
27401
27402
27403
27404
27405 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
27406 .cindex "DNS list" "multiple keys for"
27407 The syntax described above for looking up explicitly-defined values (either
27408 names or IP addresses) in a DNS blacklist is a simplification. After the domain
27409 name for the DNS list, what follows the slash can in fact be a list of items.
27410 As with all lists in Exim, the default separator is a colon. However, because
27411 this is a sublist within the list of DNS blacklist domains, it is necessary
27412 either to double the separators like this:
27413 .code
27414 dnslists = black.list.tld/name.1::name.2
27415 .endd
27416 or to change the separator character, like this:
27417 .code
27418 dnslists = black.list.tld/<;name.1;name.2
27419 .endd
27420 If an item in the list is an IP address, it is inverted before the DNS
27421 blacklist domain is appended. If it is not an IP address, no inversion
27422 occurs. Consider this condition:
27423 .code
27424 dnslists = black.list.tld/<;192.168.1.2;a.domain
27425 .endd
27426 The DNS lookups that occur are:
27427 .code
27428 2.1.168.192.black.list.tld
27429 a.domain.black.list.tld
27430 .endd
27431 Once a DNS record has been found (that matches a specific IP return
27432 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
27433 are done. If there is a temporary DNS error, the rest of the sublist of domains
27434 or IP addresses is tried. A temporary error for the whole dnslists item occurs
27435 only if no other DNS lookup in this sublist succeeds. In other words, a
27436 successful lookup for any of the items in the sublist overrides a temporary
27437 error for a previous item.
27438
27439 The ability to supply a list of items after the slash is in some sense just a
27440 syntactic convenience. These two examples have the same effect:
27441 .code
27442 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
27443 dnslists = black.list.tld/a.domain::b.domain
27444 .endd
27445 However, when the data for the list is obtained from a lookup, the second form
27446 is usually much more convenient. Consider this example:
27447 .code
27448 deny message  = The mail servers for the domain \
27449                 $sender_address_domain \
27450                 are listed at $dnslist_domain ($dnslist_value); \
27451                 see $dnslist_text.
27452      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
27453                                    ${lookup dnsdb {>|mxh=\
27454                                    $sender_address_domain} }} }
27455 .endd
27456 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
27457 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
27458 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
27459 of expanding the condition might be something like this:
27460 .code
27461 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
27462 .endd
27463 Thus, this example checks whether or not the IP addresses of the sender
27464 domain's mail servers are on the Spamhaus black list.
27465
27466 The key that was used for a successful DNS list lookup is put into the variable
27467 &$dnslist_matched$& (see section &<<SECID204>>&).
27468
27469
27470
27471
27472 .section "Data returned by DNS lists" "SECID203"
27473 .cindex "DNS list" "data returned from"
27474 DNS lists are constructed using address records in the DNS. The original RBL
27475 just used the address 127.0.0.1 on the right hand side of each record, but the
27476 RBL+ list and some other lists use a number of values with different meanings.
27477 The values used on the RBL+ list are:
27478 .display
27479 127.1.0.1  RBL
27480 127.1.0.2  DUL
27481 127.1.0.3  DUL and RBL
27482 127.1.0.4  RSS
27483 127.1.0.5  RSS and RBL
27484 127.1.0.6  RSS and DUL
27485 127.1.0.7  RSS and DUL and RBL
27486 .endd
27487 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
27488 different values. Some DNS lists may return more than one address record;
27489 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
27490
27491
27492 .section "Variables set from DNS lists" "SECID204"
27493 .cindex "expansion" "variables, set from DNS list"
27494 .cindex "DNS list" "variables set from"
27495 .vindex "&$dnslist_domain$&"
27496 .vindex "&$dnslist_matched$&"
27497 .vindex "&$dnslist_text$&"
27498 .vindex "&$dnslist_value$&"
27499 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
27500 the name of the overall domain that matched (for example,
27501 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
27502 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
27503 the DNS record. When the key is an IP address, it is not reversed in
27504 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
27505 cases, for example:
27506 .code
27507 deny dnslists = spamhaus.example
27508 .endd
27509 the key is also available in another variable (in this case,
27510 &$sender_host_address$&). In more complicated cases, however, this is not true.
27511 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
27512 might generate a dnslists lookup like this:
27513 .code
27514 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
27515 .endd
27516 If this condition succeeds, the value in &$dnslist_matched$& might be
27517 &`192.168.6.7`& (for example).
27518
27519 If more than one address record is returned by the DNS lookup, all the IP
27520 addresses are included in &$dnslist_value$&, separated by commas and spaces.
27521 The variable &$dnslist_text$& contains the contents of any associated TXT
27522 record. For lists such as RBL+ the TXT record for a merged entry is often not
27523 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
27524 information.
27525
27526 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
27527 &-- although these appear before the condition in the ACL, they are not
27528 expanded until after it has failed. For example:
27529 .code
27530 deny    hosts = !+local_networks
27531         message = $sender_host_address is listed \
27532                   at $dnslist_domain
27533         dnslists = rbl-plus.mail-abuse.example
27534 .endd
27535
27536
27537
27538 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
27539 .cindex "DNS list" "matching specific returned data"
27540 You can add an equals sign and an IP address after a &%dnslists%& domain name
27541 in order to restrict its action to DNS records with a matching right hand side.
27542 For example,
27543 .code
27544 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
27545 .endd
27546 rejects only those hosts that yield 127.0.0.2. Without this additional data,
27547 any address record is considered to be a match. For the moment, we assume
27548 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
27549 describes how multiple records are handled.
27550
27551 More than one IP address may be given for checking, using a comma as a
27552 separator. These are alternatives &-- if any one of them matches, the
27553 &%dnslists%& condition is true. For example:
27554 .code
27555 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27556 .endd
27557 If you want to specify a constraining address list and also specify names or IP
27558 addresses to be looked up, the constraining address list must be specified
27559 first. For example:
27560 .code
27561 deny dnslists = dsn.rfc-ignorant.org\
27562                 =127.0.0.2/$sender_address_domain
27563 .endd
27564
27565 If the character &`&&`& is used instead of &`=`&, the comparison for each
27566 listed IP address is done by a bitwise &"and"& instead of by an equality test.
27567 In other words, the listed addresses are used as bit masks. The comparison is
27568 true if all the bits in the mask are present in the address that is being
27569 tested. For example:
27570 .code
27571 dnslists = a.b.c&0.0.0.3
27572 .endd
27573 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
27574 want to test whether one bit or another bit is present (as opposed to both
27575 being present), you must use multiple values. For example:
27576 .code
27577 dnslists = a.b.c&0.0.0.1,0.0.0.2
27578 .endd
27579 matches if the final component of the address is an odd number or two times
27580 an odd number.
27581
27582
27583
27584 .section "Negated DNS matching conditions" "SECID205"
27585 You can supply a negative list of IP addresses as part of a &%dnslists%&
27586 condition. Whereas
27587 .code
27588 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27589 .endd
27590 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27591 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
27592 .code
27593 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
27594 .endd
27595 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27596 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
27597 words, the result of the test is inverted if an exclamation mark appears before
27598 the &`=`& (or the &`&&`&) sign.
27599
27600 &*Note*&: This kind of negation is not the same as negation in a domain,
27601 host, or address list (which is why the syntax is different).
27602
27603 If you are using just one list, the negation syntax does not gain you much. The
27604 previous example is precisely equivalent to
27605 .code
27606 deny  dnslists = a.b.c
27607      !dnslists = a.b.c=127.0.0.2,127.0.0.3
27608 .endd
27609 However, if you are using multiple lists, the negation syntax is clearer.
27610 Consider this example:
27611 .code
27612 deny  dnslists = sbl.spamhaus.org : \
27613                  list.dsbl.org : \
27614                  dnsbl.njabl.org!=127.0.0.3 : \
27615                  relays.ordb.org
27616 .endd
27617 Using only positive lists, this would have to be:
27618 .code
27619 deny  dnslists = sbl.spamhaus.org : \
27620                  list.dsbl.org
27621 deny  dnslists = dnsbl.njabl.org
27622      !dnslists = dnsbl.njabl.org=127.0.0.3
27623 deny  dnslists = relays.ordb.org
27624 .endd
27625 which is less clear, and harder to maintain.
27626
27627
27628
27629
27630 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
27631 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
27632 thereby providing more than one IP address. When an item in a &%dnslists%& list
27633 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
27634 the match to specific results from the DNS lookup, there are two ways in which
27635 the checking can be handled. For example, consider the condition:
27636 .code
27637 dnslists = a.b.c=127.0.0.1
27638 .endd
27639 What happens if the DNS lookup for the incoming IP address yields both
27640 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
27641 condition true because at least one given value was found, or is it false
27642 because at least one of the found values was not listed? And how does this
27643 affect negated conditions? Both possibilities are provided for with the help of
27644 additional separators &`==`& and &`=&&`&.
27645
27646 .ilist
27647 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
27648 IP addresses matches one of the listed addresses. For the example above, the
27649 condition is true because 127.0.0.1 matches.
27650 .next
27651 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
27652 looked up IP addresses matches one of the listed addresses. If the condition is
27653 changed to:
27654 .code
27655 dnslists = a.b.c==127.0.0.1
27656 .endd
27657 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27658 false because 127.0.0.2 is not listed. You would need to have:
27659 .code
27660 dnslists = a.b.c==127.0.0.1,127.0.0.2
27661 .endd
27662 for the condition to be true.
27663 .endlist
27664
27665 When &`!`& is used to negate IP address matching, it inverts the result, giving
27666 the precise opposite of the behaviour above. Thus:
27667 .ilist
27668 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
27669 addresses matches one of the listed addresses. Consider:
27670 .code
27671 dnslists = a.b.c!&0.0.0.1
27672 .endd
27673 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27674 false because 127.0.0.1 matches.
27675 .next
27676 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
27677 looked up IP address that does not match. Consider:
27678 .code
27679 dnslists = a.b.c!=&0.0.0.1
27680 .endd
27681 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27682 true, because 127.0.0.2 does not match. You would need to have:
27683 .code
27684 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
27685 .endd
27686 for the condition to be false.
27687 .endlist
27688 When the DNS lookup yields only a single IP address, there is no difference
27689 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
27690
27691
27692
27693
27694 .section "Detailed information from merged DNS lists" "SECTmordetinf"
27695 .cindex "DNS list" "information from merged"
27696 When the facility for restricting the matching IP values in a DNS list is used,
27697 the text from the TXT record that is set in &$dnslist_text$& may not reflect
27698 the true reason for rejection. This happens when lists are merged and the IP
27699 address in the A record is used to distinguish them; unfortunately there is
27700 only one TXT record. One way round this is not to use merged lists, but that
27701 can be inefficient because it requires multiple DNS lookups where one would do
27702 in the vast majority of cases when the host of interest is not on any of the
27703 lists.
27704
27705 A less inefficient way of solving this problem is available. If
27706 two domain names, comma-separated, are given, the second is used first to
27707 do an initial check, making use of any IP value restrictions that are set.
27708 If there is a match, the first domain is used, without any IP value
27709 restrictions, to get the TXT record. As a byproduct of this, there is also
27710 a check that the IP being tested is indeed on the first list. The first
27711 domain is the one that is put in &$dnslist_domain$&. For example:
27712 .code
27713 reject message  = \
27714          rejected because $sender_host_address is blacklisted \
27715          at $dnslist_domain\n$dnslist_text
27716        dnslists = \
27717          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
27718          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27719 .endd
27720 For the first blacklist item, this starts by doing a lookup in
27721 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
27722 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
27723 value, and as long as something is found, it looks for the corresponding TXT
27724 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
27725 The second blacklist item is processed similarly.
27726
27727 If you are interested in more than one merged list, the same list must be
27728 given several times, but because the results of the DNS lookups are cached,
27729 the DNS calls themselves are not repeated. For example:
27730 .code
27731 reject dnslists = \
27732          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
27733          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
27734          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
27735          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27736 .endd
27737 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
27738 values matches (or if no record is found), this is the only lookup that is
27739 done. Only if there is a match is one of the more specific lists consulted.
27740
27741
27742
27743 .section "DNS lists and IPv6" "SECTmorednslistslast"
27744 .cindex "IPv6" "DNS black lists"
27745 .cindex "DNS list" "IPv6 usage"
27746 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
27747 nibble by nibble. For example, if the calling host's IP address is
27748 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
27749 .code
27750 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
27751   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
27752 .endd
27753 (split over two lines here to fit on the page). Unfortunately, some of the DNS
27754 lists contain wildcard records, intended for IPv4, that interact badly with
27755 IPv6. For example, the DNS entry
27756 .code
27757 *.3.some.list.example.    A    127.0.0.1
27758 .endd
27759 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
27760 Unfortunately, it also matches the entire 3::/4 IPv6 network.
27761
27762 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
27763 &%condition%& condition, as in this example:
27764 .code
27765 deny   condition = ${if isip4{$sender_host_address}}
27766        dnslists  = some.list.example
27767 .endd
27768
27769 .section "Rate limiting incoming messages" "SECTratelimiting"
27770 .cindex "rate limiting" "client sending"
27771 .cindex "limiting client sending rates"
27772 .oindex "&%smtp_ratelimit_*%&"
27773 The &%ratelimit%& ACL condition can be used to measure and control the rate at
27774 which clients can send email. This is more powerful than the
27775 &%smtp_ratelimit_*%& options, because those options control the rate of
27776 commands in a single SMTP session only, whereas the &%ratelimit%& condition
27777 works across all connections (concurrent and sequential) from the same client
27778 host. The syntax of the &%ratelimit%& condition is:
27779 .display
27780 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
27781 .endd
27782 If the average client sending rate is less than &'m'& messages per time
27783 period &'p'& then the condition is false; otherwise it is true.
27784
27785 As a side-effect, the &%ratelimit%& condition sets the expansion variable
27786 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
27787 configured value of &'m'&, and &$sender_rate_period$& to the configured value
27788 of &'p'&.
27789
27790 The parameter &'p'& is the smoothing time constant, in the form of an Exim
27791 time interval, for example, &`8h`& for eight hours. A larger time constant
27792 means that it takes Exim longer to forget a client's past behaviour. The
27793 parameter &'m'& is the maximum number of messages that a client is permitted to
27794 send in each time interval. It also specifies the number of messages permitted
27795 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
27796 constant, you can allow a client to send more messages in a burst without
27797 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
27798 both small, messages must be sent at an even rate.
27799
27800 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
27801 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
27802 when deploying the &%ratelimit%& ACL condition. The script prints usage
27803 instructions when it is run with no arguments.
27804
27805 The key is used to look up the data for calculating the client's average
27806 sending rate. This data is stored in Exim's spool directory, alongside the
27807 retry and other hints databases. The default key is &$sender_host_address$&,
27808 which means Exim computes the sending rate of each client host IP address.
27809 By changing the key you can change how Exim identifies clients for the purpose
27810 of ratelimiting. For example, to limit the sending rate of each authenticated
27811 user, independent of the computer they are sending from, set the key to
27812 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
27813 example, &$authenticated_id$& is only meaningful if the client has
27814 authenticated (which you can check with the &%authenticated%& ACL condition).
27815
27816 The lookup key does not have to identify clients: If you want to limit the
27817 rate at which a recipient receives messages, you can use the key
27818 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27819 ACL.
27820
27821 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
27822 specifies what Exim measures the rate of, for example messages or recipients
27823 or bytes. You can adjust the measurement using the &%unique=%& and/or
27824 &%count=%& options. You can also control when Exim updates the recorded rate
27825 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
27826 separated by a slash, like the other parameters. They may appear in any order.
27827
27828 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
27829 any options that alter the meaning of the stored data. The limit &'m'& is not
27830 stored, so you can alter the configured maximum rate and Exim will still
27831 remember clients' past behaviour. If you change the &%per_*%& mode or add or
27832 remove the &%unique=%& option, the lookup key changes so Exim will forget past
27833 behaviour. The lookup key is not affected by changes to the update mode and
27834 the &%count=%& option.
27835
27836
27837 .section "Ratelimit options for what is being measured" "ratoptmea"
27838 .cindex "rate limiting" "per_* options"
27839 The &%per_conn%& option limits the client's connection rate. It is not
27840 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
27841 &%acl_not_smtp_start%& ACLs.
27842
27843 The &%per_mail%& option limits the client's rate of sending messages. This is
27844 the default if none of the &%per_*%& options is specified. It can be used in
27845 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
27846 &%acl_smtp_data%&, or &%acl_not_smtp%&.
27847
27848 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
27849 the same ACLs as the &%per_mail%& option, though it is best to use this option
27850 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
27851 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
27852 in its MAIL command, which may be inaccurate or completely missing. You can
27853 follow the limit &'m'& in the configuration with K, M, or G to specify limits
27854 in kilobytes, megabytes, or gigabytes, respectively.
27855
27856 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
27857 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27858 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
27859 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
27860 ACLs the rate is updated with the total recipient count in one go. Note that
27861 in either case the rate limiting engine will see a message with many
27862 recipients as a large high-speed burst.
27863
27864 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
27865 number of different recipients that the client has sent messages to in the
27866 last time period. That is, if the client repeatedly sends messages to the same
27867 recipient, its measured rate is not increased. This option can only be used in
27868 &%acl_smtp_rcpt%&.
27869
27870 The &%per_cmd%& option causes Exim to recompute the rate every time the
27871 condition is processed. This can be used to limit the rate of any SMTP
27872 command. If it is used in multiple ACLs it can limit the aggregate rate of
27873 multiple different commands.
27874
27875 The &%count=%& option can be used to alter how much Exim adds to the client's
27876 measured rate. For example, the &%per_byte%& option is equivalent to
27877 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
27878 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
27879 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
27880
27881 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
27882
27883
27884 .section "Ratelimit update modes" "ratoptupd"
27885 .cindex "rate limiting" "reading data without updating"
27886 You can specify one of three options with the &%ratelimit%& condition to
27887 control when its database is updated. This section describes the &%readonly%&
27888 mode, and the next section describes the &%strict%& and &%leaky%& modes.
27889
27890 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
27891 previously-computed rate to check against the limit.
27892
27893 For example, you can test the client's sending rate and deny it access (when
27894 it is too fast) in the connect ACL. If the client passes this check then it
27895 can go on to send a message, in which case its recorded rate will be updated
27896 in the MAIL ACL. Subsequent connections from the same client will check this
27897 new rate.
27898 .code
27899 acl_check_connect:
27900  deny ratelimit = 100 / 5m / readonly
27901     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
27902                   (max $sender_rate_limit)
27903 # ...
27904 acl_check_mail:
27905  warn ratelimit = 100 / 5m / strict
27906     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
27907                   (max $sender_rate_limit)
27908 .endd
27909
27910 If Exim encounters multiple &%ratelimit%& conditions with the same key when
27911 processing a message then it may increase the client's measured rate more than
27912 it should. For example, this will happen if you check the &%per_rcpt%& option
27913 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
27914 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
27915 multiple update problems by using the &%readonly%& option on later ratelimit
27916 checks.
27917
27918 The &%per_*%& options described above do not make sense in some ACLs. If you
27919 use a &%per_*%& option in an ACL where it is not normally permitted then the
27920 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
27921 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
27922 next section) so you must specify the &%readonly%& option explicitly.
27923
27924
27925 .section "Ratelimit options for handling fast clients" "ratoptfast"
27926 .cindex "rate limiting" "strict and leaky modes"
27927 If a client's average rate is greater than the maximum, the rate limiting
27928 engine can react in two possible ways, depending on the presence of the
27929 &%strict%& or &%leaky%& update modes. This is independent of the other
27930 counter-measures (such as rejecting the message) that may be specified by the
27931 rest of the ACL.
27932
27933 The &%leaky%& (default) option means that the client's recorded rate is not
27934 updated if it is above the limit. The effect of this is that Exim measures the
27935 client's average rate of successfully sent email, which cannot be greater than
27936 the maximum allowed. If the client is over the limit it may suffer some
27937 counter-measures (as specified in the ACL), but it will still be able to send
27938 email at the configured maximum rate, whatever the rate of its attempts. This
27939 is generally the better choice if you have clients that retry automatically.
27940 For example, it does not prevent a sender with an over-aggressive retry rate
27941 from getting any email through.
27942
27943 The &%strict%& option means that the client's recorded rate is always
27944 updated. The effect of this is that Exim measures the client's average rate
27945 of attempts to send email, which can be much higher than the maximum it is
27946 actually allowed. If the client is over the limit it may be subjected to
27947 counter-measures by the ACL. It must slow down and allow sufficient time to
27948 pass that its computed rate falls below the maximum before it can send email
27949 again. The time (the number of smoothing periods) it must wait and not
27950 attempt to send mail can be calculated with this formula:
27951 .code
27952         ln(peakrate/maxrate)
27953 .endd
27954
27955
27956 .section "Limiting the rate of different events" "ratoptuniq"
27957 .cindex "rate limiting" "counting unique events"
27958 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
27959 rate of different events. For example, the &%per_addr%& option uses this
27960 mechanism to count the number of different recipients that the client has
27961 sent messages to in the last time period; it is equivalent to
27962 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
27963 measure the rate that a client uses different sender addresses with the
27964 options &`per_mail/unique=$sender_address`&.
27965
27966 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
27967 has seen for that key. The whole set is thrown away when it is older than the
27968 rate smoothing period &'p'&, so each different event is counted at most once
27969 per period. In the &%leaky%& update mode, an event that causes the client to
27970 go over the limit is not added to the set, in the same way that the client's
27971 recorded rate is not updated in the same situation.
27972
27973 When you combine the &%unique=%& and &%readonly%& options, the specific
27974 &%unique=%& value is ignored, and Exim just retrieves the client's stored
27975 rate.
27976
27977 The &%unique=%& mechanism needs more space in the ratelimit database than the
27978 other &%ratelimit%& options in order to store the event set. The number of
27979 unique values is potentially as large as the rate limit, so the extra space
27980 required increases with larger limits.
27981
27982 The uniqueification is not perfect: there is a small probability that Exim
27983 will think a new event has happened before. If the sender's rate is less than
27984 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
27985 the measured rate can go above the limit, in which case Exim may under-count
27986 events by a significant margin. Fortunately, if the rate is high enough (2.7
27987 times the limit) that the false positive rate goes above 9%, then Exim will
27988 throw away the over-full event set before the measured rate falls below the
27989 limit. Therefore the only harm should be that exceptionally high sending rates
27990 are logged incorrectly; any countermeasures you configure will be as effective
27991 as intended.
27992
27993
27994 .section "Using rate limiting" "useratlim"
27995 Exim's other ACL facilities are used to define what counter-measures are taken
27996 when the rate limit is exceeded. This might be anything from logging a warning
27997 (for example, while measuring existing sending rates in order to define
27998 policy), through time delays to slow down fast senders, up to rejecting the
27999 message. For example:
28000 .code
28001 # Log all senders' rates
28002 warn ratelimit = 0 / 1h / strict
28003      log_message = Sender rate $sender_rate / $sender_rate_period
28004
28005 # Slow down fast senders; note the need to truncate $sender_rate
28006 # at the decimal point.
28007 warn ratelimit = 100 / 1h / per_rcpt / strict
28008      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28009                    $sender_rate_limit }s
28010
28011 # Keep authenticated users under control
28012 deny authenticated = *
28013      ratelimit = 100 / 1d / strict / $authenticated_id
28014
28015 # System-wide rate limit
28016 defer message = Sorry, too busy. Try again later.
28017      ratelimit = 10 / 1s / $primary_hostname
28018
28019 # Restrict incoming rate from each host, with a default
28020 # set using a macro and special cases looked up in a table.
28021 defer message = Sender rate exceeds $sender_rate_limit \
28022                messages per $sender_rate_period
28023      ratelimit = ${lookup {$sender_host_address} \
28024                    cdb {DB/ratelimits.cdb} \
28025                    {$value} {RATELIMIT} }
28026 .endd
28027 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28028 especially with the &%per_rcpt%& option, you may suffer from a performance
28029 bottleneck caused by locking on the ratelimit hints database. Apart from
28030 making your ACLs less complicated, you can reduce the problem by using a
28031 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28032 this means that Exim will lose its hints data after a reboot (including retry
28033 hints, the callout cache, and ratelimit data).
28034
28035
28036
28037 .section "Address verification" "SECTaddressverification"
28038 .cindex "verifying address" "options for"
28039 .cindex "policy control" "address verification"
28040 Several of the &%verify%& conditions described in section
28041 &<<SECTaclconditions>>& cause addresses to be verified. Section
28042 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28043 The verification conditions can be followed by options that modify the
28044 verification process. The options are separated from the keyword and from each
28045 other by slashes, and some of them contain parameters. For example:
28046 .code
28047 verify = sender/callout
28048 verify = recipient/defer_ok/callout=10s,defer_ok
28049 .endd
28050 The first stage of address verification, which always happens, is to run the
28051 address through the routers, in &"verify mode"&. Routers can detect the
28052 difference between verification and routing for delivery, and their actions can
28053 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28054 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28055 The available options are as follows:
28056
28057 .ilist
28058 If the &%callout%& option is specified, successful routing to one or more
28059 remote hosts is followed by a &"callout"& to those hosts as an additional
28060 check. Callouts and their sub-options are discussed in the next section.
28061 .next
28062 If there is a defer error while doing verification routing, the ACL
28063 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28064 options, the condition is forced to be true instead. Note that this is a main
28065 verification option as well as a suboption for callouts.
28066 .next
28067 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28068 discusses the reporting of sender address verification failures.
28069 .next
28070 The &%success_on_redirect%& option causes verification always to succeed
28071 immediately after a successful redirection. By default, if a redirection
28072 generates just one address, that address is also verified. See further
28073 discussion in section &<<SECTredirwhilveri>>&.
28074 .endlist
28075
28076 .cindex "verifying address" "differentiating failures"
28077 .vindex "&$recipient_verify_failure$&"
28078 .vindex "&$sender_verify_failure$&"
28079 .vindex "&$acl_verify_message$&"
28080 After an address verification failure, &$acl_verify_message$& contains the
28081 error message that is associated with the failure. It can be preserved by
28082 coding like this:
28083 .code
28084 warn  !verify = sender
28085        set acl_m0 = $acl_verify_message
28086 .endd
28087 If you are writing your own custom rejection message or log message when
28088 denying access, you can use this variable to include information about the
28089 verification failure.
28090
28091 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28092 appropriate) contains one of the following words:
28093
28094 .ilist
28095 &%qualify%&: The address was unqualified (no domain), and the message
28096 was neither local nor came from an exempted host.
28097 .next
28098 &%route%&: Routing failed.
28099 .next
28100 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28101 occurred at or before the MAIL command (that is, on initial
28102 connection, HELO, or MAIL).
28103 .next
28104 &%recipient%&: The RCPT command in a callout was rejected.
28105 .next
28106 &%postmaster%&: The postmaster check in a callout was rejected.
28107 .endlist
28108
28109 The main use of these variables is expected to be to distinguish between
28110 rejections of MAIL and rejections of RCPT in callouts.
28111
28112
28113
28114
28115 .section "Callout verification" "SECTcallver"
28116 .cindex "verifying address" "by callout"
28117 .cindex "callout" "verification"
28118 .cindex "SMTP" "callout verification"
28119 For non-local addresses, routing verifies the domain, but is unable to do any
28120 checking of the local part. There are situations where some means of verifying
28121 the local part is desirable. One way this can be done is to make an SMTP
28122 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28123 a subsequent host for a recipient address, to see if the host accepts the
28124 address. We use the term &'callout'& to cover both cases. Note that for a
28125 sender address, the callback is not to the client host that is trying to
28126 deliver the message, but to one of the hosts that accepts incoming mail for the
28127 sender's domain.
28128
28129 Exim does not do callouts by default. If you want them to happen, you must
28130 request them by setting appropriate options on the &%verify%& condition, as
28131 described below. This facility should be used with care, because it can add a
28132 lot of resource usage to the cost of verifying an address. However, Exim does
28133 cache the results of callouts, which helps to reduce the cost. Details of
28134 caching are in section &<<SECTcallvercache>>&.
28135
28136 Recipient callouts are usually used only between hosts that are controlled by
28137 the same administration. For example, a corporate gateway host could use
28138 callouts to check for valid recipients on an internal mailserver. A successful
28139 callout does not guarantee that a real delivery to the address would succeed;
28140 on the other hand, a failing callout does guarantee that a delivery would fail.
28141
28142 If the &%callout%& option is present on a condition that verifies an address, a
28143 second stage of verification occurs if the address is successfully routed to
28144 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
28145 &(manualroute)& router, where the router specifies the hosts. However, if a
28146 router that does not set up hosts routes to an &(smtp)& transport with a
28147 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
28148 &%hosts_override%& set, its hosts are always used, whether or not the router
28149 supplies a host list.
28150
28151 The port that is used is taken from the transport, if it is specified and is a
28152 remote transport. (For routers that do verification only, no transport need be
28153 specified.) Otherwise, the default SMTP port is used. If a remote transport
28154 specifies an outgoing interface, this is used; otherwise the interface is not
28155 specified. Likewise, the text that is used for the HELO command is taken from
28156 the transport's &%helo_data%& option; if there is no transport, the value of
28157 &$smtp_active_hostname$& is used.
28158
28159 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
28160 test whether a bounce message could be delivered to the sender address. The
28161 following SMTP commands are sent:
28162 .display
28163 &`HELO `&<&'local host name'&>
28164 &`MAIL FROM:<>`&
28165 &`RCPT TO:`&<&'the address to be tested'&>
28166 &`QUIT`&
28167 .endd
28168 LHLO is used instead of HELO if the transport's &%protocol%& option is
28169 set to &"lmtp"&.
28170
28171 A recipient callout check is similar. By default, it also uses an empty address
28172 for the sender. This default is chosen because most hosts do not make use of
28173 the sender address when verifying a recipient. Using the same address means
28174 that a single cache entry can be used for each recipient. Some sites, however,
28175 do make use of the sender address when verifying. These are catered for by the
28176 &%use_sender%& and &%use_postmaster%& options, described in the next section.
28177
28178 If the response to the RCPT command is a 2&'xx'& code, the verification
28179 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
28180 Exim tries the next host, if any. If there is a problem with all the remote
28181 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
28182 &%callout%& option is given, in which case the condition is forced to succeed.
28183
28184 .cindex "SMTP" "output flushing, disabling for callout"
28185 A callout may take a little time. For this reason, Exim normally flushes SMTP
28186 output before performing a callout in an ACL, to avoid unexpected timeouts in
28187 clients when the SMTP PIPELINING extension is in use. The flushing can be
28188 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
28189
28190
28191
28192
28193 .section "Additional parameters for callouts" "CALLaddparcall"
28194 .cindex "callout" "additional parameters for"
28195 The &%callout%& option can be followed by an equals sign and a number of
28196 optional parameters, separated by commas. For example:
28197 .code
28198 verify = recipient/callout=10s,defer_ok
28199 .endd
28200 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
28201 separate verify options, is retained for backwards compatibility, but is now
28202 deprecated. The additional parameters for &%callout%& are as follows:
28203
28204
28205 .vlist
28206 .vitem <&'a&~time&~interval'&>
28207 .cindex "callout" "timeout, specifying"
28208 This specifies the timeout that applies for the callout attempt to each host.
28209 For example:
28210 .code
28211 verify = sender/callout=5s
28212 .endd
28213 The default is 30 seconds. The timeout is used for each response from the
28214 remote host. It is also used for the initial connection, unless overridden by
28215 the &%connect%& parameter.
28216
28217
28218 .vitem &*connect&~=&~*&<&'time&~interval'&>
28219 .cindex "callout" "connection timeout, specifying"
28220 This parameter makes it possible to set a different (usually smaller) timeout
28221 for making the SMTP connection. For example:
28222 .code
28223 verify = sender/callout=5s,connect=1s
28224 .endd
28225 If not specified, this timeout defaults to the general timeout value.
28226
28227 .vitem &*defer_ok*&
28228 .cindex "callout" "defer, action on"
28229 When this parameter is present, failure to contact any host, or any other kind
28230 of temporary error, is treated as success by the ACL. However, the cache is not
28231 updated in this circumstance.
28232
28233 .vitem &*fullpostmaster*&
28234 .cindex "callout" "full postmaster check"
28235 This operates like the &%postmaster%& option (see below), but if the check for
28236 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
28237 accordance with the specification in RFC 2821. The RFC states that the
28238 unqualified address &'postmaster'& should be accepted.
28239
28240
28241 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
28242 .cindex "callout" "sender when verifying header"
28243 When verifying addresses in header lines using the &%header_sender%&
28244 verification option, Exim behaves by default as if the addresses are envelope
28245 sender addresses from a message. Callout verification therefore tests to see
28246 whether a bounce message could be delivered, by using an empty address in the
28247 MAIL command. However, it is arguable that these addresses might never be used
28248 as envelope senders, and could therefore justifiably reject bounce messages
28249 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
28250 address to use in the MAIL command. For example:
28251 .code
28252 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
28253 .endd
28254 This parameter is available only for the &%header_sender%& verification option.
28255
28256
28257 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
28258 .cindex "callout" "overall timeout, specifying"
28259 This parameter sets an overall timeout for performing a callout verification.
28260 For example:
28261 .code
28262 verify = sender/callout=5s,maxwait=30s
28263 .endd
28264 This timeout defaults to four times the callout timeout for individual SMTP
28265 commands. The overall timeout applies when there is more than one host that can
28266 be tried. The timeout is checked before trying the next host. This prevents
28267 very long delays if there are a large number of hosts and all are timing out
28268 (for example, when network connections are timing out).
28269
28270
28271 .vitem &*no_cache*&
28272 .cindex "callout" "cache, suppressing"
28273 .cindex "caching callout, suppressing"
28274 When this parameter is given, the callout cache is neither read nor updated.
28275
28276 .vitem &*postmaster*&
28277 .cindex "callout" "postmaster; checking"
28278 When this parameter is set, a successful callout check is followed by a similar
28279 check for the local part &'postmaster'& at the same domain. If this address is
28280 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
28281 the postmaster check is recorded in a cache record; if it is a failure, this is
28282 used to fail subsequent callouts for the domain without a connection being
28283 made, until the cache record expires.
28284
28285 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
28286 The postmaster check uses an empty sender in the MAIL command by default.
28287 You can use this parameter to do a postmaster check using a different address.
28288 For example:
28289 .code
28290 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
28291 .endd
28292 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
28293 one overrides. The &%postmaster%& parameter is equivalent to this example:
28294 .code
28295 require  verify = sender/callout=postmaster_mailfrom=
28296 .endd
28297 &*Warning*&: The caching arrangements for postmaster checking do not take
28298 account of the sender address. It is assumed that either the empty address or
28299 a fixed non-empty address will be used. All that Exim remembers is that the
28300 postmaster check for the domain succeeded or failed.
28301
28302
28303 .vitem &*random*&
28304 .cindex "callout" "&""random""& check"
28305 When this parameter is set, before doing the normal callout check, Exim does a
28306 check for a &"random"& local part at the same domain. The local part is not
28307 really random &-- it is defined by the expansion of the option
28308 &%callout_random_local_part%&, which defaults to
28309 .code
28310 $primary_hostname-$tod_epoch-testing
28311 .endd
28312 The idea here is to try to determine whether the remote host accepts all local
28313 parts without checking. If it does, there is no point in doing callouts for
28314 specific local parts. If the &"random"& check succeeds, the result is saved in
28315 a cache record, and used to force the current and subsequent callout checks to
28316 succeed without a connection being made, until the cache record expires.
28317
28318 .vitem &*use_postmaster*&
28319 .cindex "callout" "sender for recipient check"
28320 This parameter applies to recipient callouts only. For example:
28321 .code
28322 deny  !verify = recipient/callout=use_postmaster
28323 .endd
28324 .vindex "&$qualify_domain$&"
28325 It causes a non-empty postmaster address to be used in the MAIL command when
28326 performing the callout for the recipient, and also for a &"random"& check if
28327 that is configured. The local part of the address is &`postmaster`& and the
28328 domain is the contents of &$qualify_domain$&.
28329
28330 .vitem &*use_sender*&
28331 This option applies to recipient callouts only. For example:
28332 .code
28333 require  verify = recipient/callout=use_sender
28334 .endd
28335 It causes the message's actual sender address to be used in the MAIL
28336 command when performing the callout, instead of an empty address. There is no
28337 need to use this option unless you know that the called hosts make use of the
28338 sender when checking recipients. If used indiscriminately, it reduces the
28339 usefulness of callout caching.
28340 .endlist
28341
28342 If you use any of the parameters that set a non-empty sender for the MAIL
28343 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
28344 &%use_sender%&), you should think about possible loops. Recipient checking is
28345 usually done between two hosts that are under the same management, and the host
28346 that receives the callouts is not normally configured to do callouts itself.
28347 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
28348 these circumstances.
28349
28350 However, if you use a non-empty sender address for a callout to an arbitrary
28351 host, there is the likelihood that the remote host will itself initiate a
28352 callout check back to your host. As it is checking what appears to be a message
28353 sender, it is likely to use an empty address in MAIL, thus avoiding a
28354 callout loop. However, to be on the safe side it would be best to set up your
28355 own ACLs so that they do not do sender verification checks when the recipient
28356 is the address you use for header sender or postmaster callout checking.
28357
28358 Another issue to think about when using non-empty senders for callouts is
28359 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
28360 by the sender/recipient combination; thus, for any given recipient, many more
28361 actual callouts are performed than when an empty sender or postmaster is used.
28362
28363
28364
28365
28366 .section "Callout caching" "SECTcallvercache"
28367 .cindex "hints database" "callout cache"
28368 .cindex "callout" "cache, description of"
28369 .cindex "caching" "callout"
28370 Exim caches the results of callouts in order to reduce the amount of resources
28371 used, unless you specify the &%no_cache%& parameter with the &%callout%&
28372 option. A hints database called &"callout"& is used for the cache. Two
28373 different record types are used: one records the result of a callout check for
28374 a specific address, and the other records information that applies to the
28375 entire domain (for example, that it accepts the local part &'postmaster'&).
28376
28377 When an original callout fails, a detailed SMTP error message is given about
28378 the failure. However, for subsequent failures use the cache data, this message
28379 is not available.
28380
28381 The expiry times for negative and positive address cache records are
28382 independent, and can be set by the global options &%callout_negative_expire%&
28383 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
28384
28385 If a host gives a negative response to an SMTP connection, or rejects any
28386 commands up to and including
28387 .code
28388 MAIL FROM:<>
28389 .endd
28390 (but not including the MAIL command with a non-empty address),
28391 any callout attempt is bound to fail. Exim remembers such failures in a
28392 domain cache record, which it uses to fail callouts for the domain without
28393 making new connections, until the domain record times out. There are two
28394 separate expiry times for domain cache records:
28395 &%callout_domain_negative_expire%& (default 3h) and
28396 &%callout_domain_positive_expire%& (default 7d).
28397
28398 Domain records expire when the negative expiry time is reached if callouts
28399 cannot be made for the domain, or if the postmaster check failed.
28400 Otherwise, they expire when the positive expiry time is reached. This
28401 ensures that, for example, a host that stops accepting &"random"& local parts
28402 will eventually be noticed.
28403
28404 The callout caching mechanism is based on the domain of the address that is
28405 being tested. If the domain routes to several hosts, it is assumed that their
28406 behaviour will be the same.
28407
28408
28409
28410 .section "Sender address verification reporting" "SECTsenaddver"
28411 .cindex "verifying" "suppressing error details"
28412 See section &<<SECTaddressverification>>& for a general discussion of
28413 verification. When sender verification fails in an ACL, the details of the
28414 failure are given as additional output lines before the 550 response to the
28415 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
28416 you might see:
28417 .code
28418 MAIL FROM:<xyz@abc.example>
28419 250 OK
28420 RCPT TO:<pqr@def.example>
28421 550-Verification failed for <xyz@abc.example>
28422 550-Called:   192.168.34.43
28423 550-Sent:     RCPT TO:<xyz@abc.example>
28424 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
28425 550 Sender verification failed
28426 .endd
28427 If more than one RCPT command fails in the same way, the details are given
28428 only for the first of them. However, some administrators do not want to send
28429 out this much information. You can suppress the details by adding
28430 &`/no_details`& to the ACL statement that requests sender verification. For
28431 example:
28432 .code
28433 verify = sender/no_details
28434 .endd
28435
28436 .section "Redirection while verifying" "SECTredirwhilveri"
28437 .cindex "verifying" "redirection while"
28438 .cindex "address redirection" "while verifying"
28439 A dilemma arises when a local address is redirected by aliasing or forwarding
28440 during verification: should the generated addresses themselves be verified,
28441 or should the successful expansion of the original address be enough to verify
28442 it? By default, Exim takes the following pragmatic approach:
28443
28444 .ilist
28445 When an incoming address is redirected to just one child address, verification
28446 continues with the child address, and if that fails to verify, the original
28447 verification also fails.
28448 .next
28449 When an incoming address is redirected to more than one child address,
28450 verification does not continue. A success result is returned.
28451 .endlist
28452
28453 This seems the most reasonable behaviour for the common use of aliasing as a
28454 way of redirecting different local parts to the same mailbox. It means, for
28455 example, that a pair of alias entries of the form
28456 .code
28457 A.Wol:   aw123
28458 aw123:   :fail: Gone away, no forwarding address
28459 .endd
28460 work as expected, with both local parts causing verification failure. When a
28461 redirection generates more than one address, the behaviour is more like a
28462 mailing list, where the existence of the alias itself is sufficient for
28463 verification to succeed.
28464
28465 It is possible, however, to change the default behaviour so that all successful
28466 redirections count as successful verifications, however many new addresses are
28467 generated. This is specified by the &%success_on_redirect%& verification
28468 option. For example:
28469 .code
28470 require verify = recipient/success_on_redirect/callout=10s
28471 .endd
28472 In this example, verification succeeds if a router generates a new address, and
28473 the callout does not occur, because no address was routed to a remote host.
28474
28475 When verification is being tested via the &%-bv%& option, the treatment of
28476 redirections is as just described, unless the &%-v%& or any debugging option is
28477 also specified. In that case, full verification is done for every generated
28478 address and a report is output for each of them.
28479
28480
28481
28482 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
28483 .cindex "CSA" "verifying"
28484 Client SMTP Authorization is a system that allows a site to advertise
28485 which machines are and are not permitted to send email. This is done by placing
28486 special SRV records in the DNS; these are looked up using the client's HELO
28487 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
28488 Authorization checks in Exim are performed by the ACL condition:
28489 .code
28490 verify = csa
28491 .endd
28492 This fails if the client is not authorized. If there is a DNS problem, or if no
28493 valid CSA SRV record is found, or if the client is authorized, the condition
28494 succeeds. These three cases can be distinguished using the expansion variable
28495 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
28496 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
28497 be likely to cause problems for legitimate email.
28498
28499 The error messages produced by the CSA code include slightly more
28500 detail. If &$csa_status$& is &"defer"&, this may be because of problems
28501 looking up the CSA SRV record, or problems looking up the CSA target
28502 address record. There are four reasons for &$csa_status$& being &"fail"&:
28503
28504 .ilist
28505 The client's host name is explicitly not authorized.
28506 .next
28507 The client's IP address does not match any of the CSA target IP addresses.
28508 .next
28509 The client's host name is authorized but it has no valid target IP addresses
28510 (for example, the target's addresses are IPv6 and the client is using IPv4).
28511 .next
28512 The client's host name has no CSA SRV record but a parent domain has asserted
28513 that all subdomains must be explicitly authorized.
28514 .endlist
28515
28516 The &%csa%& verification condition can take an argument which is the domain to
28517 use for the DNS query. The default is:
28518 .code
28519 verify = csa/$sender_helo_name
28520 .endd
28521 This implementation includes an extension to CSA. If the query domain
28522 is an address literal such as [192.0.2.95], or if it is a bare IP
28523 address, Exim searches for CSA SRV records in the reverse DNS as if
28524 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
28525 meaningful to say:
28526 .code
28527 verify = csa/$sender_host_address
28528 .endd
28529 In fact, this is the check that Exim performs if the client does not say HELO.
28530 This extension can be turned off by setting the main configuration option
28531 &%dns_csa_use_reverse%& to be false.
28532
28533 If a CSA SRV record is not found for the domain itself, a search
28534 is performed through its parent domains for a record which might be
28535 making assertions about subdomains. The maximum depth of this search is limited
28536 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
28537 default. Exim does not look for CSA SRV records in a top level domain, so the
28538 default settings handle HELO domains as long as seven
28539 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
28540 of legitimate HELO domains.
28541
28542 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
28543 direct SRV lookups, this is not sufficient because of the extra parent domain
28544 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
28545 addresses into lookups in the reverse DNS space. The result of a successful
28546 lookup such as:
28547 .code
28548 ${lookup dnsdb {csa=$sender_helo_name}}
28549 .endd
28550 has two space-separated fields: an authorization code and a target host name.
28551 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
28552 authorization required but absent, or &"?"& for unknown.
28553
28554
28555
28556
28557 .section "Bounce address tag validation" "SECTverifyPRVS"
28558 .cindex "BATV, verifying"
28559 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
28560 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
28561 Genuine incoming bounce messages should therefore always be addressed to
28562 recipients that have a valid tag. This scheme is a way of detecting unwanted
28563 bounce messages caused by sender address forgeries (often called &"collateral
28564 spam"&), because the recipients of such messages do not include valid tags.
28565
28566 There are two expansion items to help with the implementation of the BATV
28567 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
28568 the original envelope sender address by using a simple key to add a hash of the
28569 address and some time-based randomizing information. The &%prvs%& expansion
28570 item creates a signed address, and the &%prvscheck%& expansion item checks one.
28571 The syntax of these expansion items is described in section
28572 &<<SECTexpansionitems>>&.
28573
28574 As an example, suppose the secret per-address keys are stored in an MySQL
28575 database. A query to look up the key for an address could be defined as a macro
28576 like this:
28577 .code
28578 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
28579                 WHERE sender='${quote_mysql:$prvscheck_address}'\
28580                 }{$value}}
28581 .endd
28582 Suppose also that the senders who make use of BATV are defined by an address
28583 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
28584 use this:
28585 .code
28586 # Bounces: drop unsigned addresses for BATV senders
28587 deny message = This address does not send an unsigned reverse path
28588      senders = :
28589      recipients = +batv_senders
28590
28591 # Bounces: In case of prvs-signed address, check signature.
28592 deny message = Invalid reverse path signature.
28593      senders = :
28594      condition  = ${prvscheck {$local_part@$domain}\
28595                   {PRVSCHECK_SQL}{1}}
28596      !condition = $prvscheck_result
28597 .endd
28598 The first statement rejects recipients for bounce messages that are addressed
28599 to plain BATV sender addresses, because it is known that BATV senders do not
28600 send out messages with plain sender addresses. The second statement rejects
28601 recipients that are prvs-signed, but with invalid signatures (either because
28602 the key is wrong, or the signature has timed out).
28603
28604 A non-prvs-signed address is not rejected by the second statement, because the
28605 &%prvscheck%& expansion yields an empty string if its first argument is not a
28606 prvs-signed address, thus causing the &%condition%& condition to be false. If
28607 the first argument is a syntactically valid prvs-signed address, the yield is
28608 the third string (in this case &"1"&), whether or not the cryptographic and
28609 timeout checks succeed. The &$prvscheck_result$& variable contains the result
28610 of the checks (empty for failure, &"1"& for success).
28611
28612 There is one more issue you must consider when implementing prvs-signing:
28613 you have to ensure that the routers accept prvs-signed addresses and
28614 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
28615 router to remove the signature with a configuration along these lines:
28616 .code
28617 batv_redirect:
28618   driver = redirect
28619   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
28620 .endd
28621 This works because, if the third argument of &%prvscheck%& is empty, the result
28622 of the expansion of a prvs-signed address is the decoded value of the original
28623 address. This router should probably be the first of your routers that handles
28624 local addresses.
28625
28626 To create BATV-signed addresses in the first place, a transport of this form
28627 can be used:
28628 .code
28629 external_smtp_batv:
28630   driver = smtp
28631   return_path = ${prvs {$return_path} \
28632                        {${lookup mysql{SELECT \
28633                        secret FROM batv_prvs WHERE \
28634                        sender='${quote_mysql:$sender_address}'} \
28635                        {$value}fail}}}
28636 .endd
28637 If no key can be found for the existing return path, no signing takes place.
28638
28639
28640
28641 .section "Using an ACL to control relaying" "SECTrelaycontrol"
28642 .cindex "&ACL;" "relay control"
28643 .cindex "relaying" "control by ACL"
28644 .cindex "policy control" "relay control"
28645 An MTA is said to &'relay'& a message if it receives it from some host and
28646 delivers it directly to another host as a result of a remote address contained
28647 within it. Redirecting a local address via an alias or forward file and then
28648 passing the message on to another host is not relaying,
28649 .cindex "&""percent hack""&"
28650 but a redirection as a result of the &"percent hack"& is.
28651
28652 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
28653 A host which is acting as a gateway or an MX backup is concerned with incoming
28654 relaying from arbitrary hosts to a specific set of domains. On the other hand,
28655 a host which is acting as a smart host for a number of clients is concerned
28656 with outgoing relaying from those clients to the Internet at large. Often the
28657 same host is fulfilling both functions,
28658 . ///
28659 . as illustrated in the diagram below,
28660 . ///
28661 but in principle these two kinds of relaying are entirely independent. What is
28662 not wanted is the transmission of mail from arbitrary remote hosts through your
28663 system to arbitrary domains.
28664
28665
28666 You can implement relay control by means of suitable statements in the ACL that
28667 runs for each RCPT command. For convenience, it is often easiest to use
28668 Exim's named list facility to define the domains and hosts involved. For
28669 example, suppose you want to do the following:
28670
28671 .ilist
28672 Deliver a number of domains to mailboxes on the local host (or process them
28673 locally in some other way). Let's say these are &'my.dom1.example'& and
28674 &'my.dom2.example'&.
28675 .next
28676 Relay mail for a number of other domains for which you are the secondary MX.
28677 These might be &'friend1.example'& and &'friend2.example'&.
28678 .next
28679 Relay mail from the hosts on your local LAN, to whatever domains are involved.
28680 Suppose your LAN is 192.168.45.0/24.
28681 .endlist
28682
28683
28684 In the main part of the configuration, you put the following definitions:
28685 .code
28686 domainlist local_domains = my.dom1.example : my.dom2.example
28687 domainlist relay_domains = friend1.example : friend2.example
28688 hostlist   relay_hosts   = 192.168.45.0/24
28689 .endd
28690 Now you can use these definitions in the ACL that is run for every RCPT
28691 command:
28692 .code
28693 acl_check_rcpt:
28694   accept domains = +local_domains : +relay_domains
28695   accept hosts   = +relay_hosts
28696 .endd
28697 The first statement accepts any RCPT command that contains an address in
28698 the local or relay domains. For any other domain, control passes to the second
28699 statement, which accepts the command only if it comes from one of the relay
28700 hosts. In practice, you will probably want to make your ACL more sophisticated
28701 than this, for example, by including sender and recipient verification. The
28702 default configuration includes a more comprehensive example, which is described
28703 in chapter &<<CHAPdefconfil>>&.
28704
28705
28706
28707 .section "Checking a relay configuration" "SECTcheralcon"
28708 .cindex "relaying" "checking control of"
28709 You can check the relay characteristics of your configuration in the same way
28710 that you can test any ACL behaviour for an incoming SMTP connection, by using
28711 the &%-bh%& option to run a fake SMTP session with which you interact.
28712
28713 For specifically testing for unwanted relaying, the host
28714 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
28715 host from the host on which Exim is running, using the normal telnet port, you
28716 will see a normal telnet connection message and then quite a long delay. Be
28717 patient. The remote host is making an SMTP connection back to your host, and
28718 trying a number of common probes to test for open relay vulnerability. The
28719 results of the tests will eventually appear on your terminal.
28720 .ecindex IIDacl
28721
28722
28723
28724 . ////////////////////////////////////////////////////////////////////////////
28725 . ////////////////////////////////////////////////////////////////////////////
28726
28727 .chapter "Content scanning at ACL time" "CHAPexiscan"
28728 .scindex IIDcosca "content scanning" "at ACL time"
28729 The extension of Exim to include content scanning at ACL time, formerly known
28730 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
28731 was integrated into the main source for Exim release 4.50, and Tom continues to
28732 maintain it. Most of the wording of this chapter is taken from Tom's
28733 specification.
28734
28735 It is also possible to scan the content of messages at other times. The
28736 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
28737 scanning after all the ACLs have run. A transport filter can be used to scan
28738 messages at delivery time (see the &%transport_filter%& option, described in
28739 chapter &<<CHAPtransportgeneric>>&).
28740
28741 If you want to include the ACL-time content-scanning features when you compile
28742 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
28743 &_Local/Makefile_&. When you do that, the Exim binary is built with:
28744
28745 .ilist
28746 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
28747 for all MIME parts for SMTP and non-SMTP messages, respectively.
28748 .next
28749 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
28750 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
28751 run at the end of message reception (the &%acl_smtp_data%& ACL).
28752 .next
28753 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
28754 of messages, or parts of messages, for debugging purposes.
28755 .next
28756 Additional expansion variables that are set in the new ACL and by the new
28757 conditions.
28758 .next
28759 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
28760 .endlist
28761
28762 There is another content-scanning configuration option for &_Local/Makefile_&,
28763 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
28764 condition is compiled, in addition to all the other content-scanning features.
28765
28766 Content-scanning is continually evolving, and new features are still being
28767 added. While such features are still unstable and liable to incompatible
28768 changes, they are made available in Exim by setting options whose names begin
28769 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
28770 this manual. You can find out about them by reading the file called
28771 &_doc/experimental.txt_&.
28772
28773 All the content-scanning facilities work on a MBOX copy of the message that is
28774 temporarily created in a file called:
28775 .display
28776 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
28777 .endd
28778 The &_.eml_& extension is a friendly hint to virus scanners that they can
28779 expect an MBOX-like structure inside that file. The file is created when the
28780 first content scanning facility is called. Subsequent calls to content
28781 scanning conditions open the same file again. The directory is recursively
28782 removed when the &%acl_smtp_data%& ACL has finished running, unless
28783 .code
28784 control = no_mbox_unspool
28785 .endd
28786 has been encountered. When the MIME ACL decodes files, they are put into the
28787 same directory by default.
28788
28789
28790
28791 .section "Scanning for viruses" "SECTscanvirus"
28792 .cindex "virus scanning"
28793 .cindex "content scanning" "for viruses"
28794 .cindex "content scanning" "the &%malware%& condition"
28795 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
28796 It supports a &"generic"& interface to scanners called via the shell, and
28797 specialized interfaces for &"daemon"& type virus scanners, which are resident
28798 in memory and thus are much faster.
28799
28800
28801 .oindex "&%av_scanner%&"
28802 You can set the &%av_scanner%& option in first part of the Exim configuration
28803 file to specify which scanner to use, together with any additional options that
28804 are needed. The basic syntax is as follows:
28805 .display
28806 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
28807 .endd
28808 If you do not set &%av_scanner%&, it defaults to
28809 .code
28810 av_scanner = sophie:/var/run/sophie
28811 .endd
28812 If the value of &%av_scanner%& starts with a dollar character, it is expanded
28813 before use. The following scanner types are supported in this release:
28814
28815 .vlist
28816 .vitem &%aveserver%&
28817 .cindex "virus scanners" "Kaspersky"
28818 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
28819 at &url(http://www.kaspersky.com). This scanner type takes one option,
28820 which is the path to the daemon's UNIX socket. The default is shown in this
28821 example:
28822 .code
28823 av_scanner = aveserver:/var/run/aveserver
28824 .endd
28825
28826
28827 .vitem &%clamd%&
28828 .cindex "virus scanners" "clamd"
28829 This daemon-type scanner is GPL and free. You can get it at
28830 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
28831 unpack MIME containers, so it used to be recommended to unpack MIME attachments
28832 in the MIME ACL. This no longer believed to be necessary. One option is
28833 required: either the path and name of a UNIX socket file, or a hostname or IP
28834 number, and a port, separated by space, as in the second of these examples:
28835 .code
28836 av_scanner = clamd:/opt/clamd/socket
28837 av_scanner = clamd:192.0.2.3 1234
28838 av_scanner = clamd:192.0.2.3 1234:local
28839 .endd
28840 If the value of av_scanner points to a UNIX socket file or contains the local
28841 keyword, then the ClamAV interface will pass a filename containing the data
28842 to be scanned, which will should normally result in less I/O happening and be
28843 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
28844 Exim does not assume that there is a common filesystem with the remote host.
28845 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
28846 you be running a version of ClamAV prior to 0.95.
28847 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
28848 contributing the code for this scanner.
28849
28850 .vitem &%cmdline%&
28851 .cindex "virus scanners" "command line interface"
28852 This is the keyword for the generic command line scanner interface. It can be
28853 used to attach virus scanners that are invoked from the shell. This scanner
28854 type takes 3 mandatory options:
28855
28856 .olist
28857 The full path and name of the scanner binary, with all command line options,
28858 and a placeholder (&`%s`&) for the directory to scan.
28859
28860 .next
28861 A regular expression to match against the STDOUT and STDERR output of the
28862 virus scanner. If the expression matches, a virus was found. You must make
28863 absolutely sure that this expression matches on &"virus found"&. This is called
28864 the &"trigger"& expression.
28865
28866 .next
28867 Another regular expression, containing exactly one pair of parentheses, to
28868 match the name of the virus found in the scanners output. This is called the
28869 &"name"& expression.
28870 .endlist olist
28871
28872 For example, Sophos Sweep reports a virus on a line like this:
28873 .code
28874 Virus 'W32/Magistr-B' found in file ./those.bat
28875 .endd
28876 For the trigger expression, we can match the phrase &"found in file"&. For the
28877 name expression, we want to extract the W32/Magistr-B string, so we can match
28878 for the single quotes left and right of it. Altogether, this makes the
28879 configuration setting:
28880 .code
28881 av_scanner = cmdline:\
28882              /path/to/sweep -ss -all -rec -archive %s:\
28883              found in file:'(.+)'
28884 .endd
28885 .vitem &%drweb%&
28886 .cindex "virus scanners" "DrWeb"
28887 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
28888 argument, either a full path to a UNIX socket, or an IP address and port
28889 separated by white space, as in these examples:
28890 .code
28891 av_scanner = drweb:/var/run/drwebd.sock
28892 av_scanner = drweb:192.168.2.20 31337
28893 .endd
28894 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
28895 is used. Thanks to Alex Miller for contributing the code for this scanner.
28896
28897 .vitem &%fsecure%&
28898 .cindex "virus scanners" "F-Secure"
28899 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
28900 argument which is the path to a UNIX socket. For example:
28901 .code
28902 av_scanner = fsecure:/path/to/.fsav
28903 .endd
28904 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
28905 Thelmen for contributing the code for this scanner.
28906
28907 .vitem &%kavdaemon%&
28908 .cindex "virus scanners" "Kaspersky"
28909 This is the scanner daemon of Kaspersky Version 4. This version of the
28910 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
28911 scanner type takes one option, which is the path to the daemon's UNIX socket.
28912 For example:
28913 .code
28914 av_scanner = kavdaemon:/opt/AVP/AvpCtl
28915 .endd
28916 The default path is &_/var/run/AvpCtl_&.
28917
28918 .vitem &%mksd%&
28919 .cindex "virus scanners" "mksd"
28920 This is a daemon type scanner that is aimed mainly at Polish users, though some
28921 parts of documentation are now available in English. You can get it at
28922 &url(http://linux.mks.com.pl/). The only option for this scanner type is
28923 the maximum number of processes used simultaneously to scan the attachments,
28924 provided that the demime facility is employed and also provided that mksd has
28925 been run with at least the same number of child processes. For example:
28926 .code
28927 av_scanner = mksd:2
28928 .endd
28929 You can safely omit this option (the default value is 1).
28930
28931 .vitem &%sophie%&
28932 .cindex "virus scanners" "Sophos and Sophie"
28933 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
28934 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
28935 for this scanner type is the path to the UNIX socket that Sophie uses for
28936 client communication. For example:
28937 .code
28938 av_scanner = sophie:/tmp/sophie
28939 .endd
28940 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
28941 the option.
28942 .endlist
28943
28944 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
28945 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
28946 ACL.
28947
28948 The &%av_scanner%& option is expanded each time &%malware%& is called. This
28949 makes it possible to use different scanners. See further below for an example.
28950 The &%malware%& condition caches its results, so when you use it multiple times
28951 for the same message, the actual scanning process is only carried out once.
28952 However, using expandable items in &%av_scanner%& disables this caching, in
28953 which case each use of the &%malware%& condition causes a new scan of the
28954 message.
28955
28956 The &%malware%& condition takes a right-hand argument that is expanded before
28957 use. It can then be one of
28958
28959 .ilist
28960 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
28961 The condition succeeds if a virus was found, and fail otherwise. This is the
28962 recommended usage.
28963 .next
28964 &"false"& or &"0"& or an empty string, in which case no scanning is done and
28965 the condition fails immediately.
28966 .next
28967 A regular expression, in which case the message is scanned for viruses. The
28968 condition succeeds if a virus is found and its name matches the regular
28969 expression. This allows you to take special actions on certain types of virus.
28970 .endlist
28971
28972 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
28973 even if there is a problem with the virus scanner. Otherwise, such a problem
28974 causes the ACL to defer.
28975
28976 .vindex "&$malware_name$&"
28977 When a virus is found, the condition sets up an expansion variable called
28978 &$malware_name$& that contains the name of the virus. You can use it in a
28979 &%message%& modifier that specifies the error returned to the sender, and/or in
28980 logging data.
28981
28982 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
28983 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
28984 &%malware%& condition.
28985
28986 Beware the interaction of Exim's &%message_size_limit%& with any size limits
28987 imposed by your anti-virus scanner.
28988
28989 Here is a very simple scanning example:
28990 .code
28991 deny message = This message contains malware ($malware_name)
28992      demime = *
28993      malware = *
28994 .endd
28995 The next example accepts messages when there is a problem with the scanner:
28996 .code
28997 deny message = This message contains malware ($malware_name)
28998      demime = *
28999      malware = */defer_ok
29000 .endd
29001 The next example shows how to use an ACL variable to scan with both sophie and
29002 aveserver. It assumes you have set:
29003 .code
29004 av_scanner = $acl_m0
29005 .endd
29006 in the main Exim configuration.
29007 .code
29008 deny message = This message contains malware ($malware_name)
29009      set acl_m0 = sophie
29010      malware = *
29011
29012 deny message = This message contains malware ($malware_name)
29013      set acl_m0 = aveserver
29014      malware = *
29015 .endd
29016
29017
29018 .section "Scanning with SpamAssassin" "SECTscanspamass"
29019 .cindex "content scanning" "for spam"
29020 .cindex "spam scanning"
29021 .cindex "SpamAssassin"
29022 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29023 score and a report for the message. You can get SpamAssassin at
29024 &url(http://www.spamassassin.org), or, if you have a working Perl
29025 installation, you can use CPAN by running:
29026 .code
29027 perl -MCPAN -e 'install Mail::SpamAssassin'
29028 .endd
29029 SpamAssassin has its own set of configuration files. Please review its
29030 documentation to see how you can tweak it. The default installation should work
29031 nicely, however.
29032
29033 .oindex "&%spamd_address%&"
29034 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29035 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29036 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29037 part of the Exim configuration as follows (example):
29038 .code
29039 spamd_address = 192.168.99.45 387
29040 .endd
29041 You do not need to set this option if you use the default. As of version 2.60,
29042 &%spamd%& also supports communication over UNIX sockets. If you want to use
29043 these, supply &%spamd_address%& with an absolute file name instead of a
29044 address/port pair:
29045 .code
29046 spamd_address = /var/run/spamd_socket
29047 .endd
29048 You can have multiple &%spamd%& servers to improve scalability. These can
29049 reside on other hardware reachable over the network. To specify multiple
29050 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29051 option, separated with colons:
29052 .code
29053 spamd_address = 192.168.2.10 783 : \
29054                 192.168.2.11 783 : \
29055                 192.168.2.12 783
29056 .endd
29057 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29058 fashion. When a server fails to respond to the connection attempt, all other
29059 servers are tried until one succeeds. If no server responds, the &%spam%&
29060 condition defers.
29061
29062 &*Warning*&: It is not possible to use the UNIX socket connection method with
29063 multiple &%spamd%& servers.
29064
29065 The &%spamd_address%& variable is expanded before use if it starts with
29066 a dollar sign. In this case, the expansion may return a string that is
29067 used as the list so that multiple spamd servers can be the result of an
29068 expansion.
29069
29070 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29071 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29072 .code
29073 deny message = This message was classified as SPAM
29074      spam = joe
29075 .endd
29076 The right-hand side of the &%spam%& condition specifies a name. This is
29077 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29078 to scan using a specific profile, but rather use the SpamAssassin system-wide
29079 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29080 However, you must put something on the right-hand side.
29081
29082 The name allows you to use per-domain or per-user antispam profiles in
29083 principle, but this is not straightforward in practice, because a message may
29084 have multiple recipients, not necessarily all in the same domain. Because the
29085 &%spam%& condition has to be called from a DATA ACL in order to be able to
29086 read the contents of the message, the variables &$local_part$& and &$domain$&
29087 are not set.
29088
29089 The right-hand side of the &%spam%& condition is expanded before being used, so
29090 you can put lookups or conditions there. When the right-hand side evaluates to
29091 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
29092
29093
29094 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
29095 large ones may cause significant performance degradation. As most spam messages
29096 are quite small, it is recommended that you do not scan the big ones. For
29097 example:
29098 .code
29099 deny message = This message was classified as SPAM
29100      condition = ${if < {$message_size}{10K}}
29101      spam = nobody
29102 .endd
29103
29104 The &%spam%& condition returns true if the threshold specified in the user's
29105 SpamAssassin profile has been matched or exceeded. If you want to use the
29106 &%spam%& condition for its side effects (see the variables below), you can make
29107 it always return &"true"& by appending &`:true`& to the username.
29108
29109 .cindex "spam scanning" "returned variables"
29110 When the &%spam%& condition is run, it sets up a number of expansion
29111 variables. These variables are saved with the received message, thus they are
29112 available for use at delivery time.
29113
29114 .vlist
29115 .vitem &$spam_score$&
29116 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
29117 for inclusion in log or reject messages.
29118
29119 .vitem &$spam_score_int$&
29120 The spam score of the message, multiplied by ten, as an integer value. For
29121 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
29122 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
29123 The integer value is useful for numeric comparisons in conditions.
29124
29125 .vitem &$spam_bar$&
29126 A string consisting of a number of &"+"& or &"-"& characters, representing the
29127 integer part of the spam score value. A spam score of 4.4 would have a
29128 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
29129 headers, since MUAs can match on such strings.
29130
29131 .vitem &$spam_report$&
29132 A multiline text table, containing the full SpamAssassin report for the
29133 message. Useful for inclusion in headers or reject messages.
29134 .endlist
29135
29136 The &%spam%& condition caches its results unless expansion in
29137 spamd_address was used. If you call it again with the same user name, it
29138 does not scan again, but rather returns the same values as before.
29139
29140 The &%spam%& condition returns DEFER if there is any error while running
29141 the message through SpamAssassin or if the expansion of spamd_address
29142 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
29143 statement block), append &`/defer_ok`& to the right-hand side of the
29144 spam condition, like this:
29145 .code
29146 deny message = This message was classified as SPAM
29147      spam    = joe/defer_ok
29148 .endd
29149 This causes messages to be accepted even if there is a problem with &%spamd%&.
29150
29151 Here is a longer, commented example of the use of the &%spam%&
29152 condition:
29153 .code
29154 # put headers in all messages (no matter if spam or not)
29155 warn  spam = nobody:true
29156       add_header = X-Spam-Score: $spam_score ($spam_bar)
29157       add_header = X-Spam-Report: $spam_report
29158
29159 # add second subject line with *SPAM* marker when message
29160 # is over threshold
29161 warn  spam = nobody
29162       add_header = Subject: *SPAM* $h_Subject:
29163
29164 # reject spam at high scores (> 12)
29165 deny  message = This message scored $spam_score spam points.
29166       spam = nobody:true
29167       condition = ${if >{$spam_score_int}{120}{1}{0}}
29168 .endd
29169
29170
29171
29172 .section "Scanning MIME parts" "SECTscanmimepart"
29173 .cindex "content scanning" "MIME parts"
29174 .cindex "MIME content scanning"
29175 .oindex "&%acl_smtp_mime%&"
29176 .oindex "&%acl_not_smtp_mime%&"
29177 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
29178 each MIME part of an SMTP message, including multipart types, in the sequence
29179 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
29180 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
29181 options may both refer to the same ACL if you want the same processing in both
29182 cases.
29183
29184 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
29185 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
29186 the case of a non-SMTP message. However, a MIME ACL is called only if the
29187 message contains a &'Content-Type:'& header line. When a call to a MIME
29188 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
29189 result code is sent to the client. In the case of an SMTP message, the
29190 &%acl_smtp_data%& ACL is not called when this happens.
29191
29192 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
29193 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
29194 condition to match against the raw MIME part. You can also use the
29195 &%mime_regex%& condition to match against the decoded MIME part (see section
29196 &<<SECTscanregex>>&).
29197
29198 At the start of a MIME ACL, a number of variables are set from the header
29199 information for the relevant MIME part. These are described below. The contents
29200 of the MIME part are not by default decoded into a disk file except for MIME
29201 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
29202 part into a disk file, you can use the &%decode%& condition. The general
29203 syntax is:
29204 .display
29205 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
29206 .endd
29207 The right hand side is expanded before use. After expansion,
29208 the value can be:
29209
29210 .olist
29211 &"0"& or &"false"&, in which case no decoding is done.
29212 .next
29213 The string &"default"&. In that case, the file is put in the temporary
29214 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
29215 a sequential file name consisting of the message id and a sequence number. The
29216 full path and name is available in &$mime_decoded_filename$& after decoding.
29217 .next
29218 A full path name starting with a slash. If the full name is an existing
29219 directory, it is used as a replacement for the default directory. The filename
29220 is then sequentially assigned. If the path does not exist, it is used as
29221 the full path and file name.
29222 .next
29223 If the string does not start with a slash, it is used as the
29224 filename, and the default path is then used.
29225 .endlist
29226 The &%decode%& condition normally succeeds. It is only false for syntax
29227 errors or unusual circumstances such as memory shortages. You can easily decode
29228 a file with its original, proposed filename using
29229 .code
29230 decode = $mime_filename
29231 .endd
29232 However, you should keep in mind that &$mime_filename$& might contain
29233 anything. If you place files outside of the default path, they are not
29234 automatically unlinked.
29235
29236 For RFC822 attachments (these are messages attached to messages, with a
29237 content-type of &"message/rfc822"&), the ACL is called again in the same manner
29238 as for the primary message, only that the &$mime_is_rfc822$& expansion
29239 variable is set (see below). Attached messages are always decoded to disk
29240 before being checked, and the files are unlinked once the check is done.
29241
29242 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
29243 used to match regular expressions against raw and decoded MIME parts,
29244 respectively. They are described in section &<<SECTscanregex>>&.
29245
29246 .cindex "MIME content scanning" "returned variables"
29247 The following list describes all expansion variables that are
29248 available in the MIME ACL:
29249
29250 .vlist
29251 .vitem &$mime_boundary$&
29252 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
29253 have a boundary string, which is stored in this variable. If the current part
29254 has no boundary parameter in the &'Content-Type:'& header, this variable
29255 contains the empty string.
29256
29257 .vitem &$mime_charset$&
29258 This variable contains the character set identifier, if one was found in the
29259 &'Content-Type:'& header. Examples for charset identifiers are:
29260 .code
29261 us-ascii
29262 gb2312 (Chinese)
29263 iso-8859-1
29264 .endd
29265 Please note that this value is not normalized, so you should do matches
29266 case-insensitively.
29267
29268 .vitem &$mime_content_description$&
29269 This variable contains the normalized content of the &'Content-Description:'&
29270 header. It can contain a human-readable description of the parts content. Some
29271 implementations repeat the filename for attachments here, but they are usually
29272 only used for display purposes.
29273
29274 .vitem &$mime_content_disposition$&
29275 This variable contains the normalized content of the &'Content-Disposition:'&
29276 header. You can expect strings like &"attachment"& or &"inline"& here.
29277
29278 .vitem &$mime_content_id$&
29279 This variable contains the normalized content of the &'Content-ID:'& header.
29280 This is a unique ID that can be used to reference a part from another part.
29281
29282 .vitem &$mime_content_size$&
29283 This variable is set only after the &%decode%& modifier (see above) has been
29284 successfully run. It contains the size of the decoded part in kilobytes. The
29285 size is always rounded up to full kilobytes, so only a completely empty part
29286 has a &$mime_content_size$& of zero.
29287
29288 .vitem &$mime_content_transfer_encoding$&
29289 This variable contains the normalized content of the
29290 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
29291 type. Typical values are &"base64"& and &"quoted-printable"&.
29292
29293 .vitem &$mime_content_type$&
29294 If the MIME part has a &'Content-Type:'& header, this variable contains its
29295 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
29296 are some examples of popular MIME types, as they may appear in this variable:
29297 .code
29298 text/plain
29299 text/html
29300 application/octet-stream
29301 image/jpeg
29302 audio/midi
29303 .endd
29304 If the MIME part has no &'Content-Type:'& header, this variable contains the
29305 empty string.
29306
29307 .vitem &$mime_decoded_filename$&
29308 This variable is set only after the &%decode%& modifier (see above) has been
29309 successfully run. It contains the full path and file name of the file
29310 containing the decoded data.
29311 .endlist
29312
29313 .cindex "RFC 2047"
29314 .vlist
29315 .vitem &$mime_filename$&
29316 This is perhaps the most important of the MIME variables. It contains a
29317 proposed filename for an attachment, if one was found in either the
29318 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
29319 RFC2047 decoded, but no additional sanity checks are done. If no filename was
29320 found, this variable contains the empty string.
29321
29322 .vitem &$mime_is_coverletter$&
29323 This variable attempts to differentiate the &"cover letter"& of an e-mail from
29324 attached data. It can be used to clamp down on flashy or unnecessarily encoded
29325 content in the cover letter, while not restricting attachments at all.
29326
29327 The variable contains 1 (true) for a MIME part believed to be part of the
29328 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
29329 follows:
29330
29331 .olist
29332 The outermost MIME part of a message is always a cover letter.
29333
29334 .next
29335 If a multipart/alternative or multipart/related MIME part is a cover letter,
29336 so are all MIME subparts within that multipart.
29337
29338 .next
29339 If any other multipart is a cover letter, the first subpart is a cover letter,
29340 and the rest are attachments.
29341
29342 .next
29343 All parts contained within an attachment multipart are attachments.
29344 .endlist olist
29345
29346 As an example, the following will ban &"HTML mail"& (including that sent with
29347 alternative plain text), while allowing HTML files to be attached. HTML
29348 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
29349 .code
29350 deny message = HTML mail is not accepted here
29351 !condition = $mime_is_rfc822
29352 condition = $mime_is_coverletter
29353 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
29354 .endd
29355 .vitem &$mime_is_multipart$&
29356 This variable has the value 1 (true) when the current part has the main type
29357 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
29358 Since multipart entities only serve as containers for other parts, you may not
29359 want to carry out specific actions on them.
29360
29361 .vitem &$mime_is_rfc822$&
29362 This variable has the value 1 (true) if the current part is not a part of the
29363 checked message itself, but part of an attached message. Attached message
29364 decoding is fully recursive.
29365
29366 .vitem &$mime_part_count$&
29367 This variable is a counter that is raised for each processed MIME part. It
29368 starts at zero for the very first part (which is usually a multipart). The
29369 counter is per-message, so it is reset when processing RFC822 attachments (see
29370 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
29371 complete, so you can use it in the DATA ACL to determine the number of MIME
29372 parts of a message. For non-MIME messages, this variable contains the value -1.
29373 .endlist
29374
29375
29376
29377 .section "Scanning with regular expressions" "SECTscanregex"
29378 .cindex "content scanning" "with regular expressions"
29379 .cindex "regular expressions" "content scanning with"
29380 You can specify your own custom regular expression matches on the full body of
29381 the message, or on individual MIME parts.
29382
29383 The &%regex%& condition takes one or more regular expressions as arguments and
29384 matches them against the full message (when called in the DATA ACL) or a raw
29385 MIME part (when called in the MIME ACL). The &%regex%& condition matches
29386 linewise, with a maximum line length of 32K characters. That means you cannot
29387 have multiline matches with the &%regex%& condition.
29388
29389 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
29390 to 32K of decoded content (the whole content at once, not linewise). If the
29391 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
29392 is decoded automatically when &%mime_regex%& is executed (using default path
29393 and filename values). If the decoded data is larger than  32K, only the first
29394 32K characters are checked.
29395
29396 The regular expressions are passed as a colon-separated list. To include a
29397 literal colon, you must double it. Since the whole right-hand side string is
29398 expanded before being used, you must also escape dollar signs and backslashes
29399 with more backslashes, or use the &`\N`& facility to disable expansion.
29400 Here is a simple example that contains two regular expressions:
29401 .code
29402 deny message = contains blacklisted regex ($regex_match_string)
29403      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
29404 .endd
29405 The conditions returns true if any one of the regular expressions matches. The
29406 &$regex_match_string$& expansion variable is then set up and contains the
29407 matching regular expression.
29408
29409 &*Warning*&: With large messages, these conditions can be fairly
29410 CPU-intensive.
29411
29412
29413
29414
29415 .section "The demime condition" "SECTdemimecond"
29416 .cindex "content scanning" "MIME checking"
29417 .cindex "MIME content scanning"
29418 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
29419 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
29420 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
29421 ACL functionality, but provides no additional facilities. Please note that this
29422 condition is deprecated and kept only for backward compatibility. You must set
29423 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
29424 use the &%demime%& condition.
29425
29426 The &%demime%& condition unpacks MIME containers in the message. It detects
29427 errors in MIME containers and can match file extensions found in the message
29428 against a list. Using this facility produces files containing the unpacked MIME
29429 parts of the message in the temporary scan directory. If you do antivirus
29430 scanning, it is recommended that you use the &%demime%& condition before the
29431 antivirus (&%malware%&) condition.
29432
29433 On the right-hand side of the &%demime%& condition you can pass a
29434 colon-separated list of file extensions that it should match against. For
29435 example:
29436 .code
29437 deny message = Found blacklisted file attachment
29438      demime  = vbs:com:bat:pif:prf:lnk
29439 .endd
29440 If one of the file extensions is found, the condition is true, otherwise it is
29441 false. If there is a temporary error while demimeing (for example, &"disk
29442 full"&), the condition defers, and the message is temporarily rejected (unless
29443 the condition is on a &%warn%& verb).
29444
29445 The right-hand side is expanded before being treated as a list, so you can have
29446 conditions and lookups there. If it expands to an empty string, &"false"&, or
29447 zero (&"0"&), no demimeing is done and the condition is false.
29448
29449 The &%demime%& condition set the following variables:
29450
29451 .vlist
29452 .vitem &$demime_errorlevel$&
29453 .vindex "&$demime_errorlevel$&"
29454 When an error is detected in a MIME container, this variable contains the
29455 severity of the error, as an integer number. The higher the value, the more
29456 severe the error (the current maximum value is 3). If this variable is unset or
29457 zero, no error occurred.
29458
29459 .vitem &$demime_reason$&
29460 .vindex "&$demime_reason$&"
29461 When &$demime_errorlevel$& is greater than zero, this variable contains a
29462 human-readable text string describing the MIME error that occurred.
29463 .endlist
29464
29465 .vlist
29466 .vitem &$found_extension$&
29467 .vindex "&$found_extension$&"
29468 When the &%demime%& condition is true, this variable contains the file
29469 extension it found.
29470 .endlist
29471
29472 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
29473 the &%demime%& condition, and are not changed on subsequent calls.
29474
29475 If you do not want to check for file extensions, but rather use the &%demime%&
29476 condition for unpacking or error checking purposes, pass &"*"& as the
29477 right-hand side value. Here is a more elaborate example of how to use this
29478 facility:
29479 .code
29480 # Reject messages with serious MIME container errors
29481 deny  message = Found MIME error ($demime_reason).
29482       demime = *
29483       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
29484
29485 # Reject known virus spreading file extensions.
29486 # Accepting these is pretty much braindead.
29487 deny  message = contains $found_extension file (blacklisted).
29488       demime  = com:vbs:bat:pif:scr
29489
29490 # Freeze .exe and .doc files. Postmaster can
29491 # examine them and eventually thaw them.
29492 deny  log_message = Another $found_extension file.
29493       demime = exe:doc
29494       control = freeze
29495 .endd
29496 .ecindex IIDcosca
29497
29498
29499
29500
29501 . ////////////////////////////////////////////////////////////////////////////
29502 . ////////////////////////////////////////////////////////////////////////////
29503
29504 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
29505          "Local scan function"
29506 .scindex IIDlosca "&[local_scan()]& function" "description of"
29507 .cindex "customizing" "input scan using C function"
29508 .cindex "policy control" "by local scan function"
29509 In these days of email worms, viruses, and ever-increasing spam, some sites
29510 want to apply a lot of checking to messages before accepting them.
29511
29512 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
29513 passing messages to external virus and spam scanning software. You can also do
29514 a certain amount in Exim itself through string expansions and the &%condition%&
29515 condition in the ACL that runs after the SMTP DATA command or the ACL for
29516 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
29517
29518 To allow for further customization to a site's own requirements, there is the
29519 possibility of linking Exim with a private message scanning function, written
29520 in C. If you want to run code that is written in something other than C, you
29521 can of course use a little C stub to call it.
29522
29523 The local scan function is run once for every incoming message, at the point
29524 when Exim is just about to accept the message.
29525 It can therefore be used to control non-SMTP messages from local processes as
29526 well as messages arriving via SMTP.
29527
29528 Exim applies a timeout to calls of the local scan function, and there is an
29529 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
29530 Zero means &"no timeout"&.
29531 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
29532 before calling the local scan function, so that the most common types of crash
29533 are caught. If the timeout is exceeded or one of those signals is caught, the
29534 incoming message is rejected with a temporary error if it is an SMTP message.
29535 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
29536 code. The incident is logged on the main and reject logs.
29537
29538
29539
29540 .section "Building Exim to use a local scan function" "SECID207"
29541 .cindex "&[local_scan()]& function" "building Exim to use"
29542 To make use of the local scan function feature, you must tell Exim where your
29543 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
29544 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
29545 directory, so you might set
29546 .code
29547 LOCAL_SCAN_SOURCE=Local/local_scan.c
29548 .endd
29549 for example. The function must be called &[local_scan()]&. It is called by
29550 Exim after it has received a message, when the success return code is about to
29551 be sent. This is after all the ACLs have been run. The return code from your
29552 function controls whether the message is actually accepted or not. There is a
29553 commented template function (that just accepts the message) in the file
29554 _src/local_scan.c_.
29555
29556 If you want to make use of Exim's run time configuration file to set options
29557 for your &[local_scan()]& function, you must also set
29558 .code
29559 LOCAL_SCAN_HAS_OPTIONS=yes
29560 .endd
29561 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
29562
29563
29564
29565
29566 .section "API for local_scan()" "SECTapiforloc"
29567 .cindex "&[local_scan()]& function" "API description"
29568 You must include this line near the start of your code:
29569 .code
29570 #include "local_scan.h"
29571 .endd
29572 This header file defines a number of variables and other values, and the
29573 prototype for the function itself. Exim is coded to use unsigned char values
29574 almost exclusively, and one of the things this header defines is a shorthand
29575 for &`unsigned char`& called &`uschar`&.
29576 It also contains the following macro definitions, to simplify casting character
29577 strings and pointers to character strings:
29578 .code
29579 #define CS   (char *)
29580 #define CCS  (const char *)
29581 #define CSS  (char **)
29582 #define US   (unsigned char *)
29583 #define CUS  (const unsigned char *)
29584 #define USS  (unsigned char **)
29585 .endd
29586 The function prototype for &[local_scan()]& is:
29587 .code
29588 extern int local_scan(int fd, uschar **return_text);
29589 .endd
29590 The arguments are as follows:
29591
29592 .ilist
29593 &%fd%& is a file descriptor for the file that contains the body of the message
29594 (the -D file). The file is open for reading and writing, but updating it is not
29595 recommended. &*Warning*&: You must &'not'& close this file descriptor.
29596
29597 The descriptor is positioned at character 19 of the file, which is the first
29598 character of the body itself, because the first 19 characters are the message
29599 id followed by &`-D`& and a newline. If you rewind the file, you should use the
29600 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
29601 case this changes in some future version.
29602 .next
29603 &%return_text%& is an address which you can use to return a pointer to a text
29604 string at the end of the function. The value it points to on entry is NULL.
29605 .endlist
29606
29607 The function must return an &%int%& value which is one of the following macros:
29608
29609 .vlist
29610 .vitem &`LOCAL_SCAN_ACCEPT`&
29611 .vindex "&$local_scan_data$&"
29612 The message is accepted. If you pass back a string of text, it is saved with
29613 the message, and made available in the variable &$local_scan_data$&. No
29614 newlines are permitted (if there are any, they are turned into spaces) and the
29615 maximum length of text is 1000 characters.
29616
29617 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
29618 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29619 queued without immediate delivery, and is frozen.
29620
29621 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
29622 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29623 queued without immediate delivery.
29624
29625 .vitem &`LOCAL_SCAN_REJECT`&
29626 The message is rejected; the returned text is used as an error message which is
29627 passed back to the sender and which is also logged. Newlines are permitted &--
29628 they cause a multiline response for SMTP rejections, but are converted to
29629 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
29630 used.
29631
29632 .vitem &`LOCAL_SCAN_TEMPREJECT`&
29633 The message is temporarily rejected; the returned text is used as an error
29634 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
29635 problem"& is used.
29636
29637 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
29638 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
29639 message is not written to the reject log. It has the effect of unsetting the
29640 &%rejected_header%& log selector for just this rejection. If
29641 &%rejected_header%& is already unset (see the discussion of the
29642 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
29643 same as LOCAL_SCAN_REJECT.
29644
29645 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
29646 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
29647 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
29648 .endlist
29649
29650 If the message is not being received by interactive SMTP, rejections are
29651 reported by writing to &%stderr%& or by sending an email, as configured by the
29652 &%-oe%& command line options.
29653
29654
29655
29656 .section "Configuration options for local_scan()" "SECTconoptloc"
29657 .cindex "&[local_scan()]& function" "configuration options"
29658 It is possible to have option settings in the main configuration file
29659 that set values in static variables in the &[local_scan()]& module. If you
29660 want to do this, you must have the line
29661 .code
29662 LOCAL_SCAN_HAS_OPTIONS=yes
29663 .endd
29664 in your &_Local/Makefile_& when you build Exim. (This line is in
29665 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
29666 file, you must define static variables to hold the option values, and a table
29667 to define them.
29668
29669 The table must be a vector called &%local_scan_options%&, of type
29670 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
29671 and a pointer to the variable that holds the value. The entries must appear in
29672 alphabetical order. Following &%local_scan_options%& you must also define a
29673 variable called &%local_scan_options_count%& that contains the number of
29674 entries in the table. Here is a short example, showing two kinds of option:
29675 .code
29676 static int my_integer_option = 42;
29677 static uschar *my_string_option = US"a default string";
29678
29679 optionlist local_scan_options[] = {
29680   { "my_integer", opt_int,       &my_integer_option },
29681   { "my_string",  opt_stringptr, &my_string_option }
29682 };
29683
29684 int local_scan_options_count =
29685   sizeof(local_scan_options)/sizeof(optionlist);
29686 .endd
29687 The values of the variables can now be changed from Exim's runtime
29688 configuration file by including a local scan section as in this example:
29689 .code
29690 begin local_scan
29691 my_integer = 99
29692 my_string = some string of text...
29693 .endd
29694 The available types of option data are as follows:
29695
29696 .vlist
29697 .vitem &*opt_bool*&
29698 This specifies a boolean (true/false) option. The address should point to a
29699 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
29700 that are defined as &"1"& and &"0"&, respectively. If you want to detect
29701 whether such a variable has been set at all, you can initialize it to
29702 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
29703 values.)
29704
29705 .vitem &*opt_fixed*&
29706 This specifies a fixed point number, such as is used for load averages.
29707 The address should point to a variable of type &`int`&. The value is stored
29708 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
29709
29710 .vitem &*opt_int*&
29711 This specifies an integer; the address should point to a variable of type
29712 &`int`&. The value may be specified in any of the integer formats accepted by
29713 Exim.
29714
29715 .vitem &*opt_mkint*&
29716 This is the same as &%opt_int%&, except that when such a value is output in a
29717 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
29718 printed with the suffix K or M.
29719
29720 .vitem &*opt_octint*&
29721 This also specifies an integer, but the value is always interpreted as an
29722 octal integer, whether or not it starts with the digit zero, and it is
29723 always output in octal.
29724
29725 .vitem &*opt_stringptr*&
29726 This specifies a string value; the address must be a pointer to a
29727 variable that points to a string (for example, of type &`uschar *`&).
29728
29729 .vitem &*opt_time*&
29730 This specifies a time interval value. The address must point to a variable of
29731 type &`int`&. The value that is placed there is a number of seconds.
29732 .endlist
29733
29734 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
29735 out the values of all the &[local_scan()]& options.
29736
29737
29738
29739 .section "Available Exim variables" "SECID208"
29740 .cindex "&[local_scan()]& function" "available Exim variables"
29741 The header &_local_scan.h_& gives you access to a number of C variables. These
29742 are the only ones that are guaranteed to be maintained from release to release.
29743 Note, however, that you can obtain the value of any Exim expansion variable,
29744 including &$recipients$&, by calling &'expand_string()'&. The exported
29745 C variables are as follows:
29746
29747 .vlist
29748 .vitem &*int&~body_linecount*&
29749 This variable contains the number of lines in the message's body.
29750
29751 .vitem &*int&~body_zerocount*&
29752 This variable contains the number of binary zero bytes in the message's body.
29753
29754 .vitem &*unsigned&~int&~debug_selector*&
29755 This variable is set to zero when no debugging is taking place. Otherwise, it
29756 is a bitmap of debugging selectors. Two bits are identified for use in
29757 &[local_scan()]&; they are defined as macros:
29758
29759 .ilist
29760 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
29761 testing option that is not privileged &-- any caller may set it. All the
29762 other selector bits can be set only by admin users.
29763
29764 .next
29765 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
29766 by the &`+local_scan`& debug selector. It is not included in the default set
29767 of debugging bits.
29768 .endlist ilist
29769
29770 Thus, to write to the debugging output only when &`+local_scan`& has been
29771 selected, you should use code like this:
29772 .code
29773 if ((debug_selector & D_local_scan) != 0)
29774   debug_printf("xxx", ...);
29775 .endd
29776 .vitem &*uschar&~*expand_string_message*&
29777 After a failing call to &'expand_string()'& (returned value NULL), the
29778 variable &%expand_string_message%& contains the error message, zero-terminated.
29779
29780 .vitem &*header_line&~*header_list*&
29781 A pointer to a chain of header lines. The &%header_line%& structure is
29782 discussed below.
29783
29784 .vitem &*header_line&~*header_last*&
29785 A pointer to the last of the header lines.
29786
29787 .vitem &*uschar&~*headers_charset*&
29788 The value of the &%headers_charset%& configuration option.
29789
29790 .vitem &*BOOL&~host_checking*&
29791 This variable is TRUE during a host checking session that is initiated by the
29792 &%-bh%& command line option.
29793
29794 .vitem &*uschar&~*interface_address*&
29795 The IP address of the interface that received the message, as a string. This
29796 is NULL for locally submitted messages.
29797
29798 .vitem &*int&~interface_port*&
29799 The port on which this message was received. When testing with the &%-bh%&
29800 command line option, the value of this variable is -1 unless a port has been
29801 specified via the &%-oMi%& option.
29802
29803 .vitem &*uschar&~*message_id*&
29804 This variable contains Exim's message id for the incoming message (the value of
29805 &$message_exim_id$&) as a zero-terminated string.
29806
29807 .vitem &*uschar&~*received_protocol*&
29808 The name of the protocol by which the message was received.
29809
29810 .vitem &*int&~recipients_count*&
29811 The number of accepted recipients.
29812
29813 .vitem &*recipient_item&~*recipients_list*&
29814 .cindex "recipient" "adding in local scan"
29815 .cindex "recipient" "removing in local scan"
29816 The list of accepted recipients, held in a vector of length
29817 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
29818 can add additional recipients by calling &'receive_add_recipient()'& (see
29819 below). You can delete recipients by removing them from the vector and
29820 adjusting the value in &%recipients_count%&. In particular, by setting
29821 &%recipients_count%& to zero you remove all recipients. If you then return the
29822 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
29823 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
29824 and then call &'receive_add_recipient()'& as often as needed.
29825
29826 .vitem &*uschar&~*sender_address*&
29827 The envelope sender address. For bounce messages this is the empty string.
29828
29829 .vitem &*uschar&~*sender_host_address*&
29830 The IP address of the sending host, as a string. This is NULL for
29831 locally-submitted messages.
29832
29833 .vitem &*uschar&~*sender_host_authenticated*&
29834 The name of the authentication mechanism that was used, or NULL if the message
29835 was not received over an authenticated SMTP connection.
29836
29837 .vitem &*uschar&~*sender_host_name*&
29838 The name of the sending host, if known.
29839
29840 .vitem &*int&~sender_host_port*&
29841 The port on the sending host.
29842
29843 .vitem &*BOOL&~smtp_input*&
29844 This variable is TRUE for all SMTP input, including BSMTP.
29845
29846 .vitem &*BOOL&~smtp_batched_input*&
29847 This variable is TRUE for BSMTP input.
29848
29849 .vitem &*int&~store_pool*&
29850 The contents of this variable control which pool of memory is used for new
29851 requests. See section &<<SECTmemhanloc>>& for details.
29852 .endlist
29853
29854
29855 .section "Structure of header lines" "SECID209"
29856 The &%header_line%& structure contains the members listed below.
29857 You can add additional header lines by calling the &'header_add()'& function
29858 (see below). You can cause header lines to be ignored (deleted) by setting
29859 their type to *.
29860
29861
29862 .vlist
29863 .vitem &*struct&~header_line&~*next*&
29864 A pointer to the next header line, or NULL for the last line.
29865
29866 .vitem &*int&~type*&
29867 A code identifying certain headers that Exim recognizes. The codes are printing
29868 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
29869 Notice in particular that any header line whose type is * is not transmitted
29870 with the message. This flagging is used for header lines that have been
29871 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
29872 lines.) Effectively, * means &"deleted"&.
29873
29874 .vitem &*int&~slen*&
29875 The number of characters in the header line, including the terminating and any
29876 internal newlines.
29877
29878 .vitem &*uschar&~*text*&
29879 A pointer to the text of the header. It always ends with a newline, followed by
29880 a zero byte. Internal newlines are preserved.
29881 .endlist
29882
29883
29884
29885 .section "Structure of recipient items" "SECID210"
29886 The &%recipient_item%& structure contains these members:
29887
29888 .vlist
29889 .vitem &*uschar&~*address*&
29890 This is a pointer to the recipient address as it was received.
29891
29892 .vitem &*int&~pno*&
29893 This is used in later Exim processing when top level addresses are created by
29894 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
29895 and must always contain -1 at this stage.
29896
29897 .vitem &*uschar&~*errors_to*&
29898 If this value is not NULL, bounce messages caused by failing to deliver to the
29899 recipient are sent to the address it contains. In other words, it overrides the
29900 envelope sender for this one recipient. (Compare the &%errors_to%& generic
29901 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
29902 an unqualified address, Exim qualifies it using the domain from
29903 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
29904 is NULL for all recipients.
29905 .endlist
29906
29907
29908
29909 .section "Available Exim functions" "SECID211"
29910 .cindex "&[local_scan()]& function" "available Exim functions"
29911 The header &_local_scan.h_& gives you access to a number of Exim functions.
29912 These are the only ones that are guaranteed to be maintained from release to
29913 release:
29914
29915 .vlist
29916 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
29917        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
29918
29919 This function creates a child process that runs the command specified by
29920 &%argv%&. The environment for the process is specified by &%envp%&, which can
29921 be NULL if no environment variables are to be passed. A new umask is supplied
29922 for the process in &%newumask%&.
29923
29924 Pipes to the standard input and output of the new process are set up
29925 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
29926 standard error is cloned to the standard output. If there are any file
29927 descriptors &"in the way"& in the new process, they are closed. If the final
29928 argument is TRUE, the new process is made into a process group leader.
29929
29930 The function returns the pid of the new process, or -1 if things go wrong.
29931
29932 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
29933 This function waits for a child process to terminate, or for a timeout (in
29934 seconds) to expire. A timeout value of zero means wait as long as it takes. The
29935 return value is as follows:
29936
29937 .ilist
29938 >= 0
29939
29940 The process terminated by a normal exit and the value is the process
29941 ending status.
29942
29943 .next
29944 < 0 and > &--256
29945
29946 The process was terminated by a signal and the value is the negation of the
29947 signal number.
29948
29949 .next
29950 &--256
29951
29952 The process timed out.
29953 .next
29954 &--257
29955
29956 The was some other error in wait(); &%errno%& is still set.
29957 .endlist
29958
29959 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
29960 This function provide you with a means of submitting a new message to
29961 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
29962 want, but this packages it all up for you.) The function creates a pipe,
29963 forks a subprocess that is running
29964 .code
29965 exim -t -oem -oi -f <>
29966 .endd
29967 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
29968 that is connected to the standard input. The yield of the function is the PID
29969 of the subprocess. You can then write a message to the file descriptor, with
29970 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
29971
29972 When you have finished, call &'child_close()'& to wait for the process to
29973 finish and to collect its ending status. A timeout value of zero is usually
29974 fine in this circumstance. Unless you have made a mistake with the recipient
29975 addresses, you should get a return code of zero.
29976
29977
29978 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
29979        *sender_authentication)*&
29980 This function is a more sophisticated version of &'child_open()'&. The command
29981 that it runs is:
29982 .display
29983 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
29984 .endd
29985 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
29986
29987
29988 .vitem &*void&~debug_printf(char&~*,&~...)*&
29989 This is Exim's debugging function, with arguments as for &'(printf()'&. The
29990 output is written to the standard error stream. If no debugging is selected,
29991 calls to &'debug_printf()'& have no effect. Normally, you should make calls
29992 conditional on the &`local_scan`& debug selector by coding like this:
29993 .code
29994 if ((debug_selector & D_local_scan) != 0)
29995   debug_printf("xxx", ...);
29996 .endd
29997
29998 .vitem &*uschar&~*expand_string(uschar&~*string)*&
29999 This is an interface to Exim's string expansion code. The return value is the
30000 expanded string, or NULL if there was an expansion failure.
30001 The C variable &%expand_string_message%& contains an error message after an
30002 expansion failure. If expansion does not change the string, the return value is
30003 the pointer to the input string. Otherwise, the return value points to a new
30004 block of memory that was obtained by a call to &'store_get()'&. See section
30005 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30006
30007 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30008 This function allows you to an add additional header line at the end of the
30009 existing ones. The first argument is the type, and should normally be a space
30010 character. The second argument is a format string and any number of
30011 substitution arguments as for &[sprintf()]&. You may include internal newlines
30012 if you want, and you must ensure that the string ends with a newline.
30013
30014 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30015         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30016 This function adds a new header line at a specified point in the header
30017 chain. The header itself is specified as for &'header_add()'&.
30018
30019 If &%name%& is NULL, the new header is added at the end of the chain if
30020 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30021 NULL, the header lines are searched for the first non-deleted header that
30022 matches the name. If one is found, the new header is added before it if
30023 &%after%& is false. If &%after%& is true, the new header is added after the
30024 found header and any adjacent subsequent ones with the same name (even if
30025 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30026 option controls where the header is added. If it is true, addition is at the
30027 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30028 headers, or at the top if there are no &'Received:'& headers, you could use
30029 .code
30030 header_add_at_position(TRUE, US"Received", TRUE,
30031   ' ', "X-xxx: ...");
30032 .endd
30033 Normally, there is always at least one non-deleted &'Received:'& header, but
30034 there may not be if &%received_header_text%& expands to an empty string.
30035
30036
30037 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30038 This function removes header lines. If &%occurrence%& is zero or negative, all
30039 occurrences of the header are removed. If occurrence is greater than zero, that
30040 particular instance of the header is removed. If no header(s) can be found that
30041 match the specification, the function does nothing.
30042
30043
30044 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30045         int&~length,&~BOOL&~notdel)*&"
30046 This function tests whether the given header has the given name. It is not just
30047 a string comparison, because white space is permitted between the name and the
30048 colon. If the &%notdel%& argument is true, a false return is forced for all
30049 &"deleted"& headers; otherwise they are not treated specially. For example:
30050 .code
30051 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30052 .endd
30053 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30054 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30055 This function base64-encodes a string, which is passed by address and length.
30056 The text may contain bytes of any value, including zero. The result is passed
30057 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30058 zero-terminated.
30059
30060 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30061 This function decodes a base64-encoded string. Its arguments are a
30062 zero-terminated base64-encoded string and the address of a variable that is set
30063 to point to the result, which is in dynamic memory. The length of the decoded
30064 string is the yield of the function. If the input is invalid base64 data, the
30065 yield is -1. A zero byte is added to the end of the output string to make it
30066 easy to interpret as a C string (assuming it contains no zeros of its own). The
30067 added zero byte is not included in the returned count.
30068
30069 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30070 This function checks for a match in a domain list. Domains are always
30071 matched caselessly. The return value is one of the following:
30072 .display
30073 &`OK     `& match succeeded
30074 &`FAIL   `& match failed
30075 &`DEFER  `& match deferred
30076 .endd
30077 DEFER is usually caused by some kind of lookup defer, such as the
30078 inability to contact a database.
30079
30080 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30081         BOOL&~caseless)*&"
30082 This function checks for a match in a local part list. The third argument
30083 controls case-sensitivity. The return values are as for
30084 &'lss_match_domain()'&.
30085
30086 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
30087         BOOL&~caseless)*&"
30088 This function checks for a match in an address list. The third argument
30089 controls the case-sensitivity of the local part match. The domain is always
30090 matched caselessly. The return values are as for &'lss_match_domain()'&.
30091
30092 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
30093         uschar&~*list)*&"
30094 This function checks for a match in a host list. The most common usage is
30095 expected to be
30096 .code
30097 lss_match_host(sender_host_name, sender_host_address, ...)
30098 .endd
30099 .vindex "&$sender_host_address$&"
30100 An empty address field matches an empty item in the host list. If the host name
30101 is NULL, the name corresponding to &$sender_host_address$& is automatically
30102 looked up if a host name is required to match an item in the list. The return
30103 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
30104 returns ERROR in the case when it had to look up a host name, but the lookup
30105 failed.
30106
30107 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
30108         *format,&~...)*&"
30109 This function writes to Exim's log files. The first argument should be zero (it
30110 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
30111 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
30112 them. It specifies to which log or logs the message is written. The remaining
30113 arguments are a format and relevant insertion arguments. The string should not
30114 contain any newlines, not even at the end.
30115
30116
30117 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
30118 This function adds an additional recipient to the message. The first argument
30119 is the recipient address. If it is unqualified (has no domain), it is qualified
30120 with the &%qualify_recipient%& domain. The second argument must always be -1.
30121
30122 This function does not allow you to specify a private &%errors_to%& address (as
30123 described with the structure of &%recipient_item%& above), because it pre-dates
30124 the addition of that field to the structure. However, it is easy to add such a
30125 value afterwards. For example:
30126 .code
30127  receive_add_recipient(US"monitor@mydom.example", -1);
30128  recipients_list[recipients_count-1].errors_to =
30129    US"postmaster@mydom.example";
30130 .endd
30131
30132 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
30133 This is a convenience function to remove a named recipient from the list of
30134 recipients. It returns true if a recipient was removed, and false if no
30135 matching recipient could be found. The argument must be a complete email
30136 address.
30137 .endlist
30138
30139
30140 .cindex "RFC 2047"
30141 .vlist
30142 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
30143   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
30144 This function decodes strings that are encoded according to RFC 2047. Typically
30145 these are the contents of header lines. First, each &"encoded word"& is decoded
30146 from the Q or B encoding into a byte-string. Then, if provided with the name of
30147 a charset encoding, and if the &[iconv()]& function is available, an attempt is
30148 made  to translate the result to the named character set. If this fails, the
30149 binary string is returned with an error message.
30150
30151 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
30152 maximum MIME word length is enforced. The third argument is the target
30153 encoding, or NULL if no translation is wanted.
30154
30155 .cindex "binary zero" "in RFC 2047 decoding"
30156 .cindex "RFC 2047" "binary zero in"
30157 If a binary zero is encountered in the decoded string, it is replaced by the
30158 contents of the &%zeroval%& argument. For use with Exim headers, the value must
30159 not be 0 because header lines are handled as zero-terminated strings.
30160
30161 The function returns the result of processing the string, zero-terminated; if
30162 &%lenptr%& is not NULL, the length of the result is set in the variable to
30163 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
30164
30165 If an error is encountered, the function returns NULL and uses the &%error%&
30166 argument to return an error message. The variable pointed to by &%error%& is
30167 set to NULL if there is no error; it may be set non-NULL even when the function
30168 returns a non-NULL value if decoding was successful, but there was a problem
30169 with translation.
30170
30171
30172 .vitem &*int&~smtp_fflush(void)*&
30173 This function is used in conjunction with &'smtp_printf()'&, as described
30174 below.
30175
30176 .vitem &*void&~smtp_printf(char&~*,&~...)*&
30177 The arguments of this function are like &[printf()]&; it writes to the SMTP
30178 output stream. You should use this function only when there is an SMTP output
30179 stream, that is, when the incoming message is being received via interactive
30180 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
30181 is FALSE. If you want to test for an incoming message from another host (as
30182 opposed to a local process that used the &%-bs%& command line option), you can
30183 test the value of &%sender_host_address%&, which is non-NULL when a remote host
30184 is involved.
30185
30186 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
30187 output function, so it can be used for all forms of SMTP connection.
30188
30189 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
30190 must start with an appropriate response code: 550 if you are going to return
30191 LOCAL_SCAN_REJECT, 451 if you are going to return
30192 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
30193 initial lines of a multi-line response, the code must be followed by a hyphen
30194 to indicate that the line is not the final response line. You must also ensure
30195 that the lines you write terminate with CRLF. For example:
30196 .code
30197 smtp_printf("550-this is some extra info\r\n");
30198 return LOCAL_SCAN_REJECT;
30199 .endd
30200 Note that you can also create multi-line responses by including newlines in
30201 the data returned via the &%return_text%& argument. The added value of using
30202 &'smtp_printf()'& is that, for instance, you could introduce delays between
30203 multiple output lines.
30204
30205 The &'smtp_printf()'& function does not return any error indication, because it
30206 does not automatically flush pending output, and therefore does not test
30207 the state of the stream. (In the main code of Exim, flushing and error
30208 detection is done when Exim is ready for the next SMTP input command.) If
30209 you want to flush the output and check for an error (for example, the
30210 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
30211 arguments. It flushes the output stream, and returns a non-zero value if there
30212 is an error.
30213
30214 .vitem &*void&~*store_get(int)*&
30215 This function accesses Exim's internal store (memory) manager. It gets a new
30216 chunk of memory whose size is given by the argument. Exim bombs out if it ever
30217 runs out of memory. See the next section for a discussion of memory handling.
30218
30219 .vitem &*void&~*store_get_perm(int)*&
30220 This function is like &'store_get()'&, but it always gets memory from the
30221 permanent pool. See the next section for a discussion of memory handling.
30222
30223 .vitem &*uschar&~*string_copy(uschar&~*string)*&
30224 See below.
30225
30226 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
30227 See below.
30228
30229 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
30230 These three functions create strings using Exim's dynamic memory facilities.
30231 The first makes a copy of an entire string. The second copies up to a maximum
30232 number of characters, indicated by the second argument. The third uses a format
30233 and insertion arguments to create a new string. In each case, the result is a
30234 pointer to a new string in the current memory pool. See the next section for
30235 more discussion.
30236 .endlist
30237
30238
30239
30240 .section "More about Exim's memory handling" "SECTmemhanloc"
30241 .cindex "&[local_scan()]& function" "memory handling"
30242 No function is provided for freeing memory, because that is never needed.
30243 The dynamic memory that Exim uses when receiving a message is automatically
30244 recycled if another message is received by the same process (this applies only
30245 to incoming SMTP connections &-- other input methods can supply only one
30246 message at a time). After receiving the last message, a reception process
30247 terminates.
30248
30249 Because it is recycled, the normal dynamic memory cannot be used for holding
30250 data that must be preserved over a number of incoming messages on the same SMTP
30251 connection. However, Exim in fact uses two pools of dynamic memory; the second
30252 one is not recycled, and can be used for this purpose.
30253
30254 If you want to allocate memory that remains available for subsequent messages
30255 in the same SMTP connection, you should set
30256 .code
30257 store_pool = POOL_PERM
30258 .endd
30259 before calling the function that does the allocation. There is no need to
30260 restore the value if you do not need to; however, if you do want to revert to
30261 the normal pool, you can either restore the previous value of &%store_pool%& or
30262 set it explicitly to POOL_MAIN.
30263
30264 The pool setting applies to all functions that get dynamic memory, including
30265 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
30266 There is also a convenience function called &'store_get_perm()'& that gets a
30267 block of memory from the permanent pool while preserving the value of
30268 &%store_pool%&.
30269 .ecindex IIDlosca
30270
30271
30272
30273
30274 . ////////////////////////////////////////////////////////////////////////////
30275 . ////////////////////////////////////////////////////////////////////////////
30276
30277 .chapter "System-wide message filtering" "CHAPsystemfilter"
30278 .scindex IIDsysfil1 "filter" "system filter"
30279 .scindex IIDsysfil2 "filtering all mail"
30280 .scindex IIDsysfil3 "system filter"
30281 The previous chapters (on ACLs and the local scan function) describe checks
30282 that can be applied to messages before they are accepted by a host. There is
30283 also a mechanism for checking messages once they have been received, but before
30284 they are delivered. This is called the &'system filter'&.
30285
30286 The system filter operates in a similar manner to users' filter files, but it
30287 is run just once per message (however many recipients the message has).
30288 It should not normally be used as a substitute for routing, because &%deliver%&
30289 commands in a system router provide new envelope recipient addresses.
30290 The system filter must be an Exim filter. It cannot be a Sieve filter.
30291
30292 The system filter is run at the start of a delivery attempt, before any routing
30293 is done. If a message fails to be completely delivered at the first attempt,
30294 the system filter is run again at the start of every retry.
30295 If you want your filter to do something only once per message, you can make use
30296 of the &%first_delivery%& condition in an &%if%& command in the filter to
30297 prevent it happening on retries.
30298
30299 .vindex "&$domain$&"
30300 .vindex "&$local_part$&"
30301 &*Warning*&: Because the system filter runs just once, variables that are
30302 specific to individual recipient addresses, such as &$local_part$& and
30303 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
30304 you want to run a centrally-specified filter for each recipient address
30305 independently, you can do so by setting up a suitable &(redirect)& router, as
30306 described in section &<<SECTperaddfil>>& below.
30307
30308
30309 .section "Specifying a system filter" "SECID212"
30310 .cindex "uid (user id)" "system filter"
30311 .cindex "gid (group id)" "system filter"
30312 The name of the file that contains the system filter must be specified by
30313 setting &%system_filter%&. If you want the filter to run under a uid and gid
30314 other than root, you must also set &%system_filter_user%& and
30315 &%system_filter_group%& as appropriate. For example:
30316 .code
30317 system_filter = /etc/mail/exim.filter
30318 system_filter_user = exim
30319 .endd
30320 If a system filter generates any deliveries directly to files or pipes (via the
30321 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
30322 specified by setting &%system_filter_file_transport%& and
30323 &%system_filter_pipe_transport%&, respectively. Similarly,
30324 &%system_filter_reply_transport%& must be set to handle any messages generated
30325 by the &%reply%& command.
30326
30327
30328 .section "Testing a system filter" "SECID213"
30329 You can run simple tests of a system filter in the same way as for a user
30330 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
30331 are permitted only in system filters are recognized.
30332
30333 If you want to test the combined effect of a system filter and a user filter,
30334 you can use both &%-bF%& and &%-bf%& on the same command line.
30335
30336
30337
30338 .section "Contents of a system filter" "SECID214"
30339 The language used to specify system filters is the same as for users' filter
30340 files. It is described in the separate end-user document &'Exim's interface to
30341 mail filtering'&. However, there are some additional features that are
30342 available only in system filters; these are described in subsequent sections.
30343 If they are encountered in a user's filter file or when testing with &%-bf%&,
30344 they cause errors.
30345
30346 .cindex "frozen messages" "manual thaw; testing in filter"
30347 There are two special conditions which, though available in users' filter
30348 files, are designed for use in system filters. The condition &%first_delivery%&
30349 is true only for the first attempt at delivering a message, and
30350 &%manually_thawed%& is true only if the message has been frozen, and
30351 subsequently thawed by an admin user. An explicit forced delivery counts as a
30352 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
30353
30354 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
30355 specify an &"unseen"& (non-significant) delivery, and that delivery does not
30356 succeed, it will not be tried again.
30357 If you want Exim to retry an unseen delivery until it succeeds, you should
30358 arrange to set it up every time the filter runs.
30359
30360 When a system filter finishes running, the values of the variables &$n0$& &--
30361 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
30362 users' filter files. Thus a system filter can, for example, set up &"scores"&
30363 to which users' filter files can refer.
30364
30365
30366
30367 .section "Additional variable for system filters" "SECID215"
30368 .vindex "&$recipients$&"
30369 The expansion variable &$recipients$&, containing a list of all the recipients
30370 of the message (separated by commas and white space), is available in system
30371 filters. It is not available in users' filters for privacy reasons.
30372
30373
30374
30375 .section "Defer, freeze, and fail commands for system filters" "SECID216"
30376 .cindex "freezing messages"
30377 .cindex "message" "freezing"
30378 .cindex "message" "forced failure"
30379 .cindex "&%fail%&" "in system filter"
30380 .cindex "&%freeze%& in system filter"
30381 .cindex "&%defer%& in system filter"
30382 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
30383 always available in system filters, but are not normally enabled in users'
30384 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
30385 for the &(redirect)& router.) These commands can optionally be followed by the
30386 word &%text%& and a string containing an error message, for example:
30387 .code
30388 fail text "this message looks like spam to me"
30389 .endd
30390 The keyword &%text%& is optional if the next character is a double quote.
30391
30392 The &%defer%& command defers delivery of the original recipients of the
30393 message. The &%fail%& command causes all the original recipients to be failed,
30394 and a bounce message to be created. The &%freeze%& command suspends all
30395 delivery attempts for the original recipients. In all cases, any new deliveries
30396 that are specified by the filter are attempted as normal after the filter has
30397 run.
30398
30399 The &%freeze%& command is ignored if the message has been manually unfrozen and
30400 not manually frozen since. This means that automatic freezing by a system
30401 filter can be used as a way of checking out suspicious messages. If a message
30402 is found to be all right, manually unfreezing it allows it to be delivered.
30403
30404 .cindex "log" "&%fail%& command log line"
30405 .cindex "&%fail%&" "log line; reducing"
30406 The text given with a fail command is used as part of the bounce message as
30407 well as being written to the log. If the message is quite long, this can fill
30408 up a lot of log space when such failures are common. To reduce the size of the
30409 log message, Exim interprets the text in a special way if it starts with the
30410 two characters &`<<`& and contains &`>>`& later. The text between these two
30411 strings is written to the log, and the rest of the text is used in the bounce
30412 message. For example:
30413 .code
30414 fail "<<filter test 1>>Your message is rejected \
30415      because it contains attachments that we are \
30416      not prepared to receive."
30417 .endd
30418
30419 .cindex "loop" "caused by &%fail%&"
30420 Take great care with the &%fail%& command when basing the decision to fail on
30421 the contents of the message, because the bounce message will of course include
30422 the contents of the original message and will therefore trigger the &%fail%&
30423 command again (causing a mail loop) unless steps are taken to prevent this.
30424 Testing the &%error_message%& condition is one way to prevent this. You could
30425 use, for example
30426 .code
30427 if $message_body contains "this is spam" and not error_message
30428 then fail text "spam is not wanted here" endif
30429 .endd
30430 though of course that might let through unwanted bounce messages. The
30431 alternative is clever checking of the body and/or headers to detect bounces
30432 generated by the filter.
30433
30434 The interpretation of a system filter file ceases after a
30435 &%defer%&,
30436 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
30437 set up earlier in the filter file are honoured, so you can use a sequence such
30438 as
30439 .code
30440 mail ...
30441 freeze
30442 .endd
30443 to send a specified message when the system filter is freezing (or deferring or
30444 failing) a message. The normal deliveries for the message do not, of course,
30445 take place.
30446
30447
30448
30449 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
30450 .cindex "header lines" "adding; in system filter"
30451 .cindex "header lines" "removing; in system filter"
30452 .cindex "filter" "header lines; adding/removing"
30453 Two filter commands that are available only in system filters are:
30454 .code
30455 headers add <string>
30456 headers remove <string>
30457 .endd
30458 The argument for the &%headers add%& is a string that is expanded and then
30459 added to the end of the message's headers. It is the responsibility of the
30460 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
30461 space is ignored, and if the string is otherwise empty, or if the expansion is
30462 forced to fail, the command has no effect.
30463
30464 You can use &"\n"& within the string, followed by white space, to specify
30465 continued header lines. More than one header may be added in one command by
30466 including &"\n"& within the string without any following white space. For
30467 example:
30468 .code
30469 headers add "X-header-1: ....\n  \
30470              continuation of X-header-1 ...\n\
30471              X-header-2: ...."
30472 .endd
30473 Note that the header line continuation white space after the first newline must
30474 be placed before the backslash that continues the input string, because white
30475 space after input continuations is ignored.
30476
30477 The argument for &%headers remove%& is a colon-separated list of header names.
30478 This command applies only to those headers that are stored with the message;
30479 those that are added at delivery time (such as &'Envelope-To:'& and
30480 &'Return-Path:'&) cannot be removed by this means. If there is more than one
30481 header with the same name, they are all removed.
30482
30483 The &%headers%& command in a system filter makes an immediate change to the set
30484 of header lines that was received with the message (with possible additions
30485 from ACL processing). Subsequent commands in the system filter operate on the
30486 modified set, which also forms the basis for subsequent message delivery.
30487 Unless further modified during routing or transporting, this set of headers is
30488 used for all recipients of the message.
30489
30490 During routing and transporting, the variables that refer to the contents of
30491 header lines refer only to those lines that are in this set. Thus, header lines
30492 that are added by a system filter are visible to users' filter files and to all
30493 routers and transports. This contrasts with the manipulation of header lines by
30494 routers and transports, which is not immediate, but which instead is saved up
30495 until the message is actually being written (see section
30496 &<<SECTheadersaddrem>>&).
30497
30498 If the message is not delivered at the first attempt, header lines that were
30499 added by the system filter are stored with the message, and so are still
30500 present at the next delivery attempt. Header lines that were removed are still
30501 present, but marked &"deleted"& so that they are not transported with the
30502 message. For this reason, it is usual to make the &%headers%& command
30503 conditional on &%first_delivery%& so that the set of header lines is not
30504 modified more than once.
30505
30506 Because header modification in a system filter acts immediately, you have to
30507 use an indirect approach if you want to modify the contents of a header line.
30508 For example:
30509 .code
30510 headers add "Old-Subject: $h_subject:"
30511 headers remove "Subject"
30512 headers add "Subject: new subject (was: $h_old-subject:)"
30513 headers remove "Old-Subject"
30514 .endd
30515
30516
30517
30518 .section "Setting an errors address in a system filter" "SECID217"
30519 .cindex "envelope sender"
30520 In a system filter, if a &%deliver%& command is followed by
30521 .code
30522 errors_to <some address>
30523 .endd
30524 in order to change the envelope sender (and hence the error reporting) for that
30525 delivery, any address may be specified. (In a user filter, only the current
30526 user's address can be set.) For example, if some mail is being monitored, you
30527 might use
30528 .code
30529 unseen deliver monitor@spying.example errors_to root@local.example
30530 .endd
30531 to take a copy which would not be sent back to the normal error reporting
30532 address if its delivery failed.
30533
30534
30535
30536 .section "Per-address filtering" "SECTperaddfil"
30537 .vindex "&$domain$&"
30538 .vindex "&$local_part$&"
30539 In contrast to the system filter, which is run just once per message for each
30540 delivery attempt, it is also possible to set up a system-wide filtering
30541 operation that runs once for each recipient address. In this case, variables
30542 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
30543 filter file could be made dependent on them. This is an example of a router
30544 which implements such a filter:
30545 .code
30546 central_filter:
30547   check_local_user
30548   driver = redirect
30549   domains = +local_domains
30550   file = /central/filters/$local_part
30551   no_verify
30552   allow_filter
30553   allow_freeze
30554 .endd
30555 The filter is run in a separate process under its own uid. Therefore, either
30556 &%check_local_user%& must be set (as above), in which case the filter is run as
30557 the local user, or the &%user%& option must be used to specify which user to
30558 use. If both are set, &%user%& overrides.
30559
30560 Care should be taken to ensure that none of the commands in the filter file
30561 specify a significant delivery if the message is to go on to be delivered to
30562 its intended recipient. The router will not then claim to have dealt with the
30563 address, so it will be passed on to subsequent routers to be delivered in the
30564 normal way.
30565 .ecindex IIDsysfil1
30566 .ecindex IIDsysfil2
30567 .ecindex IIDsysfil3
30568
30569
30570
30571
30572
30573
30574 . ////////////////////////////////////////////////////////////////////////////
30575 . ////////////////////////////////////////////////////////////////////////////
30576
30577 .chapter "Message processing" "CHAPmsgproc"
30578 .scindex IIDmesproc "message" "general processing"
30579 Exim performs various transformations on the sender and recipient addresses of
30580 all messages that it handles, and also on the messages' header lines. Some of
30581 these are optional and configurable, while others always take place. All of
30582 this processing, except rewriting as a result of routing, and the addition or
30583 removal of header lines while delivering, happens when a message is received,
30584 before it is placed on Exim's queue.
30585
30586 Some of the automatic processing takes place by default only for
30587 &"locally-originated"& messages. This adjective is used to describe messages
30588 that are not received over TCP/IP, but instead are passed to an Exim process on
30589 its standard input. This includes the interactive &"local SMTP"& case that is
30590 set up by the &%-bs%& command line option.
30591
30592 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
30593 or ::1) are not considered to be locally-originated. Exim does not treat the
30594 loopback interface specially in any way.
30595
30596 If you want the loopback interface to be treated specially, you must ensure
30597 that there are appropriate entries in your ACLs.
30598
30599
30600
30601
30602 .section "Submission mode for non-local messages" "SECTsubmodnon"
30603 .cindex "message" "submission"
30604 .cindex "submission mode"
30605 Processing that happens automatically for locally-originated messages (unless
30606 &%suppress_local_fixups%& is set) can also be requested for messages that are
30607 received over TCP/IP. The term &"submission mode"& is used to describe this
30608 state. Submission mode is set by the modifier
30609 .code
30610 control = submission
30611 .endd
30612 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
30613 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
30614 a local submission, and is normally used when the source of the message is
30615 known to be an MUA running on a client host (as opposed to an MTA). For
30616 example, to set submission mode for messages originating on the IPv4 loopback
30617 interface, you could include the following in the MAIL ACL:
30618 .code
30619 warn  hosts = 127.0.0.1
30620       control = submission
30621 .endd
30622 .cindex "&%sender_retain%& submission option"
30623 There are some options that can be used when setting submission mode. A slash
30624 is used to separate options. For example:
30625 .code
30626 control = submission/sender_retain
30627 .endd
30628 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
30629 true and &%local_from_check%& false for the current incoming message. The first
30630 of these allows an existing &'Sender:'& header in the message to remain, and
30631 the second suppresses the check to ensure that &'From:'& matches the
30632 authenticated sender. With this setting, Exim still fixes up messages by adding
30633 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
30634 attempt to check sender authenticity in header lines.
30635
30636 When &%sender_retain%& is not set, a submission mode setting may specify a
30637 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
30638 example:
30639 .code
30640 control = submission/domain=some.domain
30641 .endd
30642 The domain may be empty. How this value is used is described in sections
30643 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
30644 that allows you to specify the user's full name for inclusion in a created
30645 &'Sender:'& or &'From:'& header line. For example:
30646 .code
30647 accept authenticated = *
30648        control = submission/domain=wonderland.example/\
30649                             name=${lookup {$authenticated_id} \
30650                                    lsearch {/etc/exim/namelist}}
30651 .endd
30652 Because the name may contain any characters, including slashes, the &%name%&
30653 option must be given last. The remainder of the string is used as the name. For
30654 the example above, if &_/etc/exim/namelist_& contains:
30655 .code
30656 bigegg:  Humpty Dumpty
30657 .endd
30658 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
30659 line would be:
30660 .code
30661 Sender: Humpty Dumpty <bigegg@wonderland.example>
30662 .endd
30663 .cindex "return path" "in submission mode"
30664 By default, submission mode forces the return path to the same address as is
30665 used to create the &'Sender:'& header. However, if &%sender_retain%& is
30666 specified, the return path is also left unchanged.
30667
30668 &*Note*&: The changes caused by submission mode take effect after the predata
30669 ACL. This means that any sender checks performed before the fix-ups use the
30670 untrusted sender address specified by the user, not the trusted sender address
30671 specified by submission mode. Although this might be slightly unexpected, it
30672 does mean that you can configure ACL checks to spot that a user is trying to
30673 spoof another's address.
30674
30675 .section "Line endings" "SECTlineendings"
30676 .cindex "line endings"
30677 .cindex "carriage return"
30678 .cindex "linefeed"
30679 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
30680 linefeed) is the line ending for messages transmitted over the Internet using
30681 SMTP over TCP/IP. However, within individual operating systems, different
30682 conventions are used. For example, Unix-like systems use just LF, but others
30683 use CRLF or just CR.
30684
30685 Exim was designed for Unix-like systems, and internally, it stores messages
30686 using the system's convention of a single LF as a line terminator. When
30687 receiving a message, all line endings are translated to this standard format.
30688 Originally, it was thought that programs that passed messages directly to an
30689 MTA within an operating system would use that system's convention. Experience
30690 has shown that this is not the case; for example, there are Unix applications
30691 that use CRLF in this circumstance. For this reason, and for compatibility with
30692 other MTAs, the way Exim handles line endings for all messages is now as
30693 follows:
30694
30695 .ilist
30696 LF not preceded by CR is treated as a line ending.
30697 .next
30698 CR is treated as a line ending; if it is immediately followed by LF, the LF
30699 is ignored.
30700 .next
30701 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
30702 nor a local message in the state where a line containing only a dot is a
30703 terminator.
30704 .next
30705 If a bare CR is encountered within a header line, an extra space is added after
30706 the line terminator so as not to end the header line. The reasoning behind this
30707 is that bare CRs in header lines are most likely either to be mistakes, or
30708 people trying to play silly games.
30709 .next
30710 If the first header line received in a message ends with CRLF, a subsequent
30711 bare LF in a header line is treated in the same way as a bare CR in a header
30712 line.
30713 .endlist
30714
30715
30716
30717
30718
30719 .section "Unqualified addresses" "SECID218"
30720 .cindex "unqualified addresses"
30721 .cindex "address" "qualification"
30722 By default, Exim expects every envelope address it receives from an external
30723 host to be fully qualified. Unqualified addresses cause negative responses to
30724 SMTP commands. However, because SMTP is used as a means of transporting
30725 messages from MUAs running on personal workstations, there is sometimes a
30726 requirement to accept unqualified addresses from specific hosts or IP networks.
30727
30728 Exim has two options that separately control which hosts may send unqualified
30729 sender or recipient addresses in SMTP commands, namely
30730 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
30731 cases, if an unqualified address is accepted, it is qualified by adding the
30732 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
30733
30734 .oindex "&%qualify_domain%&"
30735 .oindex "&%qualify_recipient%&"
30736 Unqualified addresses in header lines are automatically qualified for messages
30737 that are locally originated, unless the &%-bnq%& option is given on the command
30738 line. For messages received over SMTP, unqualified addresses in header lines
30739 are qualified only if unqualified addresses are permitted in SMTP commands. In
30740 other words, such qualification is also controlled by
30741 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
30742
30743
30744
30745
30746 .section "The UUCP From line" "SECID219"
30747 .cindex "&""From""& line"
30748 .cindex "UUCP" "&""From""& line"
30749 .cindex "sender" "address"
30750 .oindex "&%uucp_from_pattern%&"
30751 .oindex "&%uucp_from_sender%&"
30752 .cindex "envelope sender"
30753 .cindex "Sendmail compatibility" "&""From""& line"
30754 Messages that have come from UUCP (and some other applications) often begin
30755 with a line containing the envelope sender and a timestamp, following the word
30756 &"From"&. Examples of two common formats are:
30757 .code
30758 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
30759 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
30760 .endd
30761 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
30762 Exim recognizes such lines at the start of messages that are submitted to it
30763 via the command line (that is, on the standard input). It does not recognize
30764 such lines in incoming SMTP messages, unless the sending host matches
30765 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
30766 and &%ignore_fromline_local%& is set. The recognition is controlled by a
30767 regular expression that is defined by the &%uucp_from_pattern%& option, whose
30768 default value matches the two common cases shown above and puts the address
30769 that follows &"From"& into &$1$&.
30770
30771 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
30772 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
30773 a trusted user, the message's sender address is constructed by expanding the
30774 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
30775 then parsed as an RFC 2822 address. If there is no domain, the local part is
30776 qualified with &%qualify_domain%& unless it is the empty string. However, if
30777 the command line &%-f%& option is used, it overrides the &"From"& line.
30778
30779 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
30780 sender address is not changed. This is also the case for incoming SMTP messages
30781 that are permitted to contain &"From"& lines.
30782
30783 Only one &"From"& line is recognized. If there is more than one, the second is
30784 treated as a data line that starts the body of the message, as it is not valid
30785 as a header line. This also happens if a &"From"& line is present in an
30786 incoming SMTP message from a source that is not permitted to send them.
30787
30788
30789
30790 .section "Resent- header lines" "SECID220"
30791 .cindex "&%Resent-%& header lines"
30792 RFC 2822 makes provision for sets of header lines starting with the string
30793 &`Resent-`& to be added to a message when it is resent by the original
30794 recipient to somebody else. These headers are &'Resent-Date:'&,
30795 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
30796 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
30797
30798 .blockquote
30799 &'Resent fields are strictly informational. They MUST NOT be used in the normal
30800 processing of replies or other such automatic actions on messages.'&
30801 .endblockquote
30802
30803 This leaves things a bit vague as far as other processing actions such as
30804 address rewriting are concerned. Exim treats &%Resent-%& header lines as
30805 follows:
30806
30807 .ilist
30808 A &'Resent-From:'& line that just contains the login id of the submitting user
30809 is automatically rewritten in the same way as &'From:'& (see below).
30810 .next
30811 If there's a rewriting rule for a particular header line, it is also applied to
30812 &%Resent-%& header lines of the same type. For example, a rule that rewrites
30813 &'From:'& also rewrites &'Resent-From:'&.
30814 .next
30815 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
30816 also removed.
30817 .next
30818 For a locally-submitted message,
30819 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
30820 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
30821 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
30822 included in log lines in this case.
30823 .next
30824 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
30825 &%Resent-%& header lines are present.
30826 .endlist
30827
30828
30829
30830
30831 .section "The Auto-Submitted: header line" "SECID221"
30832 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
30833 includes the header line:
30834 .code
30835 Auto-Submitted: auto-replied
30836 .endd
30837
30838 .section "The Bcc: header line" "SECID222"
30839 .cindex "&'Bcc:'& header line"
30840 If Exim is called with the &%-t%& option, to take recipient addresses from a
30841 message's header, it removes any &'Bcc:'& header line that may exist (after
30842 extracting its addresses). If &%-t%& is not present on the command line, any
30843 existing &'Bcc:'& is not removed.
30844
30845
30846 .section "The Date: header line" "SECID223"
30847 .cindex "&'Date:'& header line"
30848 If a locally-generated or submission-mode message has no &'Date:'& header line,
30849 Exim adds one, using the current date and time, unless the
30850 &%suppress_local_fixups%& control has been specified.
30851
30852 .section "The Delivery-date: header line" "SECID224"
30853 .cindex "&'Delivery-date:'& header line"
30854 .oindex "&%delivery_date_remove%&"
30855 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
30856 set. Exim can be configured to add them to the final delivery of messages. (See
30857 the generic &%delivery_date_add%& transport option.) They should not be present
30858 in messages in transit. If the &%delivery_date_remove%& configuration option is
30859 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
30860 messages.
30861
30862
30863 .section "The Envelope-to: header line" "SECID225"
30864 .cindex "&'Envelope-to:'& header line"
30865 .oindex "&%envelope_to_remove%&"
30866 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
30867 Exim can be configured to add them to the final delivery of messages. (See the
30868 generic &%envelope_to_add%& transport option.) They should not be present in
30869 messages in transit. If the &%envelope_to_remove%& configuration option is set
30870 (the default), Exim removes &'Envelope-to:'& header lines from incoming
30871 messages.
30872
30873
30874 .section "The From: header line" "SECTthefrohea"
30875 .cindex "&'From:'& header line"
30876 .cindex "Sendmail compatibility" "&""From""& line"
30877 .cindex "message" "submission"
30878 .cindex "submission mode"
30879 If a submission-mode message does not contain a &'From:'& header line, Exim
30880 adds one if either of the following conditions is true:
30881
30882 .ilist
30883 The envelope sender address is not empty (that is, this is not a bounce
30884 message). The added header line copies the envelope sender address.
30885 .next
30886 .vindex "&$authenticated_id$&"
30887 The SMTP session is authenticated and &$authenticated_id$& is not empty.
30888 .olist
30889 .vindex "&$qualify_domain$&"
30890 If no domain is specified by the submission control, the local part is
30891 &$authenticated_id$& and the domain is &$qualify_domain$&.
30892 .next
30893 If a non-empty domain is specified by the submission control, the local
30894 part is &$authenticated_id$&, and the domain is the specified domain.
30895 .next
30896 If an empty domain is specified by the submission control,
30897 &$authenticated_id$& is assumed to be the complete address.
30898 .endlist
30899 .endlist
30900
30901 A non-empty envelope sender takes precedence.
30902
30903 If a locally-generated incoming message does not contain a &'From:'& header
30904 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
30905 containing the sender's address. The calling user's login name and full name
30906 are used to construct the address, as described in section &<<SECTconstr>>&.
30907 They are obtained from the password data by calling &[getpwuid()]& (but see the
30908 &%unknown_login%& configuration option). The address is qualified with
30909 &%qualify_domain%&.
30910
30911 For compatibility with Sendmail, if an incoming, non-SMTP message has a
30912 &'From:'& header line containing just the unqualified login name of the calling
30913 user, this is replaced by an address containing the user's login name and full
30914 name as described in section &<<SECTconstr>>&.
30915
30916
30917 .section "The Message-ID: header line" "SECID226"
30918 .cindex "&'Message-ID:'& header line"
30919 .cindex "message" "submission"
30920 .oindex "&%message_id_header_text%&"
30921 If a locally-generated or submission-mode incoming message does not contain a
30922 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
30923 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
30924 to the message. If there are any &'Resent-:'& headers in the message, it
30925 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
30926 message id, preceded by the letter E to ensure it starts with a letter, and
30927 followed by @ and the primary host name. Additional information can be included
30928 in this header line by setting the &%message_id_header_text%& and/or
30929 &%message_id_header_domain%& options.
30930
30931
30932 .section "The Received: header line" "SECID227"
30933 .cindex "&'Received:'& header line"
30934 A &'Received:'& header line is added at the start of every message. The
30935 contents are defined by the &%received_header_text%& configuration option, and
30936 Exim automatically adds a semicolon and a timestamp to the configured string.
30937
30938 The &'Received:'& header is generated as soon as the message's header lines
30939 have been received. At this stage, the timestamp in the &'Received:'& header
30940 line is the time that the message started to be received. This is the value
30941 that is seen by the DATA ACL and by the &[local_scan()]& function.
30942
30943 Once a message is accepted, the timestamp in the &'Received:'& header line is
30944 changed to the time of acceptance, which is (apart from a small delay while the
30945 -H spool file is written) the earliest time at which delivery could start.
30946
30947
30948 .section "The References: header line" "SECID228"
30949 .cindex "&'References:'& header line"
30950 Messages created by the &(autoreply)& transport include a &'References:'&
30951 header line. This is constructed according to the rules that are described in
30952 section 3.64 of RFC 2822 (which states that replies should contain such a
30953 header line), and section 3.14 of RFC 3834 (which states that automatic
30954 responses are not different in this respect). However, because some mail
30955 processing software does not cope well with very long header lines, no more
30956 than 12 message IDs are copied from the &'References:'& header line in the
30957 incoming message. If there are more than 12, the first one and then the final
30958 11 are copied, before adding the message ID of the incoming message.
30959
30960
30961
30962 .section "The Return-path: header line" "SECID229"
30963 .cindex "&'Return-path:'& header line"
30964 .oindex "&%return_path_remove%&"
30965 &'Return-path:'& header lines are defined as something an MTA may insert when
30966 it does the final delivery of messages. (See the generic &%return_path_add%&
30967 transport option.) Therefore, they should not be present in messages in
30968 transit. If the &%return_path_remove%& configuration option is set (the
30969 default), Exim removes &'Return-path:'& header lines from incoming messages.
30970
30971
30972
30973 .section "The Sender: header line" "SECTthesenhea"
30974 .cindex "&'Sender:'& header line"
30975 .cindex "message" "submission"
30976 For a locally-originated message from an untrusted user, Exim may remove an
30977 existing &'Sender:'& header line, and it may add a new one. You can modify
30978 these actions by setting the &%local_sender_retain%& option true, the
30979 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
30980 control setting.
30981
30982 When a local message is received from an untrusted user and
30983 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
30984 control has not been set, a check is made to see if the address given in the
30985 &'From:'& header line is the correct (local) sender of the message. The address
30986 that is expected has the login name as the local part and the value of
30987 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
30988 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
30989 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
30990 line is added to the message.
30991
30992 If you set &%local_from_check%& false, this checking does not occur. However,
30993 the removal of an existing &'Sender:'& line still happens, unless you also set
30994 &%local_sender_retain%& to be true. It is not possible to set both of these
30995 options true at the same time.
30996
30997 .cindex "submission mode"
30998 By default, no processing of &'Sender:'& header lines is done for messages
30999 received over TCP/IP or for messages submitted by trusted users. However, when
31000 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31001 not specified on the submission control, the following processing takes place:
31002
31003 .vindex "&$authenticated_id$&"
31004 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31005 authenticated, and &$authenticated_id$& is not empty, a sender address is
31006 created as follows:
31007
31008 .ilist
31009 .vindex "&$qualify_domain$&"
31010 If no domain is specified by the submission control, the local part is
31011 &$authenticated_id$& and the domain is &$qualify_domain$&.
31012 .next
31013 If a non-empty domain is specified by the submission control, the local part
31014 is &$authenticated_id$&, and the domain is the specified domain.
31015 .next
31016 If an empty domain is specified by the submission control,
31017 &$authenticated_id$& is assumed to be the complete address.
31018 .endlist
31019
31020 This address is compared with the address in the &'From:'& header line. If they
31021 are different, a &'Sender:'& header line containing the created address is
31022 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31023 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31024
31025 .cindex "return path" "created from &'Sender:'&"
31026 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31027 the message (the envelope sender address) is changed to be the same address,
31028 except in the case of submission mode when &%sender_retain%& is specified.
31029
31030
31031
31032 .section "Adding and removing header lines in routers and transports" &&&
31033          "SECTheadersaddrem"
31034 .cindex "header lines" "adding; in router or transport"
31035 .cindex "header lines" "removing; in router or transport"
31036 When a message is delivered, the addition and removal of header lines can be
31037 specified in a system filter, or on any of the routers and transports that
31038 process the message. Section &<<SECTaddremheasys>>& contains details about
31039 modifying headers in a system filter. Header lines can also be added in an ACL
31040 as a message is received (see section &<<SECTaddheadacl>>&).
31041
31042 In contrast to what happens in a system filter, header modifications that are
31043 specified on routers and transports apply only to the particular recipient
31044 addresses that are being processed by those routers and transports. These
31045 changes do not actually take place until a copy of the message is being
31046 transported. Therefore, they do not affect the basic set of header lines, and
31047 they do not affect the values of the variables that refer to header lines.
31048
31049 &*Note*&: In particular, this means that any expansions in the configuration of
31050 the transport cannot refer to the modified header lines, because such
31051 expansions all occur before the message is actually transported.
31052
31053 For both routers and transports, the result of expanding a &%headers_add%&
31054 option must be in the form of one or more RFC 2822 header lines, separated by
31055 newlines (coded as &"\n"&). For example:
31056 .code
31057 headers_add = X-added-header: added by $primary_hostname\n\
31058               X-added-second: another added header line
31059 .endd
31060 Exim does not check the syntax of these added header lines.
31061
31062 The result of expanding &%headers_remove%& must consist of a colon-separated
31063 list of header names. This is confusing, because header names themselves are
31064 often terminated by colons. In this case, the colons are the list separators,
31065 not part of the names. For example:
31066 .code
31067 headers_remove = return-receipt-to:acknowledge-to
31068 .endd
31069 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31070 is expanded at routing time, and then associated with all addresses that are
31071 accepted by that router, and also with any new addresses that it generates. If
31072 an address passes through several routers as a result of aliasing or
31073 forwarding, the changes are cumulative.
31074
31075 .oindex "&%unseen%&"
31076 However, this does not apply to multiple routers that result from the use of
31077 the &%unseen%& option. Any header modifications that were specified by the
31078 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
31079
31080 Addresses that end up with different &%headers_add%& or &%headers_remove%&
31081 settings cannot be delivered together in a batch, so a transport is always
31082 dealing with a set of addresses that have the same header-processing
31083 requirements.
31084
31085 The transport starts by writing the original set of header lines that arrived
31086 with the message, possibly modified by the system filter. As it writes out
31087 these lines, it consults the list of header names that were attached to the
31088 recipient address(es) by &%headers_remove%& options in routers, and it also
31089 consults the transport's own &%headers_remove%& option. Header lines whose
31090 names are on either of these lists are not written out. If there are multiple
31091 instances of any listed header, they are all skipped.
31092
31093 After the remaining original header lines have been written, new header
31094 lines that were specified by routers' &%headers_add%& options are written, in
31095 the order in which they were attached to the address. These are followed by any
31096 header lines specified by the transport's &%headers_add%& option.
31097
31098 This way of handling header line modifications in routers and transports has
31099 the following consequences:
31100
31101 .ilist
31102 The original set of header lines, possibly modified by the system filter,
31103 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
31104 to it, at all times.
31105 .next
31106 Header lines that are added by a router's
31107 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
31108 expansion syntax in subsequent routers or the transport.
31109 .next
31110 Conversely, header lines that are specified for removal by &%headers_remove%&
31111 in a router remain visible to subsequent routers and the transport.
31112 .next
31113 Headers added to an address by &%headers_add%& in a router cannot be removed by
31114 a later router or by a transport.
31115 .next
31116 An added header can refer to the contents of an original header that is to be
31117 removed, even it has the same name as the added header. For example:
31118 .code
31119 headers_remove = subject
31120 headers_add = Subject: new subject (was: $h_subject:)
31121 .endd
31122 .endlist
31123
31124 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
31125 for a &(redirect)& router that has the &%one_time%& option set.
31126
31127
31128
31129
31130
31131 .section "Constructed addresses" "SECTconstr"
31132 .cindex "address" "constructed"
31133 .cindex "constructed address"
31134 When Exim constructs a sender address for a locally-generated message, it uses
31135 the form
31136 .display
31137 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
31138 .endd
31139 For example:
31140 .code
31141 Zaphod Beeblebrox <zaphod@end.univ.example>
31142 .endd
31143 The user name is obtained from the &%-F%& command line option if set, or
31144 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
31145 &"gecos"& field from the password entry. If the &"gecos"& field contains an
31146 ampersand character, this is replaced by the login name with the first letter
31147 upper cased, as is conventional in a number of operating systems. See the
31148 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
31149 The &%unknown_username%& option can be used to specify user names in cases when
31150 there is no password file entry.
31151
31152 .cindex "RFC 2047"
31153 In all cases, the user name is made to conform to RFC 2822 by quoting all or
31154 parts of it if necessary. In addition, if it contains any non-printing
31155 characters, it is encoded as described in RFC 2047, which defines a way of
31156 including non-ASCII characters in header lines. The value of the
31157 &%headers_charset%& option specifies the name of the encoding that is used (the
31158 characters are assumed to be in this encoding). The setting of
31159 &%print_topbitchars%& controls whether characters with the top bit set (that
31160 is, with codes greater than 127) count as printing characters or not.
31161
31162
31163
31164 .section "Case of local parts" "SECID230"
31165 .cindex "case of local parts"
31166 .cindex "local part" "case of"
31167 RFC 2822 states that the case of letters in the local parts of addresses cannot
31168 be assumed to be non-significant. Exim preserves the case of local parts of
31169 addresses, but by default it uses a lower-cased form when it is routing,
31170 because on most Unix systems, usernames are in lower case and case-insensitive
31171 routing is required. However, any particular router can be made to use the
31172 original case for local parts by setting the &%caseful_local_part%& generic
31173 router option.
31174
31175 .cindex "mixed-case login names"
31176 If you must have mixed-case user names on your system, the best way to proceed,
31177 assuming you want case-independent handling of incoming email, is to set up
31178 your first router to convert incoming local parts in your domains to the
31179 correct case by means of a file lookup. For example:
31180 .code
31181 correct_case:
31182   driver = redirect
31183   domains = +local_domains
31184   data = ${lookup{$local_part}cdb\
31185               {/etc/usercased.cdb}{$value}fail}\
31186               @$domain
31187 .endd
31188 For this router, the local part is forced to lower case by the default action
31189 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
31190 up a new local part in the correct case. If you then set &%caseful_local_part%&
31191 on any subsequent routers which process your domains, they will operate on
31192 local parts with the correct case in a case-sensitive manner.
31193
31194
31195
31196 .section "Dots in local parts" "SECID231"
31197 .cindex "dot" "in local part"
31198 .cindex "local part" "dots in"
31199 RFC 2822 forbids empty components in local parts. That is, an unquoted local
31200 part may not begin or end with a dot, nor have two consecutive dots in the
31201 middle. However, it seems that many MTAs do not enforce this, so Exim permits
31202 empty components for compatibility.
31203
31204
31205
31206 .section "Rewriting addresses" "SECID232"
31207 .cindex "rewriting" "addresses"
31208 Rewriting of sender and recipient addresses, and addresses in headers, can
31209 happen automatically, or as the result of configuration options, as described
31210 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
31211 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
31212
31213 Automatic rewriting includes qualification, as mentioned above. The other case
31214 in which it can happen is when an incomplete non-local domain is given. The
31215 routing process may cause this to be expanded into the full domain name. For
31216 example, a header such as
31217 .code
31218 To: hare@teaparty
31219 .endd
31220 might get rewritten as
31221 .code
31222 To: hare@teaparty.wonderland.fict.example
31223 .endd
31224 Rewriting as a result of routing is the one kind of message processing that
31225 does not happen at input time, as it cannot be done until the address has
31226 been routed.
31227
31228 Strictly, one should not do &'any'& deliveries of a message until all its
31229 addresses have been routed, in case any of the headers get changed as a
31230 result of routing. However, doing this in practice would hold up many
31231 deliveries for unreasonable amounts of time, just because one address could not
31232 immediately be routed. Exim therefore does not delay other deliveries when
31233 routing of one or more addresses is deferred.
31234 .ecindex IIDmesproc
31235
31236
31237
31238 . ////////////////////////////////////////////////////////////////////////////
31239 . ////////////////////////////////////////////////////////////////////////////
31240
31241 .chapter "SMTP processing" "CHAPSMTP"
31242 .scindex IIDsmtpproc1 "SMTP" "processing details"
31243 .scindex IIDsmtpproc2 "LMTP" "processing details"
31244 Exim supports a number of different ways of using the SMTP protocol, and its
31245 LMTP variant, which is an interactive protocol for transferring messages into a
31246 closed mail store application. This chapter contains details of how SMTP is
31247 processed. For incoming mail, the following are available:
31248
31249 .ilist
31250 SMTP over TCP/IP (Exim daemon or &'inetd'&);
31251 .next
31252 SMTP over the standard input and output (the &%-bs%& option);
31253 .next
31254 Batched SMTP on the standard input (the &%-bS%& option).
31255 .endlist
31256
31257 For mail delivery, the following are available:
31258
31259 .ilist
31260 SMTP over TCP/IP (the &(smtp)& transport);
31261 .next
31262 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
31263 &"lmtp"&);
31264 .next
31265 LMTP over a pipe to a process running in the local host (the &(lmtp)&
31266 transport);
31267 .next
31268 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
31269 the &%use_bsmtp%& option set).
31270 .endlist
31271
31272 &'Batched SMTP'& is the name for a process in which batches of messages are
31273 stored in or read from files (or pipes), in a format in which SMTP commands are
31274 used to contain the envelope information.
31275
31276
31277
31278 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
31279 .cindex "SMTP" "outgoing over TCP/IP"
31280 .cindex "outgoing SMTP over TCP/IP"
31281 .cindex "LMTP" "over TCP/IP"
31282 .cindex "outgoing LMTP over TCP/IP"
31283 .cindex "EHLO"
31284 .cindex "HELO"
31285 .cindex "SIZE option on MAIL command"
31286 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
31287 The &%protocol%& option selects which protocol is to be used, but the actual
31288 processing is the same in both cases.
31289
31290 If, in response to its EHLO command, Exim is told that the SIZE
31291 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
31292 command. The value of <&'n'&> is the message size plus the value of the
31293 &%size_addition%& option (default 1024) to allow for additions to the message
31294 such as per-transport header lines, or changes made in a
31295 .cindex "transport" "filter"
31296 .cindex "filter" "transport filter"
31297 transport filter. If &%size_addition%& is set negative, the use of SIZE is
31298 suppressed.
31299
31300 If the remote server advertises support for PIPELINING, Exim uses the
31301 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
31302 required for the transaction.
31303
31304 If the remote server advertises support for the STARTTLS command, and Exim
31305 was built to support TLS encryption, it tries to start a TLS session unless the
31306 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
31307
31308 If the remote server advertises support for the AUTH command, Exim scans
31309 the authenticators configuration for any suitable client settings, as described
31310 in chapter &<<CHAPSMTPAUTH>>&.
31311
31312 .cindex "carriage return"
31313 .cindex "linefeed"
31314 Responses from the remote host are supposed to be terminated by CR followed by
31315 LF. However, there are known to be hosts that do not send CR characters, so in
31316 order to be able to interwork with such hosts, Exim treats LF on its own as a
31317 line terminator.
31318
31319 If a message contains a number of different addresses, all those with the same
31320 characteristics (for example, the same envelope sender) that resolve to the
31321 same set of hosts, in the same order, are sent in a single SMTP transaction,
31322 even if they are for different domains, unless there are more than the setting
31323 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
31324 they are split into groups containing no more than &%max_rcpt%&s addresses
31325 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
31326 in parallel sessions. The order of hosts with identical MX values is not
31327 significant when checking whether addresses can be batched in this way.
31328
31329 When the &(smtp)& transport suffers a temporary failure that is not
31330 message-related, Exim updates its transport-specific database, which contains
31331 records indexed by host name that remember which messages are waiting for each
31332 particular host. It also updates the retry database with new retry times.
31333
31334 .cindex "hints database" "retry keys"
31335 Exim's retry hints are based on host name plus IP address, so if one address of
31336 a multi-homed host is broken, it will soon be skipped most of the time.
31337 See the next section for more detail about error handling.
31338
31339 .cindex "SMTP" "passed connection"
31340 .cindex "SMTP" "batching over TCP/IP"
31341 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
31342 looks in the hints database for the transport to see if there are any queued
31343 messages waiting for the host to which it is connected. If it finds one, it
31344 creates a new Exim process using the &%-MC%& option (which can only be used by
31345 a process running as root or the Exim user) and passes the TCP/IP socket to it
31346 so that it can deliver another message using the same socket. The new process
31347 does only those deliveries that are routed to the connected host, and may in
31348 turn pass the socket on to a third process, and so on.
31349
31350 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
31351 limit the number of messages sent down a single TCP/IP connection.
31352
31353 .cindex "asterisk" "after IP address"
31354 The second and subsequent messages delivered down an existing connection are
31355 identified in the main log by the addition of an asterisk after the closing
31356 square bracket of the IP address.
31357
31358
31359
31360
31361 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
31362 .cindex "error" "in outgoing SMTP"
31363 .cindex "SMTP" "errors in outgoing"
31364 .cindex "host" "error"
31365 Three different kinds of error are recognized for outgoing SMTP: host errors,
31366 message errors, and recipient errors.
31367
31368 .vlist
31369 .vitem "&*Host errors*&"
31370 A host error is not associated with a particular message or with a
31371 particular recipient of a message. The host errors are:
31372
31373 .ilist
31374 Connection refused or timed out,
31375 .next
31376 Any error response code on connection,
31377 .next
31378 Any error response code to EHLO or HELO,
31379 .next
31380 Loss of connection at any time, except after &"."&,
31381 .next
31382 I/O errors at any time,
31383 .next
31384 Timeouts during the session, other than in response to MAIL, RCPT or
31385 the &"."& at the end of the data.
31386 .endlist ilist
31387
31388 For a host error, a permanent error response on connection, or in response to
31389 EHLO, causes all addresses routed to the host to be failed. Any other host
31390 error causes all addresses to be deferred, and retry data to be created for the
31391 host. It is not tried again, for any message, until its retry time arrives. If
31392 the current set of addresses are not all delivered in this run (to some
31393 alternative host), the message is added to the list of those waiting for this
31394 host, so if it is still undelivered when a subsequent successful delivery is
31395 made to the host, it will be sent down the same SMTP connection.
31396
31397 .vitem "&*Message errors*&"
31398 .cindex "message" "error"
31399 A message error is associated with a particular message when sent to a
31400 particular host, but not with a particular recipient of the message. The
31401 message errors are:
31402
31403 .ilist
31404 Any error response code to MAIL, DATA, or the &"."& that terminates
31405 the data,
31406 .next
31407 Timeout after MAIL,
31408 .next
31409 Timeout or loss of connection after the &"."& that terminates the data. A
31410 timeout after the DATA command itself is treated as a host error, as is loss of
31411 connection at any other time.
31412 .endlist ilist
31413
31414 For a message error, a permanent error response (5&'xx'&) causes all addresses
31415 to be failed, and a delivery error report to be returned to the sender. A
31416 temporary error response (4&'xx'&), or one of the timeouts, causes all
31417 addresses to be deferred. Retry data is not created for the host, but instead,
31418 a retry record for the combination of host plus message id is created. The
31419 message is not added to the list of those waiting for this host. This ensures
31420 that the failing message will not be sent to this host again until the retry
31421 time arrives. However, other messages that are routed to the host are not
31422 affected, so if it is some property of the message that is causing the error,
31423 it will not stop the delivery of other mail.
31424
31425 If the remote host specified support for the SIZE parameter in its response
31426 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
31427 over-large message will cause a message error because the error arrives as a
31428 response to MAIL.
31429
31430 .vitem "&*Recipient errors*&"
31431 .cindex "recipient" "error"
31432 A recipient error is associated with a particular recipient of a message. The
31433 recipient errors are:
31434
31435 .ilist
31436 Any error response to RCPT,
31437 .next
31438 Timeout after RCPT.
31439 .endlist
31440
31441 For a recipient error, a permanent error response (5&'xx'&) causes the
31442 recipient address to be failed, and a bounce message to be returned to the
31443 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
31444 address to be deferred, and routing retry data to be created for it. This is
31445 used to delay processing of the address in subsequent queue runs, until its
31446 routing retry time arrives. This applies to all messages, but because it
31447 operates only in queue runs, one attempt will be made to deliver a new message
31448 to the failing address before the delay starts to operate. This ensures that,
31449 if the failure is really related to the message rather than the recipient
31450 (&"message too big for this recipient"& is a possible example), other messages
31451 have a chance of getting delivered. If a delivery to the address does succeed,
31452 the retry information gets cleared, so all stuck messages get tried again, and
31453 the retry clock is reset.
31454
31455 The message is not added to the list of those waiting for this host. Use of the
31456 host for other messages is unaffected, and except in the case of a timeout,
31457 other recipients are processed independently, and may be successfully delivered
31458 in the current SMTP session. After a timeout it is of course impossible to
31459 proceed with the session, so all addresses get deferred. However, those other
31460 than the one that failed do not suffer any subsequent retry delays. Therefore,
31461 if one recipient is causing trouble, the others have a chance of getting
31462 through when a subsequent delivery attempt occurs before the failing
31463 recipient's retry time.
31464 .endlist
31465
31466 In all cases, if there are other hosts (or IP addresses) available for the
31467 current set of addresses (for example, from multiple MX records), they are
31468 tried in this run for any undelivered addresses, subject of course to their
31469 own retry data. In other words, recipient error retry data does not take effect
31470 until the next delivery attempt.
31471
31472 Some hosts have been observed to give temporary error responses to every
31473 MAIL command at certain times (&"insufficient space"& has been seen). It
31474 would be nice if such circumstances could be recognized, and defer data for the
31475 host itself created, but this is not possible within the current Exim design.
31476 What actually happens is that retry data for every (host, message) combination
31477 is created.
31478
31479 The reason that timeouts after MAIL and RCPT are treated specially is that
31480 these can sometimes arise as a result of the remote host's verification
31481 procedures. Exim makes this assumption, and treats them as if a temporary error
31482 response had been received. A timeout after &"."& is treated specially because
31483 it is known that some broken implementations fail to recognize the end of the
31484 message if the last character of the last line is a binary zero. Thus, it is
31485 helpful to treat this case as a message error.
31486
31487 Timeouts at other times are treated as host errors, assuming a problem with the
31488 host, or the connection to it. If a timeout after MAIL, RCPT,
31489 or &"."& is really a connection problem, the assumption is that at the next try
31490 the timeout is likely to occur at some other point in the dialogue, causing it
31491 then to be treated as a host error.
31492
31493 There is experimental evidence that some MTAs drop the connection after the
31494 terminating &"."& if they do not like the contents of the message for some
31495 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
31496 should be given. That is why Exim treats this case as a message rather than a
31497 host error, in order not to delay other messages to the same host.
31498
31499
31500
31501
31502 .section "Incoming SMTP messages over TCP/IP" "SECID233"
31503 .cindex "SMTP" "incoming over TCP/IP"
31504 .cindex "incoming SMTP over TCP/IP"
31505 .cindex "inetd"
31506 .cindex "daemon"
31507 Incoming SMTP messages can be accepted in one of two ways: by running a
31508 listening daemon, or by using &'inetd'&. In the latter case, the entry in
31509 &_/etc/inetd.conf_& should be like this:
31510 .code
31511 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
31512 .endd
31513 Exim distinguishes between this case and the case of a locally running user
31514 agent using the &%-bs%& option by checking whether or not the standard input is
31515 a socket. When it is, either the port must be privileged (less than 1024), or
31516 the caller must be root or the Exim user. If any other user passes a socket
31517 with an unprivileged port number, Exim prints a message on the standard error
31518 stream and exits with an error code.
31519
31520 By default, Exim does not make a log entry when a remote host connects or
31521 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
31522 unexpected. It can be made to write such log entries by setting the
31523 &%smtp_connection%& log selector.
31524
31525 .cindex "carriage return"
31526 .cindex "linefeed"
31527 Commands from the remote host are supposed to be terminated by CR followed by
31528 LF. However, there are known to be hosts that do not send CR characters. In
31529 order to be able to interwork with such hosts, Exim treats LF on its own as a
31530 line terminator.
31531 Furthermore, because common code is used for receiving messages from all
31532 sources, a CR on its own is also interpreted as a line terminator. However, the
31533 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
31534
31535 .cindex "EHLO" "invalid data"
31536 .cindex "HELO" "invalid data"
31537 One area that sometimes gives rise to problems concerns the EHLO or
31538 HELO commands. Some clients send syntactically invalid versions of these
31539 commands, which Exim rejects by default. (This is nothing to do with verifying
31540 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
31541 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
31542 match the broken hosts that send invalid commands.
31543
31544 .cindex "SIZE option on MAIL command"
31545 .cindex "MAIL" "SIZE option"
31546 The amount of disk space available is checked whenever SIZE is received on
31547 a MAIL command, independently of whether &%message_size_limit%& or
31548 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
31549 false. A temporary error is given if there is not enough space. If
31550 &%check_spool_space%& is set, the check is for that amount of space plus the
31551 value given with SIZE, that is, it checks that the addition of the incoming
31552 message will not reduce the space below the threshold.
31553
31554 When a message is successfully received, Exim includes the local message id in
31555 its response to the final &"."& that terminates the data. If the remote host
31556 logs this text it can help with tracing what has happened to a message.
31557
31558 The Exim daemon can limit the number of simultaneous incoming connections it is
31559 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
31560 number of simultaneous incoming connections from a single remote host (see the
31561 &%smtp_accept_max_per_host%& option). Additional connection attempts are
31562 rejected using the SMTP temporary error code 421.
31563
31564 The Exim daemon does not rely on the SIGCHLD signal to detect when a
31565 subprocess has finished, as this can get lost at busy times. Instead, it looks
31566 for completed subprocesses every time it wakes up. Provided there are other
31567 things happening (new incoming calls, starts of queue runs), completed
31568 processes will be noticed and tidied away. On very quiet systems you may
31569 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
31570 it will be noticed when the daemon next wakes up.
31571
31572 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
31573 and can also be set up to reject SMTP calls from non-reserved hosts at times of
31574 high system load &-- for details see the &%smtp_accept_reserve%&,
31575 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
31576 applies in both the daemon and &'inetd'& cases.
31577
31578 Exim normally starts a delivery process for each message received, though this
31579 can be varied by means of the &%-odq%& command line option and the
31580 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
31581 number of simultaneously running delivery processes started in this way from
31582 SMTP input can be limited by the &%smtp_accept_queue%& and
31583 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
31584 subsequently received messages are just put on the input queue without starting
31585 a delivery process.
31586
31587 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
31588 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
31589 started up from the &'inetd'& daemon, because in that case each connection is
31590 handled by an entirely independent Exim process. Control by load average is,
31591 however, available with &'inetd'&.
31592
31593 Exim can be configured to verify addresses in incoming SMTP commands as they
31594 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
31595 to rewrite addresses at this time &-- before any syntax checking is done. See
31596 section &<<SECTrewriteS>>&.
31597
31598 Exim can also be configured to limit the rate at which a client host submits
31599 MAIL and RCPT commands in a single SMTP session. See the
31600 &%smtp_ratelimit_hosts%& option.
31601
31602
31603
31604 .section "Unrecognized SMTP commands" "SECID234"
31605 .cindex "SMTP" "unrecognized commands"
31606 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
31607 commands during a single SMTP connection, it drops the connection after sending
31608 the error response to the last command. The default value for
31609 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
31610 abuse that subvert web servers into making connections to SMTP ports; in these
31611 circumstances, a number of non-SMTP lines are sent first.
31612
31613
31614 .section "Syntax and protocol errors in SMTP commands" "SECID235"
31615 .cindex "SMTP" "syntax errors"
31616 .cindex "SMTP" "protocol errors"
31617 A syntax error is detected if an SMTP command is recognized, but there is
31618 something syntactically wrong with its data, for example, a malformed email
31619 address in a RCPT command. Protocol errors include invalid command
31620 sequencing such as RCPT before MAIL. If Exim receives more than
31621 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
31622 drops the connection after sending the error response to the last command. The
31623 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
31624 broken clients that loop sending bad commands (yes, it has been seen).
31625
31626
31627
31628 .section "Use of non-mail SMTP commands" "SECID236"
31629 .cindex "SMTP" "non-mail commands"
31630 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
31631 DATA. Exim counts such commands, and drops the connection if there are too
31632 many of them in a single SMTP session. This action catches some
31633 denial-of-service attempts and things like repeated failing AUTHs, or a mad
31634 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
31635 defines what &"too many"& means. Its default value is 10.
31636
31637 When a new message is expected, one occurrence of RSET is not counted. This
31638 allows a client to send one RSET between messages (this is not necessary,
31639 but some clients do it). Exim also allows one uncounted occurrence of HELO
31640 or EHLO, and one occurrence of STARTTLS between messages. After
31641 starting up a TLS session, another EHLO is expected, and so it too is not
31642 counted.
31643
31644 The first occurrence of AUTH in a connection, or immediately following
31645 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
31646 RCPT, DATA, and QUIT are counted.
31647
31648 You can control which hosts are subject to the limit set by
31649 &%smtp_accept_max_nonmail%& by setting
31650 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
31651 the limit apply to all hosts. This option means that you can exclude any
31652 specific badly-behaved hosts that you have to live with.
31653
31654
31655
31656
31657 .section "The VRFY and EXPN commands" "SECID237"
31658 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
31659 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
31660 appropriate) in order to decide whether the command should be accepted or not.
31661 If no ACL is defined, the command is rejected.
31662
31663 .cindex "VRFY" "processing"
31664 When VRFY is accepted, it runs exactly the same code as when Exim is
31665 called with the &%-bv%& option.
31666
31667 .cindex "EXPN" "processing"
31668 When EXPN is accepted, a single-level expansion of the address is done.
31669 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
31670 than a verification (the &%-bv%& option). If an unqualified local part is given
31671 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
31672 of VRFY and EXPN commands are logged on the main and reject logs, and
31673 VRFY verification failures are logged on the main log for consistency with
31674 RCPT failures.
31675
31676
31677
31678 .section "The ETRN command" "SECTETRN"
31679 .cindex "ETRN" "processing"
31680 RFC 1985 describes an SMTP command called ETRN that is designed to
31681 overcome the security problems of the TURN command (which has fallen into
31682 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
31683 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
31684 should be accepted or not. If no ACL is defined, the command is rejected.
31685
31686 The ETRN command is concerned with &"releasing"& messages that are awaiting
31687 delivery to certain hosts. As Exim does not organize its message queue by host,
31688 the only form of ETRN that is supported by default is the one where the
31689 text starts with the &"#"& prefix, in which case the remainder of the text is
31690 specific to the SMTP server. A valid ETRN command causes a run of Exim with
31691 the &%-R%& option to happen, with the remainder of the ETRN text as its
31692 argument. For example,
31693 .code
31694 ETRN #brigadoon
31695 .endd
31696 runs the command
31697 .code
31698 exim -R brigadoon
31699 .endd
31700 which causes a delivery attempt on all messages with undelivered addresses
31701 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
31702 default), Exim prevents the simultaneous execution of more than one queue run
31703 for the same argument string as a result of an ETRN command. This stops
31704 a misbehaving client from starting more than one queue runner at once.
31705
31706 .cindex "hints database" "ETRN serialization"
31707 Exim implements the serialization by means of a hints database in which a
31708 record is written whenever a process is started by ETRN, and deleted when
31709 the process completes. However, Exim does not keep the SMTP session waiting for
31710 the ETRN process to complete. Once ETRN is accepted, the client is sent
31711 a &"success"& return code. Obviously there is scope for hints records to get
31712 left lying around if there is a system or program crash. To guard against this,
31713 Exim ignores any records that are more than six hours old.
31714
31715 .oindex "&%smtp_etrn_command%&"
31716 For more control over what ETRN does, the &%smtp_etrn_command%& option can
31717 used. This specifies a command that is run whenever ETRN is received,
31718 whatever the form of its argument. For
31719 example:
31720 .code
31721 smtp_etrn_command = /etc/etrn_command $domain \
31722                     $sender_host_address
31723 .endd
31724 .vindex "&$domain$&"
31725 The string is split up into arguments which are independently expanded. The
31726 expansion variable &$domain$& is set to the argument of the ETRN command,
31727 and no syntax checking is done on the contents of this argument. Exim does not
31728 wait for the command to complete, so its status code is not checked. Exim runs
31729 under its own uid and gid when receiving incoming SMTP, so it is not possible
31730 for it to change them before running the command.
31731
31732
31733
31734 .section "Incoming local SMTP" "SECID238"
31735 .cindex "SMTP" "local incoming"
31736 Some user agents use SMTP to pass messages to their local MTA using the
31737 standard input and output, as opposed to passing the envelope on the command
31738 line and writing the message to the standard input. This is supported by the
31739 &%-bs%& option. This form of SMTP is handled in the same way as incoming
31740 messages over TCP/IP (including the use of ACLs), except that the envelope
31741 sender given in a MAIL command is ignored unless the caller is trusted. In
31742 an ACL you can detect this form of SMTP input by testing for an empty host
31743 identification. It is common to have this as the first line in the ACL that
31744 runs for RCPT commands:
31745 .code
31746 accept hosts = :
31747 .endd
31748 This accepts SMTP messages from local processes without doing any other tests.
31749
31750
31751
31752 .section "Outgoing batched SMTP" "SECTbatchSMTP"
31753 .cindex "SMTP" "batched outgoing"
31754 .cindex "batched SMTP output"
31755 Both the &(appendfile)& and &(pipe)& transports can be used for handling
31756 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
31757 be output in BSMTP format. No SMTP responses are possible for this form of
31758 delivery. All it is doing is using SMTP commands as a way of transmitting the
31759 envelope along with the message.
31760
31761 The message is written to the file or pipe preceded by the SMTP commands
31762 MAIL and RCPT, and followed by a line containing a single dot. Lines in
31763 the message that start with a dot have an extra dot added. The SMTP command
31764 HELO is not normally used. If it is required, the &%message_prefix%& option
31765 can be used to specify it.
31766
31767 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
31768 one recipient address at a time by default. However, you can arrange for them
31769 to handle several addresses at once by setting the &%batch_max%& option. When
31770 this is done for BSMTP, messages may contain multiple RCPT commands. See
31771 chapter &<<CHAPbatching>>& for more details.
31772
31773 .vindex "&$host$&"
31774 When one or more addresses are routed to a BSMTP transport by a router that
31775 sets up a host list, the name of the first host on the list is available to the
31776 transport in the variable &$host$&. Here is an example of such a transport and
31777 router:
31778 .code
31779 begin routers
31780 route_append:
31781   driver = manualroute
31782   transport = smtp_appendfile
31783   route_list = domain.example  batch.host.example
31784
31785 begin transports
31786 smtp_appendfile:
31787   driver = appendfile
31788   directory = /var/bsmtp/$host
31789   batch_max = 1000
31790   use_bsmtp
31791   user = exim
31792 .endd
31793 This causes messages addressed to &'domain.example'& to be written in BSMTP
31794 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
31795 message (unless there are more than 1000 recipients).
31796
31797
31798
31799 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
31800 .cindex "SMTP" "batched incoming"
31801 .cindex "batched SMTP input"
31802 The &%-bS%& command line option causes Exim to accept one or more messages by
31803 reading SMTP on the standard input, but to generate no responses. If the caller
31804 is trusted, the senders in the MAIL commands are believed; otherwise the
31805 sender is always the caller of Exim. Unqualified senders and receivers are not
31806 rejected (there seems little point) but instead just get qualified. HELO
31807 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
31808 as NOOP; QUIT quits.
31809
31810 Minimal policy checking is done for BSMTP input. Only the non-SMTP
31811 ACL is run in the same way as for non-SMTP local input.
31812
31813 If an error is detected while reading a message, including a missing &"."& at
31814 the end, Exim gives up immediately. It writes details of the error to the
31815 standard output in a stylized way that the calling program should be able to
31816 make some use of automatically, for example:
31817 .code
31818 554 Unexpected end of file
31819 Transaction started in line 10
31820 Error detected in line 14
31821 .endd
31822 It writes a more verbose version, for human consumption, to the standard error
31823 file, for example:
31824 .code
31825 An error was detected while processing a file of BSMTP input.
31826 The error message was:
31827
31828 501 '>' missing at end of address
31829
31830 The SMTP transaction started in line 10.
31831 The error was detected in line 12.
31832 The SMTP command at fault was:
31833
31834 rcpt to:<malformed@in.com.plete
31835
31836 1 previous message was successfully processed.
31837 The rest of the batch was abandoned.
31838 .endd
31839 The return code from Exim is zero only if there were no errors. It is 1 if some
31840 messages were accepted before an error was detected, and 2 if no messages were
31841 accepted.
31842 .ecindex IIDsmtpproc1
31843 .ecindex IIDsmtpproc2
31844
31845
31846
31847 . ////////////////////////////////////////////////////////////////////////////
31848 . ////////////////////////////////////////////////////////////////////////////
31849
31850 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
31851          "Customizing messages"
31852 When a message fails to be delivered, or remains on the queue for more than a
31853 configured amount of time, Exim sends a message to the original sender, or
31854 to an alternative configured address. The text of these messages is built into
31855 the code of Exim, but it is possible to change it, either by adding a single
31856 string, or by replacing each of the paragraphs by text supplied in a file.
31857
31858 The &'From:'& and &'To:'& header lines are automatically generated; you can
31859 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
31860 option. Exim also adds the line
31861 .code
31862 Auto-Submitted: auto-generated
31863 .endd
31864 to all warning and bounce messages,
31865
31866
31867 .section "Customizing bounce messages" "SECID239"
31868 .cindex "customizing" "bounce message"
31869 .cindex "bounce message" "customizing"
31870 If &%bounce_message_text%& is set, its contents are included in the default
31871 message immediately after &"This message was created automatically by mail
31872 delivery software."& The string is not expanded. It is not used if
31873 &%bounce_message_file%& is set.
31874
31875 When &%bounce_message_file%& is set, it must point to a template file for
31876 constructing error messages. The file consists of a series of text items,
31877 separated by lines consisting of exactly four asterisks. If the file cannot be
31878 opened, default text is used and a message is written to the main and panic
31879 logs. If any text item in the file is empty, default text is used for that
31880 item.
31881
31882 .vindex "&$bounce_recipient$&"
31883 .vindex "&$bounce_return_size_limit$&"
31884 Each item of text that is read from the file is expanded, and there are two
31885 expansion variables which can be of use here: &$bounce_recipient$& is set to
31886 the recipient of an error message while it is being created, and
31887 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
31888 option, rounded to a whole number.
31889
31890 The items must appear in the file in the following order:
31891
31892 .ilist
31893 The first item is included in the headers, and should include at least a
31894 &'Subject:'& header. Exim does not check the syntax of these headers.
31895 .next
31896 The second item forms the start of the error message. After it, Exim lists the
31897 failing addresses with their error messages.
31898 .next
31899 The third item is used to introduce any text from pipe transports that is to be
31900 returned to the sender. It is omitted if there is no such text.
31901 .next
31902 The fourth item is used to introduce the copy of the message that is returned
31903 as part of the error report.
31904 .next
31905 The fifth item is added after the fourth one if the returned message is
31906 truncated because it is bigger than &%return_size_limit%&.
31907 .next
31908 The sixth item is added after the copy of the original message.
31909 .endlist
31910
31911 The default state (&%bounce_message_file%& unset) is equivalent to the
31912 following file, in which the sixth item is empty. The &'Subject:'& and some
31913 other lines have been split in order to fit them on the page:
31914 .code
31915 Subject: Mail delivery failed
31916   ${if eq{$sender_address}{$bounce_recipient}
31917   {: returning message to sender}}
31918 ****
31919 This message was created automatically by mail delivery software.
31920
31921 A message ${if eq{$sender_address}{$bounce_recipient}
31922   {that you sent }{sent by
31923
31924 <$sender_address>
31925
31926 }}could not be delivered to all of its recipients.
31927 This is a permanent error. The following address(es) failed:
31928 ****
31929 The following text was generated during the delivery attempt(s):
31930 ****
31931 ------ This is a copy of the message, including all the headers.
31932   ------
31933 ****
31934 ------ The body of the message is $message_size characters long;
31935   only the first
31936 ------ $bounce_return_size_limit or so are included here.
31937 ****
31938 .endd
31939 .section "Customizing warning messages" "SECTcustwarn"
31940 .cindex "customizing" "warning message"
31941 .cindex "warning of delay" "customizing the message"
31942 The option &%warn_message_file%& can be pointed at a template file for use when
31943 warnings about message delays are created. In this case there are only three
31944 text sections:
31945
31946 .ilist
31947 The first item is included in the headers, and should include at least a
31948 &'Subject:'& header. Exim does not check the syntax of these headers.
31949 .next
31950 The second item forms the start of the warning message. After it, Exim lists
31951 the delayed addresses.
31952 .next
31953 The third item then ends the message.
31954 .endlist
31955
31956 The default state is equivalent to the following file, except that some lines
31957 have been split here, in order to fit them on the page:
31958 .code
31959 Subject: Warning: message $message_exim_id delayed
31960   $warn_message_delay
31961 ****
31962 This message was created automatically by mail delivery software.
31963
31964 A message ${if eq{$sender_address}{$warn_message_recipients}
31965 {that you sent }{sent by
31966
31967 <$sender_address>
31968
31969 }}has not been delivered to all of its recipients after
31970 more than $warn_message_delay on the queue on $primary_hostname.
31971
31972 The message identifier is:     $message_exim_id
31973 The subject of the message is: $h_subject
31974 The date of the message is:    $h_date
31975
31976 The following address(es) have not yet been delivered:
31977 ****
31978 No action is required on your part. Delivery attempts will
31979 continue for some time, and this warning may be repeated at
31980 intervals if the message remains undelivered. Eventually the
31981 mail delivery software will give up, and when that happens,
31982 the message will be returned to you.
31983 .endd
31984 .vindex "&$warn_message_delay$&"
31985 .vindex "&$warn_message_recipients$&"
31986 However, in the default state the subject and date lines are omitted if no
31987 appropriate headers exist. During the expansion of this file,
31988 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
31989 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
31990 of recipients for the warning message. There may be more than one if there are
31991 multiple addresses with different &%errors_to%& settings on the routers that
31992 handled them.
31993
31994
31995
31996
31997 . ////////////////////////////////////////////////////////////////////////////
31998 . ////////////////////////////////////////////////////////////////////////////
31999
32000 .chapter "Some common configuration settings" "CHAPcomconreq"
32001 This chapter discusses some configuration settings that seem to be fairly
32002 common. More examples and discussion can be found in the Exim book.
32003
32004
32005
32006 .section "Sending mail to a smart host" "SECID240"
32007 .cindex "smart host" "example router"
32008 If you want to send all mail for non-local domains to a &"smart host"&, you
32009 should replace the default &(dnslookup)& router with a router which does the
32010 routing explicitly:
32011 .code
32012 send_to_smart_host:
32013   driver = manualroute
32014   route_list = !+local_domains smart.host.name
32015   transport = remote_smtp
32016 .endd
32017 You can use the smart host's IP address instead of the name if you wish.
32018 If you are using Exim only to submit messages to a smart host, and not for
32019 receiving incoming messages, you can arrange for it to do the submission
32020 synchronously by setting the &%mua_wrapper%& option (see chapter
32021 &<<CHAPnonqueueing>>&).
32022
32023
32024
32025
32026 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32027 .cindex "mailing lists"
32028 Exim can be used to run simple mailing lists, but for large and/or complicated
32029 requirements, the use of additional specialized mailing list software such as
32030 Majordomo or Mailman is recommended.
32031
32032 The &(redirect)& router can be used to handle mailing lists where each list
32033 is maintained in a separate file, which can therefore be managed by an
32034 independent manager. The &%domains%& router option can be used to run these
32035 lists in a separate domain from normal mail. For example:
32036 .code
32037 lists:
32038   driver = redirect
32039   domains = lists.example
32040   file = /usr/lists/$local_part
32041   forbid_pipe
32042   forbid_file
32043   errors_to = $local_part-request@lists.example
32044   no_more
32045 .endd
32046 This router is skipped for domains other than &'lists.example'&. For addresses
32047 in that domain, it looks for a file that matches the local part. If there is no
32048 such file, the router declines, but because &%no_more%& is set, no subsequent
32049 routers are tried, and so the whole delivery fails.
32050
32051 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32052 expanded into a file name or a pipe delivery, which is usually inappropriate in
32053 a mailing list.
32054
32055 .oindex "&%errors_to%&"
32056 The &%errors_to%& option specifies that any delivery errors caused by addresses
32057 taken from a mailing list are to be sent to the given address rather than the
32058 original sender of the message. However, before acting on this, Exim verifies
32059 the error address, and ignores it if verification fails.
32060
32061 For example, using the configuration above, mail sent to
32062 &'dicts@lists.example'& is passed on to those addresses contained in
32063 &_/usr/lists/dicts_&, with error reports directed to
32064 &'dicts-request@lists.example'&, provided that this address can be verified.
32065 There could be a file called &_/usr/lists/dicts-request_& containing
32066 the address(es) of this particular list's manager(s), but other approaches,
32067 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32068 or &%local_part_suffix%& options) to handle addresses of the form
32069 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32070
32071
32072
32073 .section "Syntax errors in mailing lists" "SECID241"
32074 .cindex "mailing lists" "syntax errors in"
32075 If an entry in redirection data contains a syntax error, Exim normally defers
32076 delivery of the original address. That means that a syntax error in a mailing
32077 list holds up all deliveries to the list. This may not be appropriate when a
32078 list is being maintained automatically from data supplied by users, and the
32079 addresses are not rigorously checked.
32080
32081 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
32082 entries that fail to parse, noting the incident in the log. If in addition
32083 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
32084 whenever a broken address is skipped. It is usually appropriate to set
32085 &%syntax_errors_to%& to the same address as &%errors_to%&.
32086
32087
32088
32089 .section "Re-expansion of mailing lists" "SECID242"
32090 .cindex "mailing lists" "re-expansion of"
32091 Exim remembers every individual address to which a message has been delivered,
32092 in order to avoid duplication, but it normally stores only the original
32093 recipient addresses with a message. If all the deliveries to a mailing list
32094 cannot be done at the first attempt, the mailing list is re-expanded when the
32095 delivery is next tried. This means that alterations to the list are taken into
32096 account at each delivery attempt, so addresses that have been added to
32097 the list since the message arrived will therefore receive a copy of the
32098 message, even though it pre-dates their subscription.
32099
32100 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
32101 on the &(redirect)& router. If this is done, any addresses generated by the
32102 router that fail to deliver at the first attempt are added to the message as
32103 &"top level"& addresses, and the parent address that generated them is marked
32104 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
32105 subsequent delivery attempts. The disadvantage of this is that if any of the
32106 failing addresses are incorrect, correcting them in the file has no effect on
32107 pre-existing messages.
32108
32109 The original top-level address is remembered with each of the generated
32110 addresses, and is output in any log messages. However, any intermediate parent
32111 addresses are not recorded. This makes a difference to the log only if the
32112 &%all_parents%& selector is set, but for mailing lists there is normally only
32113 one level of expansion anyway.
32114
32115
32116
32117 .section "Closed mailing lists" "SECID243"
32118 .cindex "mailing lists" "closed"
32119 The examples so far have assumed open mailing lists, to which anybody may
32120 send mail. It is also possible to set up closed lists, where mail is accepted
32121 from specified senders only. This is done by making use of the generic
32122 &%senders%& option to restrict the router that handles the list.
32123
32124 The following example uses the same file as a list of recipients and as a list
32125 of permitted senders. It requires three routers:
32126 .code
32127 lists_request:
32128   driver = redirect
32129   domains = lists.example
32130   local_part_suffix = -request
32131   file = /usr/lists/$local_part$local_part_suffix
32132   no_more
32133
32134 lists_post:
32135   driver = redirect
32136   domains = lists.example
32137   senders = ${if exists {/usr/lists/$local_part}\
32138              {lsearch;/usr/lists/$local_part}{*}}
32139   file = /usr/lists/$local_part
32140   forbid_pipe
32141   forbid_file
32142   errors_to = $local_part-request@lists.example
32143   no_more
32144
32145 lists_closed:
32146   driver = redirect
32147   domains = lists.example
32148   allow_fail
32149   data = :fail: $local_part@lists.example is a closed mailing list
32150 .endd
32151 All three routers have the same &%domains%& setting, so for any other domains,
32152 they are all skipped. The first router runs only if the local part ends in
32153 &%-request%&. It handles messages to the list manager(s) by means of an open
32154 mailing list.
32155
32156 The second router runs only if the &%senders%& precondition is satisfied. It
32157 checks for the existence of a list that corresponds to the local part, and then
32158 checks that the sender is on the list by means of a linear search. It is
32159 necessary to check for the existence of the file before trying to search it,
32160 because otherwise Exim thinks there is a configuration error. If the file does
32161 not exist, the expansion of &%senders%& is *, which matches all senders. This
32162 means that the router runs, but because there is no list, declines, and
32163 &%no_more%& ensures that no further routers are run. The address fails with an
32164 &"unrouteable address"& error.
32165
32166 The third router runs only if the second router is skipped, which happens when
32167 a mailing list exists, but the sender is not on it. This router forcibly fails
32168 the address, giving a suitable error message.
32169
32170
32171
32172
32173 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
32174 .cindex "VERP"
32175 .cindex "Variable Envelope Return Paths"
32176 .cindex "envelope sender"
32177 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
32178 are a way of helping mailing list administrators discover which subscription
32179 address is the cause of a particular delivery failure. The idea is to encode
32180 the original recipient address in the outgoing envelope sender address, so that
32181 if the message is forwarded by another host and then subsequently bounces, the
32182 original recipient can be extracted from the recipient address of the bounce.
32183
32184 .oindex &%errors_to%&
32185 .oindex &%return_path%&
32186 Envelope sender addresses can be modified by Exim using two different
32187 facilities: the &%errors_to%& option on a router (as shown in previous mailing
32188 list examples), or the &%return_path%& option on a transport. The second of
32189 these is effective only if the message is successfully delivered to another
32190 host; it is not used for errors detected on the local host (see the description
32191 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
32192 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
32193 .code
32194 verp_smtp:
32195   driver = smtp
32196   max_rcpt = 1
32197   return_path = \
32198     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32199       {$1-request+$local_part=$domain@your.dom.example}fail}
32200 .endd
32201 This has the effect of rewriting the return path (envelope sender) on outgoing
32202 SMTP messages, if the local part of the original return path ends in
32203 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
32204 local part and domain of the recipient into the return path. Suppose, for
32205 example, that a message whose return path has been set to
32206 &'somelist-request@your.dom.example'& is sent to
32207 &'subscriber@other.dom.example'&. In the transport, the return path is
32208 rewritten as
32209 .code
32210 somelist-request+subscriber=other.dom.example@your.dom.example
32211 .endd
32212 .vindex "&$local_part$&"
32213 For this to work, you must tell Exim to send multiple copies of messages that
32214 have more than one recipient, so that each copy has just one recipient. This is
32215 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
32216 might be sent to several different recipients in the same domain, in which case
32217 &$local_part$& is not available in the transport, because it is not unique.
32218
32219 Unless your host is doing nothing but mailing list deliveries, you should
32220 probably use a separate transport for the VERP deliveries, so as not to use
32221 extra resources in making one-per-recipient copies for other deliveries. This
32222 can easily be done by expanding the &%transport%& option in the router:
32223 .code
32224 dnslookup:
32225   driver = dnslookup
32226   domains = ! +local_domains
32227   transport = \
32228     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32229       {verp_smtp}{remote_smtp}}
32230   no_more
32231 .endd
32232 If you want to change the return path using &%errors_to%& in a router instead
32233 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
32234 routers that handle mailing list addresses. This will ensure that all delivery
32235 errors, including those detected on the local host, are sent to the VERP
32236 address.
32237
32238 On a host that does no local deliveries and has no manual routing, only the
32239 &(dnslookup)& router needs to be changed. A special transport is not needed for
32240 SMTP deliveries. Every mailing list recipient has its own return path value,
32241 and so Exim must hand them to the transport one at a time. Here is an example
32242 of a &(dnslookup)& router that implements VERP:
32243 .code
32244 verp_dnslookup:
32245   driver = dnslookup
32246   domains = ! +local_domains
32247   transport = remote_smtp
32248   errors_to = \
32249     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
32250      {$1-request+$local_part=$domain@your.dom.example}fail}
32251   no_more
32252 .endd
32253 Before you start sending out messages with VERPed return paths, you must also
32254 configure Exim to accept the bounce messages that come back to those paths.
32255 Typically this is done by setting a &%local_part_suffix%& option for a
32256 router, and using this to route the messages to wherever you want to handle
32257 them.
32258
32259 The overhead incurred in using VERP depends very much on the size of the
32260 message, the number of recipient addresses that resolve to the same remote
32261 host, and the speed of the connection over which the message is being sent. If
32262 a lot of addresses resolve to the same host and the connection is slow, sending
32263 a separate copy of the message for each address may take substantially longer
32264 than sending a single copy with many recipients (for which VERP cannot be
32265 used).
32266
32267
32268
32269
32270
32271
32272 .section "Virtual domains" "SECTvirtualdomains"
32273 .cindex "virtual domains"
32274 .cindex "domain" "virtual"
32275 The phrase &'virtual domain'& is unfortunately used with two rather different
32276 meanings:
32277
32278 .ilist
32279 A domain for which there are no real mailboxes; all valid local parts are
32280 aliases for other email addresses. Common examples are organizational
32281 top-level domains and &"vanity"& domains.
32282 .next
32283 One of a number of independent domains that are all handled by the same host,
32284 with mailboxes on that host, but where the mailbox owners do not necessarily
32285 have login accounts on that host.
32286 .endlist
32287
32288 The first usage is probably more common, and does seem more &"virtual"& than
32289 the second. This kind of domain can be handled in Exim with a straightforward
32290 aliasing router. One approach is to create a separate alias file for each
32291 virtual domain. Exim can test for the existence of the alias file to determine
32292 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
32293 to a router of this form:
32294 .code
32295 virtual:
32296   driver = redirect
32297   domains = dsearch;/etc/mail/virtual
32298   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
32299   no_more
32300 .endd
32301 The &%domains%& option specifies that the router is to be skipped, unless there
32302 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
32303 domain that is being processed. When the router runs, it looks up the local
32304 part in the file to find a new address (or list of addresses). The &%no_more%&
32305 setting ensures that if the lookup fails (leading to &%data%& being an empty
32306 string), Exim gives up on the address without trying any subsequent routers.
32307
32308 This one router can handle all the virtual domains because the alias file names
32309 follow a fixed pattern. Permissions can be arranged so that appropriate people
32310 can edit the different alias files. A successful aliasing operation results in
32311 a new envelope recipient address, which is then routed from scratch.
32312
32313 The other kind of &"virtual"& domain can also be handled in a straightforward
32314 way. One approach is to create a file for each domain containing a list of
32315 valid local parts, and use it in a router like this:
32316 .code
32317 my_domains:
32318   driver = accept
32319   domains = dsearch;/etc/mail/domains
32320   local_parts = lsearch;/etc/mail/domains/$domain
32321   transport = my_mailboxes
32322 .endd
32323 The address is accepted if there is a file for the domain, and the local part
32324 can be found in the file. The &%domains%& option is used to check for the
32325 file's existence because &%domains%& is tested before the &%local_parts%&
32326 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
32327 because that option is tested after &%local_parts%&. The transport is as
32328 follows:
32329 .code
32330 my_mailboxes:
32331   driver = appendfile
32332   file = /var/mail/$domain/$local_part
32333   user = mail
32334 .endd
32335 This uses a directory of mailboxes for each domain. The &%user%& setting is
32336 required, to specify which uid is to be used for writing to the mailboxes.
32337
32338 The configuration shown here is just one example of how you might support this
32339 requirement. There are many other ways this kind of configuration can be set
32340 up, for example, by using a database instead of separate files to hold all the
32341 information about the domains.
32342
32343
32344
32345 .section "Multiple user mailboxes" "SECTmulbox"
32346 .cindex "multiple mailboxes"
32347 .cindex "mailbox" "multiple"
32348 .cindex "local part" "prefix"
32349 .cindex "local part" "suffix"
32350 Heavy email users often want to operate with multiple mailboxes, into which
32351 incoming mail is automatically sorted. A popular way of handling this is to
32352 allow users to use multiple sender addresses, so that replies can easily be
32353 identified. Users are permitted to add prefixes or suffixes to their local
32354 parts for this purpose. The wildcard facility of the generic router options
32355 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
32356 example, consider this router:
32357 .code
32358 userforward:
32359   driver = redirect
32360   check_local_user
32361   file = $home/.forward
32362   local_part_suffix = -*
32363   local_part_suffix_optional
32364   allow_filter
32365 .endd
32366 .vindex "&$local_part_suffix$&"
32367 It runs a user's &_.forward_& file for all local parts of the form
32368 &'username-*'&. Within the filter file the user can distinguish different
32369 cases by testing the variable &$local_part_suffix$&. For example:
32370 .code
32371 if $local_part_suffix contains -special then
32372 save /home/$local_part/Mail/special
32373 endif
32374 .endd
32375 If the filter file does not exist, or does not deal with such addresses, they
32376 fall through to subsequent routers, and, assuming no subsequent use of the
32377 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
32378 control over which suffixes are valid.
32379
32380 Alternatively, a suffix can be used to trigger the use of a different
32381 &_.forward_& file &-- which is the way a similar facility is implemented in
32382 another MTA:
32383 .code
32384 userforward:
32385   driver = redirect
32386   check_local_user
32387   file = $home/.forward$local_part_suffix
32388   local_part_suffix = -*
32389   local_part_suffix_optional
32390   allow_filter
32391 .endd
32392 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
32393 example, &_.forward-special_& is used. Once again, if the appropriate file
32394 does not exist, or does not deal with the address, it is passed on to
32395 subsequent routers, which could, if required, look for an unqualified
32396 &_.forward_& file to use as a default.
32397
32398
32399
32400 .section "Simplified vacation processing" "SECID244"
32401 .cindex "vacation processing"
32402 The traditional way of running the &'vacation'& program is for a user to set up
32403 a pipe command in a &_.forward_& file
32404 (see section &<<SECTspecitredli>>& for syntax details).
32405 This is prone to error by inexperienced users. There are two features of Exim
32406 that can be used to make this process simpler for users:
32407
32408 .ilist
32409 A local part prefix such as &"vacation-"& can be specified on a router which
32410 can cause the message to be delivered directly to the &'vacation'& program, or
32411 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
32412 &_.forward_& file are then much simpler. For example:
32413 .code
32414 spqr, vacation-spqr
32415 .endd
32416 .next
32417 The &%require_files%& generic router option can be used to trigger a
32418 vacation delivery by checking for the existence of a certain file in the
32419 user's home directory. The &%unseen%& generic option should also be used, to
32420 ensure that the original delivery also proceeds. In this case, all the user has
32421 to do is to create a file called, say, &_.vacation_&, containing a vacation
32422 message.
32423 .endlist
32424
32425 Another advantage of both these methods is that they both work even when the
32426 use of arbitrary pipes by users is locked out.
32427
32428
32429
32430 .section "Taking copies of mail" "SECID245"
32431 .cindex "message" "copying every"
32432 Some installations have policies that require archive copies of all messages to
32433 be made. A single copy of each message can easily be taken by an appropriate
32434 command in a system filter, which could, for example, use a different file for
32435 each day's messages.
32436
32437 There is also a shadow transport mechanism that can be used to take copies of
32438 messages that are successfully delivered by local transports, one copy per
32439 delivery. This could be used, &'inter alia'&, to implement automatic
32440 notification of delivery by sites that insist on doing such things.
32441
32442
32443
32444 .section "Intermittently connected hosts" "SECID246"
32445 .cindex "intermittently connected hosts"
32446 It has become quite common (because it is cheaper) for hosts to connect to the
32447 Internet periodically rather than remain connected all the time. The normal
32448 arrangement is that mail for such hosts accumulates on a system that is
32449 permanently connected.
32450
32451 Exim was designed for use on permanently connected hosts, and so it is not
32452 particularly well-suited to use in an intermittently connected environment.
32453 Nevertheless there are some features that can be used.
32454
32455
32456 .section "Exim on the upstream server host" "SECID247"
32457 It is tempting to arrange for incoming mail for the intermittently connected
32458 host to remain on Exim's queue until the client connects. However, this
32459 approach does not scale very well. Two different kinds of waiting message are
32460 being mixed up in the same queue &-- those that cannot be delivered because of
32461 some temporary problem, and those that are waiting for their destination host
32462 to connect. This makes it hard to manage the queue, as well as wasting
32463 resources, because each queue runner scans the entire queue.
32464
32465 A better approach is to separate off those messages that are waiting for an
32466 intermittently connected host. This can be done by delivering these messages
32467 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
32468 format, from where they are transmitted by other software when their
32469 destination connects. This makes it easy to collect all the mail for one host
32470 in a single directory, and to apply local timeout rules on a per-message basis
32471 if required.
32472
32473 On a very small scale, leaving the mail on Exim's queue can be made to work. If
32474 you are doing this, you should configure Exim with a long retry period for the
32475 intermittent host. For example:
32476 .code
32477 cheshire.wonderland.fict.example    *   F,5d,24h
32478 .endd
32479 This stops a lot of failed delivery attempts from occurring, but Exim remembers
32480 which messages it has queued up for that host. Once the intermittent host comes
32481 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
32482 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
32483 causes all the queued up messages to be delivered, often down a single SMTP
32484 connection. While the host remains connected, any new messages get delivered
32485 immediately.
32486
32487 If the connecting hosts do not have fixed IP addresses, that is, if a host is
32488 issued with a different IP address each time it connects, Exim's retry
32489 mechanisms on the holding host get confused, because the IP address is normally
32490 used as part of the key string for holding retry information. This can be
32491 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
32492 Since this has disadvantages for permanently connected hosts, it is best to
32493 arrange a separate transport for the intermittently connected ones.
32494
32495
32496
32497 .section "Exim on the intermittently connected client host" "SECID248"
32498 The value of &%smtp_accept_queue_per_connection%& should probably be
32499 increased, or even set to zero (that is, disabled) on the intermittently
32500 connected host, so that all incoming messages down a single connection get
32501 delivered immediately.
32502
32503 .cindex "SMTP" "passed connection"
32504 .cindex "SMTP" "multiple deliveries"
32505 .cindex "multiple SMTP deliveries"
32506 Mail waiting to be sent from an intermittently connected host will probably
32507 not have been routed, because without a connection DNS lookups are not
32508 possible. This means that if a normal queue run is done at connection time,
32509 each message is likely to be sent in a separate SMTP session. This can be
32510 avoided by starting the queue run with a command line option beginning with
32511 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
32512 first pass, routing is done but no deliveries take place. The second pass is a
32513 normal queue run; since all the messages have been previously routed, those
32514 destined for the same host are likely to get sent as multiple deliveries in a
32515 single SMTP connection.
32516
32517
32518
32519 . ////////////////////////////////////////////////////////////////////////////
32520 . ////////////////////////////////////////////////////////////////////////////
32521
32522 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
32523          "Exim as a non-queueing client"
32524 .cindex "client, non-queueing"
32525 .cindex "smart host" "suppressing queueing"
32526 On a personal computer, it is a common requirement for all
32527 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
32528 configured to operate that way, for all the popular operating systems.
32529 However, there are some MUAs for Unix-like systems that cannot be so
32530 configured: they submit messages using the command line interface of
32531 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
32532 messages this way.
32533
32534 If the personal computer runs continuously, there is no problem, because it can
32535 run a conventional MTA that handles delivery to the smart host, and deal with
32536 any delays via its queueing mechanism. However, if the computer does not run
32537 continuously or runs different operating systems at different times, queueing
32538 email is not desirable.
32539
32540 There is therefore a requirement for something that can provide the
32541 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
32542 any queueing or retrying facilities. Furthermore, the delivery to the smart
32543 host should be synchronous, so that if it fails, the sending MUA is immediately
32544 informed. In other words, we want something that extends an MUA that submits
32545 to a local MTA via the command line so that it behaves like one that submits
32546 to a remote smart host using TCP/SMTP.
32547
32548 There are a number of applications (for example, there is one called &'ssmtp'&)
32549 that do this job. However, people have found them to be lacking in various
32550 ways. For instance, you might want to allow aliasing and forwarding to be done
32551 before sending a message to the smart host.
32552
32553 Exim already had the necessary infrastructure for doing this job. Just a few
32554 tweaks were needed to make it behave as required, though it is somewhat of an
32555 overkill to use a fully-featured MTA for this purpose.
32556
32557 .oindex "&%mua_wrapper%&"
32558 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
32559 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
32560 assumes that it is being used to &"wrap"& a command-line MUA in the manner
32561 just described. As well as setting &%mua_wrapper%&, you also need to provide a
32562 compatible router and transport configuration. Typically there will be just one
32563 router and one transport, sending everything to a smart host.
32564
32565 When run in MUA wrapping mode, the behaviour of Exim changes in the
32566 following ways:
32567
32568 .ilist
32569 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
32570 In other words, the only way to submit messages is via the command line.
32571 .next
32572 Each message is synchronously delivered as soon as it is received (&%-odi%& is
32573 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
32574 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
32575 does not finish until the delivery attempt is complete. If the delivery is
32576 successful, a zero return code is given.
32577 .next
32578 Address redirection is permitted, but the final routing for all addresses must
32579 be to the same remote transport, and to the same list of hosts. Furthermore,
32580 the return address (envelope sender) must be the same for all recipients, as
32581 must any added or deleted header lines. In other words, it must be possible to
32582 deliver the message in a single SMTP transaction, however many recipients there
32583 are.
32584 .next
32585 If these conditions are not met, or if routing any address results in a
32586 failure or defer status, or if Exim is unable to deliver all the recipients
32587 successfully to one of the smart hosts, delivery of the entire message fails.
32588 .next
32589 Because no queueing is allowed, all failures are treated as permanent; there
32590 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
32591 smart host. Furthermore, because only a single yes/no response can be given to
32592 the caller, it is not possible to deliver to some recipients and not others. If
32593 there is an error (temporary or permanent) for any recipient, all are failed.
32594 .next
32595 If more than one smart host is listed, Exim will try another host after a
32596 connection failure or a timeout, in the normal way. However, if this kind of
32597 failure happens for all the hosts, the delivery fails.
32598 .next
32599 When delivery fails, an error message is written to the standard error stream
32600 (as well as to Exim's log), and Exim exits to the caller with a return code
32601 value 1. The message is expunged from Exim's spool files. No bounce messages
32602 are ever generated.
32603 .next
32604 No retry data is maintained, and any retry rules are ignored.
32605 .next
32606 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
32607 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
32608 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
32609 .endlist
32610
32611 The overall effect is that Exim makes a single synchronous attempt to deliver
32612 the message, failing if there is any kind of problem. Because no local
32613 deliveries are done and no daemon can be run, Exim does not need root
32614 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
32615 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
32616 the advantages and disadvantages of running without root privilege.
32617
32618
32619
32620
32621 . ////////////////////////////////////////////////////////////////////////////
32622 . ////////////////////////////////////////////////////////////////////////////
32623
32624 .chapter "Log files" "CHAPlog"
32625 .scindex IIDloggen "log" "general description"
32626 .cindex "log" "types of"
32627 Exim writes three different logs, referred to as the main log, the reject log,
32628 and the panic log:
32629
32630 .ilist
32631 .cindex "main log"
32632 The main log records the arrival of each message and each delivery in a single
32633 line in each case. The format is as compact as possible, in an attempt to keep
32634 down the size of log files. Two-character flag sequences make it easy to pick
32635 out these lines. A number of other events are recorded in the main log. Some of
32636 them are optional, in which case the &%log_selector%& option controls whether
32637 they are included or not. A Perl script called &'eximstats'&, which does simple
32638 analysis of main log files, is provided in the Exim distribution (see section
32639 &<<SECTmailstat>>&).
32640 .next
32641 .cindex "reject log"
32642 The reject log records information from messages that are rejected as a result
32643 of a configuration option (that is, for policy reasons).
32644 The first line of each rejection is a copy of the line that is also written to
32645 the main log. Then, if the message's header has been read at the time the log
32646 is written, its contents are written to this log. Only the original header
32647 lines are available; header lines added by ACLs are not logged. You can use the
32648 reject log to check that your policy controls are working correctly; on a busy
32649 host this may be easier than scanning the main log for rejection messages. You
32650 can suppress the writing of the reject log by setting &%write_rejectlog%&
32651 false.
32652 .next
32653 .cindex "panic log"
32654 .cindex "system log"
32655 When certain serious errors occur, Exim writes entries to its panic log. If the
32656 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
32657 are usually written to the main log as well, but can get lost amid the mass of
32658 other entries. The panic log should be empty under normal circumstances. It is
32659 therefore a good idea to check it (or to have a &'cron'& script check it)
32660 regularly, in order to become aware of any problems. When Exim cannot open its
32661 panic log, it tries as a last resort to write to the system log (syslog). This
32662 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
32663 message itself is written at priority LOG_CRIT.
32664 .endlist
32665
32666 Every log line starts with a timestamp, in the format shown in the following
32667 example. Note that many of the examples shown in this chapter are line-wrapped.
32668 In the log file, this would be all on one line:
32669 .code
32670 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
32671   by QUIT
32672 .endd
32673 By default, the timestamps are in the local timezone. There are two
32674 ways of changing this:
32675
32676 .ilist
32677 You can set the &%timezone%& option to a different time zone; in particular, if
32678 you set
32679 .code
32680 timezone = UTC
32681 .endd
32682 the timestamps will be in UTC (aka GMT).
32683 .next
32684 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
32685 example:
32686 .code
32687 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
32688 .endd
32689 .endlist
32690
32691 .cindex "log" "process ids in"
32692 .cindex "pid (process id)" "in log lines"
32693 Exim does not include its process id in log lines by default, but you can
32694 request that it does so by specifying the &`pid`& log selector (see section
32695 &<<SECTlogselector>>&). When this is set, the process id is output, in square
32696 brackets, immediately after the time and date.
32697
32698
32699
32700
32701 .section "Where the logs are written" "SECTwhelogwri"
32702 .cindex "log" "destination"
32703 .cindex "log" "to file"
32704 .cindex "log" "to syslog"
32705 .cindex "syslog"
32706 The logs may be written to local files, or to syslog, or both. However, it
32707 should be noted that many syslog implementations use UDP as a transport, and
32708 are therefore unreliable in the sense that messages are not guaranteed to
32709 arrive at the loghost, nor is the ordering of messages necessarily maintained.
32710 It has also been reported that on large log files (tens of megabytes) you may
32711 need to tweak syslog to prevent it syncing the file with each write &-- on
32712 Linux this has been seen to make syslog take 90% plus of CPU time.
32713
32714 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
32715 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
32716 configuration. This latter string is expanded, so it can contain, for example,
32717 references to the host name:
32718 .code
32719 log_file_path = /var/log/$primary_hostname/exim_%slog
32720 .endd
32721 It is generally advisable, however, to set the string in &_Local/Makefile_&
32722 rather than at run time, because then the setting is available right from the
32723 start of Exim's execution. Otherwise, if there's something it wants to log
32724 before it has read the configuration file (for example, an error in the
32725 configuration file) it will not use the path you want, and may not be able to
32726 log at all.
32727
32728 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
32729 list, currently limited to at most two items. This is one option where the
32730 facility for changing a list separator may not be used. The list must always be
32731 colon-separated. If an item in the list is &"syslog"& then syslog is used;
32732 otherwise the item must either be an absolute path, containing &`%s`& at the
32733 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
32734 implying the use of a default path.
32735
32736 When Exim encounters an empty item in the list, it searches the list defined by
32737 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
32738 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
32739 mean &"use the path specified at build time"&. It no such item exists, log
32740 files are written in the &_log_& subdirectory of the spool directory. This is
32741 equivalent to the setting:
32742 .code
32743 log_file_path = $spool_directory/log/%slog
32744 .endd
32745 If you do not specify anything at build time or run time, that is where the
32746 logs are written.
32747
32748 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
32749 are in use &-- see section &<<SECTdatlogfil>>& below.
32750
32751 Here are some examples of possible settings:
32752 .display
32753 &`LOG_FILE_PATH=syslog                    `& syslog only
32754 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
32755 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
32756 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
32757 .endd
32758 If there are more than two paths in the list, the first is used and a panic
32759 error is logged.
32760
32761
32762
32763 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
32764 .cindex "log" "cycling local files"
32765 .cindex "cycling logs"
32766 .cindex "&'exicyclog'&"
32767 .cindex "log" "local files; writing to"
32768 Some operating systems provide centralized and standardized methods for cycling
32769 log files. For those that do not, a utility script called &'exicyclog'& is
32770 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
32771 main and reject logs each time it is called. The maximum number of old logs to
32772 keep can be set. It is suggested this script is run as a daily &'cron'& job.
32773
32774 An Exim delivery process opens the main log when it first needs to write to it,
32775 and it keeps the file open in case subsequent entries are required &-- for
32776 example, if a number of different deliveries are being done for the same
32777 message. However, remote SMTP deliveries can take a long time, and this means
32778 that the file may be kept open long after it is renamed if &'exicyclog'& or
32779 something similar is being used to rename log files on a regular basis. To
32780 ensure that a switch of log files is noticed as soon as possible, Exim calls
32781 &[stat()]& on the main log's name before reusing an open file, and if the file
32782 does not exist, or its inode has changed, the old file is closed and Exim
32783 tries to open the main log from scratch. Thus, an old log file may remain open
32784 for quite some time, but no Exim processes should write to it once it has been
32785 renamed.
32786
32787
32788
32789 .section "Datestamped log files" "SECTdatlogfil"
32790 .cindex "log" "datestamped files"
32791 Instead of cycling the main and reject log files by renaming them
32792 periodically, some sites like to use files whose names contain a datestamp,
32793 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
32794 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
32795 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
32796 point where the datestamp is required. For example:
32797 .code
32798 log_file_path = /var/spool/exim/log/%slog-%D
32799 log_file_path = /var/log/exim-%s-%D.log
32800 log_file_path = /var/spool/exim/log/%D-%slog
32801 log_file_path = /var/log/exim/%s.%M
32802 .endd
32803 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
32804 examples of names generated by the above examples:
32805 .code
32806 /var/spool/exim/log/mainlog-20021225
32807 /var/log/exim-reject-20021225.log
32808 /var/spool/exim/log/20021225-mainlog
32809 /var/log/exim/main.200212
32810 .endd
32811 When this form of log file is specified, Exim automatically switches to new
32812 files at midnight. It does not make any attempt to compress old logs; you
32813 will need to write your own script if you require this. You should not
32814 run &'exicyclog'& with this form of logging.
32815
32816 The location of the panic log is also determined by &%log_file_path%&, but it
32817 is not datestamped, because rotation of the panic log does not make sense.
32818 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
32819 the string. In addition, if it immediately follows a slash, a following
32820 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
32821 character is removed. Thus, the four examples above would give these panic
32822 log names:
32823 .code
32824 /var/spool/exim/log/paniclog
32825 /var/log/exim-panic.log
32826 /var/spool/exim/log/paniclog
32827 /var/log/exim/panic
32828 .endd
32829
32830
32831 .section "Logging to syslog" "SECID249"
32832 .cindex "log" "syslog; writing to"
32833 The use of syslog does not change what Exim logs or the format of its messages,
32834 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
32835 Exim's log lines are omitted when these lines are sent to syslog. Apart from
32836 that, the same strings are written to syslog as to log files. The syslog
32837 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
32838 by default, but you can change these by setting the &%syslog_facility%& and
32839 &%syslog_processname%& options, respectively. If Exim was compiled with
32840 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
32841 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
32842 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
32843 the time and host name to each line.
32844 The three log streams are mapped onto syslog priorities as follows:
32845
32846 .ilist
32847 &'mainlog'& is mapped to LOG_INFO
32848 .next
32849 &'rejectlog'& is mapped to LOG_NOTICE
32850 .next
32851 &'paniclog'& is mapped to LOG_ALERT
32852 .endlist
32853
32854 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
32855 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
32856 these are routed by syslog to the same place. You can suppress this duplication
32857 by setting &%syslog_duplication%& false.
32858
32859 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
32860 entries contain multiple lines when headers are included. To cope with both
32861 these cases, entries written to syslog are split into separate &[syslog()]&
32862 calls at each internal newline, and also after a maximum of
32863 870 data characters. (This allows for a total syslog line length of 1024, when
32864 additions such as timestamps are added.) If you are running a syslog
32865 replacement that can handle lines longer than the 1024 characters allowed by
32866 RFC 3164, you should set
32867 .code
32868 SYSLOG_LONG_LINES=yes
32869 .endd
32870 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
32871 lines, but it still splits at internal newlines in &'reject'& log entries.
32872
32873 To make it easy to re-assemble split lines later, each component of a split
32874 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
32875 where <&'n'&> is the component number and <&'m'&> is the total number of
32876 components in the entry. The / delimiter is used when the line was split
32877 because it was too long; if it was split because of an internal newline, the \
32878 delimiter is used. For example, supposing the length limit to be 50 instead of
32879 870, the following would be the result of a typical rejection message to
32880 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
32881 name, and pid as added by syslog:
32882 .code
32883 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
32884 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
32885 [3/5]  when scanning for sender: missing or malformed lo
32886 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
32887 [5/5] mple>)
32888 .endd
32889 The same error might cause the following lines to be written to &"rejectlog"&
32890 (LOG_NOTICE):
32891 .code
32892 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
32893 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
32894 [3/18] er when scanning for sender: missing or malformed
32895 [4/18]  local part in "<>" (envelope sender is <ph10@cam
32896 [5\18] .example>)
32897 [6\18] Recipients: ph10@some.domain.cam.example
32898 [7\18] P Received: from [127.0.0.1] (ident=ph10)
32899 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
32900 [9\18]        id 16RdAL-0006pc-00
32901 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
32902 [11\18] 09:43 +0100
32903 [12\18] F From: <>
32904 [13\18]   Subject: this is a test header
32905 [18\18]   X-something: this is another header
32906 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
32907 [16\18] le>
32908 [17\18] B Bcc:
32909 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
32910 .endd
32911 Log lines that are neither too long nor contain newlines are written to syslog
32912 without modification.
32913
32914 If only syslog is being used, the Exim monitor is unable to provide a log tail
32915 display, unless syslog is routing &'mainlog'& to a file on the local host and
32916 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
32917 where it is.
32918
32919
32920
32921 .section "Log line flags" "SECID250"
32922 One line is written to the main log for each message received, and for each
32923 successful, unsuccessful, and delayed delivery. These lines can readily be
32924 picked out by the distinctive two-character flags that immediately follow the
32925 timestamp. The flags are:
32926 .display
32927 &`<=`&     message arrival
32928 &`=>`&     normal message delivery
32929 &`->`&     additional address in same delivery
32930 &`*>`&     delivery suppressed by &%-N%&
32931 &`**`&     delivery failed; address bounced
32932 &`==`&     delivery deferred; temporary problem
32933 .endd
32934
32935
32936 .section "Logging message reception" "SECID251"
32937 .cindex "log" "reception line"
32938 The format of the single-line entry in the main log that is written for every
32939 message received is shown in the basic example below, which is split over
32940 several lines in order to fit it on the page:
32941 .code
32942 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
32943   H=mailer.fict.example [192.168.123.123] U=exim
32944   P=smtp S=5678 id=<incoming message id>
32945 .endd
32946 The address immediately following &"<="& is the envelope sender address. A
32947 bounce message is shown with the sender address &"<>"&, and if it is locally
32948 generated, this is followed by an item of the form
32949 .code
32950 R=<message id>
32951 .endd
32952 which is a reference to the message that caused the bounce to be sent.
32953
32954 .cindex "HELO"
32955 .cindex "EHLO"
32956 For messages from other hosts, the H and U fields identify the remote host and
32957 record the RFC 1413 identity of the user that sent the message, if one was
32958 received. The number given in square brackets is the IP address of the sending
32959 host. If there is a single, unparenthesized  host name in the H field, as
32960 above, it has been verified to correspond to the IP address (see the
32961 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
32962 by the remote host in the SMTP HELO or EHLO command, and has not been
32963 verified. If verification yields a different name to that given for HELO or
32964 EHLO, the verified name appears first, followed by the HELO or EHLO
32965 name in parentheses.
32966
32967 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
32968 without brackets, in the HELO or EHLO command, leading to entries in
32969 the log containing text like these examples:
32970 .code
32971 H=(10.21.32.43) [192.168.8.34]
32972 H=([10.21.32.43]) [192.168.8.34]
32973 .endd
32974 This can be confusing. Only the final address in square brackets can be relied
32975 on.
32976
32977 For locally generated messages (that is, messages not received over TCP/IP),
32978 the H field is omitted, and the U field contains the login name of the caller
32979 of Exim.
32980
32981 .cindex "authentication" "logging"
32982 .cindex "AUTH" "logging"
32983 For all messages, the P field specifies the protocol used to receive the
32984 message. This is the value that is stored in &$received_protocol$&. In the case
32985 of incoming SMTP messages, the value indicates whether or not any SMTP
32986 extensions (ESMTP), encryption, or authentication were used. If the SMTP
32987 session was encrypted, there is an additional X field that records the cipher
32988 suite that was used.
32989
32990 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
32991 hosts that have authenticated themselves using the SMTP AUTH command. The first
32992 value is used when the SMTP connection was encrypted (&"secure"&). In this case
32993 there is an additional item A= followed by the name of the authenticator that
32994 was used. If an authenticated identification was set up by the authenticator's
32995 &%server_set_id%& option, this is logged too, separated by a colon from the
32996 authenticator name.
32997
32998 .cindex "size" "of message"
32999 The id field records the existing message id, if present. The size of the
33000 received message is given by the S field. When the message is delivered,
33001 headers may be removed or added, so that the size of delivered copies of the
33002 message may not correspond with this value (and indeed may be different to each
33003 other).
33004
33005 The &%log_selector%& option can be used to request the logging of additional
33006 data when a message is received. See section &<<SECTlogselector>>& below.
33007
33008
33009
33010 .section "Logging deliveries" "SECID252"
33011 .cindex "log" "delivery line"
33012 The format of the single-line entry in the main log that is written for every
33013 delivery is shown in one of the examples below, for local and remote
33014 deliveries, respectively. Each example has been split into two lines in order
33015 to fit it on the page:
33016 .code
33017 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33018   <marv@hitch.fict.example> R=localuser T=local_delivery
33019 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33020   monk@holistic.fict.example R=dnslookup T=remote_smtp
33021   H=holistic.fict.example [192.168.234.234]
33022 .endd
33023 For ordinary local deliveries, the original address is given in angle brackets
33024 after the final delivery address, which might be a pipe or a file. If
33025 intermediate address(es) exist between the original and the final address, the
33026 last of these is given in parentheses after the final address. The R and T
33027 fields record the router and transport that were used to process the address.
33028
33029 If a shadow transport was run after a successful local delivery, the log line
33030 for the successful delivery has an item added on the end, of the form
33031 .display
33032 &`ST=<`&&'shadow transport name'&&`>`&
33033 .endd
33034 If the shadow transport did not succeed, the error message is put in
33035 parentheses afterwards.
33036
33037 .cindex "asterisk" "after IP address"
33038 When more than one address is included in a single delivery (for example, two
33039 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33040 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33041 down a single SMTP connection, an asterisk follows the IP address in the log
33042 lines for the second and subsequent messages.
33043
33044 The generation of a reply message by a filter file gets logged as a
33045 &"delivery"& to the addressee, preceded by &">"&.
33046
33047 The &%log_selector%& option can be used to request the logging of additional
33048 data when a message is delivered. See section &<<SECTlogselector>>& below.
33049
33050
33051 .section "Discarded deliveries" "SECID253"
33052 .cindex "discarded messages"
33053 .cindex "message" "discarded"
33054 .cindex "delivery" "discarded; logging"
33055 When a message is discarded as a result of the command &"seen finish"& being
33056 obeyed in a filter file which generates no deliveries, a log entry of the form
33057 .code
33058 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33059   <low.club@bridge.example> R=userforward
33060 .endd
33061 is written, to record why no deliveries are logged. When a message is discarded
33062 because it is aliased to &":blackhole:"& the log line is like this:
33063 .code
33064 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
33065   <hole@nowhere.example> R=blackhole_router
33066 .endd
33067
33068
33069 .section "Deferred deliveries" "SECID254"
33070 When a delivery is deferred, a line of the following form is logged:
33071 .code
33072 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
33073   R=dnslookup T=smtp defer (146): Connection refused
33074 .endd
33075 In the case of remote deliveries, the error is the one that was given for the
33076 last IP address that was tried. Details of individual SMTP failures are also
33077 written to the log, so the above line would be preceded by something like
33078 .code
33079 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
33080   mail1.endrest.example [192.168.239.239]: Connection refused
33081 .endd
33082 When a deferred address is skipped because its retry time has not been reached,
33083 a message is written to the log, but this can be suppressed by setting an
33084 appropriate value in &%log_selector%&.
33085
33086
33087
33088 .section "Delivery failures" "SECID255"
33089 .cindex "delivery" "failure; logging"
33090 If a delivery fails because an address cannot be routed, a line of the
33091 following form is logged:
33092 .code
33093 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
33094   <jim@trek99.example>: unknown mail domain
33095 .endd
33096 If a delivery fails at transport time, the router and transport are shown, and
33097 the response from the remote host is included, as in this example:
33098 .code
33099 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
33100   R=dnslookup T=remote_smtp: SMTP error from remote mailer
33101   after pipelined RCPT TO:<ace400@pb.example>: host
33102   pbmail3.py.example [192.168.63.111]: 553 5.3.0
33103   <ace400@pb.example>...Addressee unknown
33104 .endd
33105 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
33106 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
33107 disabling PIPELINING. The log lines for all forms of delivery failure are
33108 flagged with &`**`&.
33109
33110
33111
33112 .section "Fake deliveries" "SECID256"
33113 .cindex "delivery" "fake; logging"
33114 If a delivery does not actually take place because the &%-N%& option has been
33115 used to suppress it, a normal delivery line is written to the log, except that
33116 &"=>"& is replaced by &"*>"&.
33117
33118
33119
33120 .section "Completion" "SECID257"
33121 A line of the form
33122 .code
33123 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
33124 .endd
33125 is written to the main log when a message is about to be removed from the spool
33126 at the end of its processing.
33127
33128
33129
33130
33131 .section "Summary of Fields in Log Lines" "SECID258"
33132 .cindex "log" "summary of fields"
33133 A summary of the field identifiers that are used in log lines is shown in
33134 the following table:
33135 .display
33136 &`A   `&        authenticator name (and optional id)
33137 &`C   `&        SMTP confirmation on delivery
33138 &`    `&        command list for &"no mail in SMTP session"&
33139 &`CV  `&        certificate verification status
33140 &`D   `&        duration of &"no mail in SMTP session"&
33141 &`DN  `&        distinguished name from peer certificate
33142 &`DT  `&        on &`=>`& lines: time taken for a delivery
33143 &`F   `&        sender address (on delivery lines)
33144 &`H   `&        host name and IP address
33145 &`I   `&        local interface used
33146 &`id  `&        message id for incoming message
33147 &`P   `&        on &`<=`& lines: protocol used
33148 &`    `&        on &`=>`& and &`**`& lines: return path
33149 &`QT  `&        on &`=>`& lines: time spent on queue so far
33150 &`    `&        on &"Completed"& lines: time spent on queue
33151 &`R   `&        on &`<=`& lines: reference for local bounce
33152 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
33153 &`S   `&        size of message
33154 &`ST  `&        shadow transport name
33155 &`T   `&        on &`<=`& lines: message subject (topic)
33156 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
33157 &`U   `&        local user or RFC 1413 identity
33158 &`X   `&        TLS cipher suite
33159 .endd
33160
33161
33162 .section "Other log entries" "SECID259"
33163 Various other types of log entry are written from time to time. Most should be
33164 self-explanatory. Among the more common are:
33165
33166 .ilist
33167 .cindex "retry" "time not reached"
33168 &'retry time not reached'&&~&~An address previously suffered a temporary error
33169 during routing or local delivery, and the time to retry has not yet arrived.
33170 This message is not written to an individual message log file unless it happens
33171 during the first delivery attempt.
33172 .next
33173 &'retry time not reached for any host'&&~&~An address previously suffered
33174 temporary errors during remote delivery, and the retry time has not yet arrived
33175 for any of the hosts to which it is routed.
33176 .next
33177 .cindex "spool directory" "file locked"
33178 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
33179 some other Exim process is already working on the message. This can be quite
33180 common if queue running processes are started at frequent intervals. The
33181 &'exiwhat'& utility script can be used to find out what Exim processes are
33182 doing.
33183 .next
33184 .cindex "error" "ignored"
33185 &'error ignored'&&~&~There are several circumstances that give rise to this
33186 message:
33187 .olist
33188 Exim failed to deliver a bounce message whose age was greater than
33189 &%ignore_bounce_errors_after%&. The bounce was discarded.
33190 .next
33191 A filter file set up a delivery using the &"noerror"& option, and the delivery
33192 failed. The delivery was discarded.
33193 .next
33194 A delivery set up by a router configured with
33195 . ==== As this is a nested list, any displays it contains must be indented
33196 . ==== as otherwise they are too far to the left.
33197 .code
33198     errors_to = <>
33199 .endd
33200 failed. The delivery was discarded.
33201 .endlist olist
33202 .endlist ilist
33203
33204
33205
33206
33207
33208 .section "Reducing or increasing what is logged" "SECTlogselector"
33209 .cindex "log" "selectors"
33210 By setting the &%log_selector%& global option, you can disable some of Exim's
33211 default logging, or you can request additional logging. The value of
33212 &%log_selector%& is made up of names preceded by plus or minus characters. For
33213 example:
33214 .code
33215 log_selector = +arguments -retry_defer
33216 .endd
33217 The list of optional log items is in the following table, with the default
33218 selection marked by asterisks:
33219 .display
33220 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
33221 &` address_rewrite            `&  address rewriting
33222 &` all_parents                `&  all parents in => lines
33223 &` arguments                  `&  command line arguments
33224 &`*connection_reject          `&  connection rejections
33225 &`*delay_delivery             `&  immediate delivery delayed
33226 &` deliver_time               `&  time taken to perform delivery
33227 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
33228 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
33229 &`*etrn                       `&  ETRN commands
33230 &`*host_lookup_failed         `&  as it says
33231 &` ident_timeout              `&  timeout for ident connection
33232 &` incoming_interface         `&  incoming interface on <= lines
33233 &` incoming_port              `&  incoming port on <= lines
33234 &`*lost_incoming_connection   `&  as it says (includes timeouts)
33235 &` outgoing_port              `&  add remote port to => lines
33236 &`*queue_run                  `&  start and end queue runs
33237 &` queue_time                 `&  time on queue for one recipient
33238 &` queue_time_overall         `&  time on queue for whole message
33239 &` pid                        `&  Exim process id
33240 &` received_recipients        `&  recipients on <= lines
33241 &` received_sender            `&  sender on <= lines
33242 &`*rejected_header            `&  header contents on reject log
33243 &`*retry_defer                `&  &"retry time not reached"&
33244 &` return_path_on_delivery    `&  put return path on => and ** lines
33245 &` sender_on_delivery         `&  add sender to => lines
33246 &`*sender_verify_fail         `&  sender verification failures
33247 &`*size_reject                `&  rejection because too big
33248 &`*skip_delivery              `&  delivery skipped in a queue run
33249 &` smtp_confirmation          `&  SMTP confirmation on => lines
33250 &` smtp_connection            `&  SMTP connections
33251 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
33252 &` smtp_no_mail               `&  session with no MAIL commands
33253 &` smtp_protocol_error        `&  SMTP protocol errors
33254 &` smtp_syntax_error          `&  SMTP syntax errors
33255 &` subject                    `&  contents of &'Subject:'& on <= lines
33256 &` tls_certificate_verified   `&  certificate verification status
33257 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
33258 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
33259 &` tls_sni                    `&  TLS SNI on <= lines
33260 &` unknown_in_list            `&  DNS lookup failed in list match
33261
33262 &` all                        `&  all of the above
33263 .endd
33264 More details on each of these items follows:
33265
33266 .ilist
33267 .cindex "&%warn%& ACL verb" "log when skipping"
33268 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
33269 its conditions cannot be evaluated, a log line to this effect is written if
33270 this log selector is set.
33271 .next
33272 .cindex "log" "rewriting"
33273 .cindex "rewriting" "logging"
33274 &%address_rewrite%&: This applies both to global rewrites and per-transport
33275 rewrites, but not to rewrites in filters run as an unprivileged user (because
33276 such users cannot access the log).
33277 .next
33278 .cindex "log" "full parentage"
33279 &%all_parents%&: Normally only the original and final addresses are logged on
33280 delivery lines; with this selector, intermediate parents are given in
33281 parentheses between them.
33282 .next
33283 .cindex "log" "Exim arguments"
33284 .cindex "Exim arguments, logging"
33285 &%arguments%&: This causes Exim to write the arguments with which it was called
33286 to the main log, preceded by the current working directory. This is a debugging
33287 feature, added to make it easier to find out how certain MUAs call
33288 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
33289 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
33290 that are empty or that contain white space are quoted. Non-printing characters
33291 are shown as escape sequences. This facility cannot log unrecognized arguments,
33292 because the arguments are checked before the configuration file is read. The
33293 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
33294 between the caller and Exim.
33295 .next
33296 .cindex "log" "connection rejections"
33297 &%connection_reject%&: A log entry is written whenever an incoming SMTP
33298 connection is rejected, for whatever reason.
33299 .next
33300 .cindex "log" "delayed delivery"
33301 .cindex "delayed delivery, logging"
33302 &%delay_delivery%&: A log entry is written whenever a delivery process is not
33303 started for an incoming message because the load is too high or too many
33304 messages were received on one connection. Logging does not occur if no delivery
33305 process is started because &%queue_only%& is set or &%-odq%& was used.
33306 .next
33307 .cindex "log" "delivery duration"
33308 &%deliver_time%&: For each delivery, the amount of real time it has taken to
33309 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
33310 .next
33311 .cindex "log" "message size on delivery"
33312 .cindex "size" "of message"
33313 &%delivery_size%&: For each delivery, the size of message delivered is added to
33314 the &"=>"& line, tagged with S=.
33315 .next
33316 .cindex "log" "dnslist defer"
33317 .cindex "DNS list" "logging defer"
33318 .cindex "black list (DNS)"
33319 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
33320 DNS black list suffers a temporary error.
33321 .next
33322 .cindex "log" "ETRN commands"
33323 .cindex "ETRN" "logging"
33324 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
33325 is run to determine whether or not it is actually accepted. An invalid ETRN
33326 command, or one received within a message transaction is not logged by this
33327 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
33328 .next
33329 .cindex "log" "host lookup failure"
33330 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
33331 any addresses, or when a lookup of an IP address fails to find a host name, a
33332 log line is written. This logging does not apply to direct DNS lookups when
33333 routing email addresses, but it does apply to &"byname"& lookups.
33334 .next
33335 .cindex "log" "ident timeout"
33336 .cindex "RFC 1413" "logging timeout"
33337 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
33338 client's ident port times out.
33339 .next
33340 .cindex "log" "incoming interface"
33341 .cindex "interface" "logging"
33342 &%incoming_interface%&: The interface on which a message was received is added
33343 to the &"<="& line as an IP address in square brackets, tagged by I= and
33344 followed by a colon and the port number. The local interface and port are also
33345 added to other SMTP log lines, for example &"SMTP connection from"&, and to
33346 rejection lines.
33347 .next
33348 .cindex "log" "incoming remote port"
33349 .cindex "port" "logging remote"
33350 .cindex "TCP/IP" "logging incoming remote port"
33351 .vindex "&$sender_fullhost$&"
33352 .vindex "&$sender_rcvhost$&"
33353 &%incoming_port%&: The remote port number from which a message was received is
33354 added to log entries and &'Received:'& header lines, following the IP address
33355 in square brackets, and separated from it by a colon. This is implemented by
33356 changing the value that is put in the &$sender_fullhost$& and
33357 &$sender_rcvhost$& variables. Recording the remote port number has become more
33358 important with the widening use of NAT (see RFC 2505).
33359 .next
33360 .cindex "log" "dropped connection"
33361 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
33362 connection is unexpectedly dropped.
33363 .next
33364 .cindex "log" "outgoing remote port"
33365 .cindex "port" "logging outgoint remote"
33366 .cindex "TCP/IP" "logging ougtoing remote port"
33367 &%outgoing_port%&: The remote port number is added to delivery log lines (those
33368 containing => tags) following the IP address. This option is not included in
33369 the default setting, because for most ordinary configurations, the remote port
33370 number is always 25 (the SMTP port).
33371 .next
33372 .cindex "log" "process ids in"
33373 .cindex "pid (process id)" "in log lines"
33374 &%pid%&: The current process id is added to every log line, in square brackets,
33375 immediately after the time and date.
33376 .next
33377 .cindex "log" "queue run"
33378 .cindex "queue runner" "logging"
33379 &%queue_run%&: The start and end of every queue run are logged.
33380 .next
33381 .cindex "log" "queue time"
33382 &%queue_time%&: The amount of time the message has been in the queue on the
33383 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
33384 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
33385 includes reception time as well as the delivery time for the current address.
33386 This means that it may be longer than the difference between the arrival and
33387 delivery log line times, because the arrival log line is not written until the
33388 message has been successfully received.
33389 .next
33390 &%queue_time_overall%&: The amount of time the message has been in the queue on
33391 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
33392 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
33393 message, so it includes reception time as well as the total delivery time.
33394 .next
33395 .cindex "log" "recipients"
33396 &%received_recipients%&: The recipients of a message are listed in the main log
33397 as soon as the message is received. The list appears at the end of the log line
33398 that is written when a message is received, preceded by the word &"for"&. The
33399 addresses are listed after they have been qualified, but before any rewriting
33400 has taken place.
33401 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
33402 in the list.
33403 .next
33404 .cindex "log" "sender reception"
33405 &%received_sender%&: The unrewritten original sender of a message is added to
33406 the end of the log line that records the message's arrival, after the word
33407 &"from"& (before the recipients if &%received_recipients%& is also set).
33408 .next
33409 .cindex "log" "header lines for rejection"
33410 &%rejected_header%&: If a message's header has been received at the time a
33411 rejection is written to the reject log, the complete header is added to the
33412 log. Header logging can be turned off individually for messages that are
33413 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
33414 .next
33415 .cindex "log" "retry defer"
33416 &%retry_defer%&: A log line is written if a delivery is deferred because a
33417 retry time has not yet been reached. However, this &"retry time not reached"&
33418 message is always omitted from individual message logs after the first delivery
33419 attempt.
33420 .next
33421 .cindex "log" "return path"
33422 &%return_path_on_delivery%&: The return path that is being transmitted with
33423 the message is included in delivery and bounce lines, using the tag P=.
33424 This is omitted if no delivery actually happens, for example, if routing fails,
33425 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
33426 .next
33427 .cindex "log" "sender on delivery"
33428 &%sender_on_delivery%&: The message's sender address is added to every delivery
33429 and bounce line, tagged by F= (for &"from"&).
33430 This is the original sender that was received with the message; it is not
33431 necessarily the same as the outgoing return path.
33432 .next
33433 .cindex "log" "sender verify failure"
33434 &%sender_verify_fail%&: If this selector is unset, the separate log line that
33435 gives details of a sender verification failure is not written. Log lines for
33436 the rejection of SMTP commands contain just &"sender verify failed"&, so some
33437 detail is lost.
33438 .next
33439 .cindex "log" "size rejection"
33440 &%size_reject%&: A log line is written whenever a message is rejected because
33441 it is too big.
33442 .next
33443 .cindex "log" "frozen messages; skipped"
33444 .cindex "frozen messages" "logging skipping"
33445 &%skip_delivery%&: A log line is written whenever a message is skipped during a
33446 queue run because it is frozen or because another process is already delivering
33447 it.
33448 .cindex "&""spool file is locked""&"
33449 The message that is written is &"spool file is locked"&.
33450 .next
33451 .cindex "log" "smtp confirmation"
33452 .cindex "SMTP" "logging confirmation"
33453 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
33454 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
33455 A number of MTAs (including Exim) return an identifying string in this
33456 response.
33457 .next
33458 .cindex "log" "SMTP connections"
33459 .cindex "SMTP" "logging connections"
33460 &%smtp_connection%&: A log line is written whenever an SMTP connection is
33461 established or closed, unless the connection is from a host that matches
33462 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
33463 only when the closure is unexpected.) This applies to connections from local
33464 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
33465 dropped in the middle of a message, a log line is always written, whether or
33466 not this selector is set, but otherwise nothing is written at the start and end
33467 of connections unless this selector is enabled.
33468
33469 For TCP/IP connections to an Exim daemon, the current number of connections is
33470 included in the log message for each new connection, but note that the count is
33471 reset if the daemon is restarted.
33472 Also, because connections are closed (and the closure is logged) in
33473 subprocesses, the count may not include connections that have been closed but
33474 whose termination the daemon has not yet noticed. Thus, while it is possible to
33475 match up the opening and closing of connections in the log, the value of the
33476 logged counts may not be entirely accurate.
33477 .next
33478 .cindex "log" "SMTP transaction; incomplete"
33479 .cindex "SMTP" "logging incomplete transactions"
33480 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
33481 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
33482 and the message sender plus any accepted recipients are included in the log
33483 line. This can provide evidence of dictionary attacks.
33484 .next
33485 .cindex "log" "non-MAIL SMTP sessions"
33486 .cindex "MAIL" "logging session without"
33487 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
33488 connection terminates without having issued a MAIL command. This includes both
33489 the case when the connection is dropped, and the case when QUIT is used. It
33490 does not include cases where the connection is rejected right at the start (by
33491 an ACL, or because there are too many connections, or whatever). These cases
33492 already have their own log lines.
33493
33494 The log line that is written contains the identity of the client in the usual
33495 way, followed by D= and a time, which records the duration of the connection.
33496 If the connection was authenticated, this fact is logged exactly as it is for
33497 an incoming message, with an A= item. If the connection was encrypted, CV=,
33498 DN=, and X= items may appear as they do for an incoming message, controlled by
33499 the same logging options.
33500
33501 Finally, if any SMTP commands were issued during the connection, a C= item
33502 is added to the line, listing the commands that were used. For example,
33503 .code
33504 C=EHLO,QUIT
33505 .endd
33506 shows that the client issued QUIT straight after EHLO. If there were fewer
33507 than 20 commands, they are all listed. If there were more than 20 commands,
33508 the last 20 are listed, preceded by &"..."&. However, with the default
33509 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
33510 have been aborted before 20 non-mail commands are processed.
33511 .next
33512 .cindex "log" "SMTP protocol error"
33513 .cindex "SMTP" "logging protocol error"
33514 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
33515 encountered. Exim does not have perfect detection of all protocol errors
33516 because of transmission delays and the use of pipelining. If PIPELINING has
33517 been advertised to a client, an Exim server assumes that the client will use
33518 it, and therefore it does not count &"expected"& errors (for example, RCPT
33519 received after rejecting MAIL) as protocol errors.
33520 .next
33521 .cindex "SMTP" "logging syntax errors"
33522 .cindex "SMTP" "syntax errors; logging"
33523 .cindex "SMTP" "unknown command; logging"
33524 .cindex "log" "unknown SMTP command"
33525 .cindex "log" "SMTP syntax error"
33526 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
33527 encountered. An unrecognized command is treated as a syntax error. For an
33528 external connection, the host identity is given; for an internal connection
33529 using &%-bs%& the sender identification (normally the calling user) is given.
33530 .next
33531 .cindex "log" "subject"
33532 .cindex "subject, logging"
33533 &%subject%&: The subject of the message is added to the arrival log line,
33534 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
33535 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
33536 specifies whether characters with values greater than 127 should be logged
33537 unchanged, or whether they should be rendered as escape sequences.
33538 .next
33539 .cindex "log" "certificate verification"
33540 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
33541 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
33542 verified, and &`CV=no`& if not.
33543 .next
33544 .cindex "log" "TLS cipher"
33545 .cindex "TLS" "logging cipher"
33546 &%tls_cipher%&: When a message is sent or received over an encrypted
33547 connection, the cipher suite used is added to the log line, preceded by X=.
33548 .next
33549 .cindex "log" "TLS peer DN"
33550 .cindex "TLS" "logging peer DN"
33551 &%tls_peerdn%&: When a message is sent or received over an encrypted
33552 connection, and a certificate is supplied by the remote host, the peer DN is
33553 added to the log line, preceded by DN=.
33554 .next
33555 .cindex "log" "TLS SNI"
33556 .cindex "TLS" "logging SNI"
33557 &%tls_sni%&: When a message is received over an encrypted connection, and
33558 the remote host provided the Server Name Indication extension, the SNI is
33559 added to the log line, preceded by SNI=.
33560 .next
33561 .cindex "log" "DNS failure in list"
33562 &%unknown_in_list%&: This setting causes a log entry to be written when the
33563 result of a list match is failure because a DNS lookup failed.
33564 .endlist
33565
33566
33567 .section "Message log" "SECID260"
33568 .cindex "message" "log file for"
33569 .cindex "log" "message log; description of"
33570 .cindex "&_msglog_& directory"
33571 .oindex "&%preserve_message_logs%&"
33572 In addition to the general log files, Exim writes a log file for each message
33573 that it handles. The names of these per-message logs are the message ids, and
33574 they are kept in the &_msglog_& sub-directory of the spool directory. Each
33575 message log contains copies of the log lines that apply to the message. This
33576 makes it easier to inspect the status of an individual message without having
33577 to search the main log. A message log is deleted when processing of the message
33578 is complete, unless &%preserve_message_logs%& is set, but this should be used
33579 only with great care because they can fill up your disk very quickly.
33580
33581 On a heavily loaded system, it may be desirable to disable the use of
33582 per-message logs, in order to reduce disk I/O. This can be done by setting the
33583 &%message_logs%& option false.
33584 .ecindex IIDloggen
33585
33586
33587
33588
33589 . ////////////////////////////////////////////////////////////////////////////
33590 . ////////////////////////////////////////////////////////////////////////////
33591
33592 .chapter "Exim utilities" "CHAPutils"
33593 .scindex IIDutils "utilities"
33594 A number of utility scripts and programs are supplied with Exim and are
33595 described in this chapter. There is also the Exim Monitor, which is covered in
33596 the next chapter. The utilities described here are:
33597
33598 .itable none 0 0 3  7* left  15* left  40* left
33599 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
33600   "list what Exim processes are doing"
33601 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
33602 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
33603 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
33604 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
33605                                                 various criteria"
33606 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
33607 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
33608   "extract statistics from the log"
33609 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
33610   "check address acceptance from given IP"
33611 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
33612 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
33613 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
33614 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
33615 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
33616 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
33617 .endtable
33618
33619 Another utility that might be of use to sites with many MTAs is Tom Kistner's
33620 &'exilog'&. It provides log visualizations across multiple Exim servers. See
33621 &url(http://duncanthrax.net/exilog/) for details.
33622
33623
33624
33625
33626 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
33627 .cindex "&'exiwhat'&"
33628 .cindex "process, querying"
33629 .cindex "SIGUSR1"
33630 On operating systems that can restart a system call after receiving a signal
33631 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
33632 a line describing what it is doing to the file &_exim-process.info_& in the
33633 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
33634 processes it can find, having first emptied the file. It then waits for one
33635 second to allow the Exim processes to react before displaying the results. In
33636 order to run &'exiwhat'& successfully you have to have sufficient privilege to
33637 send the signal to the Exim processes, so it is normally run as root.
33638
33639 &*Warning*&: This is not an efficient process. It is intended for occasional
33640 use by system administrators. It is not sensible, for example, to set up a
33641 script that sends SIGUSR1 signals to Exim processes at short intervals.
33642
33643
33644 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
33645 varies in different operating systems. Not only are different options used,
33646 but the format of the output is different. For this reason, there are some
33647 system configuration options that configure exactly how &'exiwhat'& works. If
33648 it doesn't seem to be working for you, check the following compile-time
33649 options:
33650 .display
33651 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
33652 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
33653 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
33654 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
33655 .endd
33656 An example of typical output from &'exiwhat'& is
33657 .code
33658 164 daemon: -q1h, listening on port 25
33659 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
33660 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
33661   [10.19.42.42] (editor@ref.example)
33662 10592 handling incoming call from [192.168.243.242]
33663 10628 accepting a local non-SMTP message
33664 .endd
33665 The first number in the output line is the process number. The third line has
33666 been split here, in order to fit it on the page.
33667
33668
33669
33670 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
33671 .cindex "&'exiqgrep'&"
33672 .cindex "queue" "grepping"
33673 This utility is a Perl script contributed by Matt Hubbard. It runs
33674 .code
33675 exim -bpu
33676 .endd
33677 to obtain a queue listing with undelivered recipients only, and then greps the
33678 output to select messages that match given criteria. The following selection
33679 options are available:
33680
33681 .vlist
33682 .vitem &*-f*&&~<&'regex'&>
33683 Match the sender address. The field that is tested is enclosed in angle
33684 brackets, so you can test for bounce messages with
33685 .code
33686 exiqgrep -f '^<>$'
33687 .endd
33688 .vitem &*-r*&&~<&'regex'&>
33689 Match a recipient address. The field that is tested is not enclosed in angle
33690 brackets.
33691
33692 .vitem &*-s*&&~<&'regex'&>
33693 Match against the size field.
33694
33695 .vitem &*-y*&&~<&'seconds'&>
33696 Match messages that are younger than the given time.
33697
33698 .vitem &*-o*&&~<&'seconds'&>
33699 Match messages that are older than the given time.
33700
33701 .vitem &*-z*&
33702 Match only frozen messages.
33703
33704 .vitem &*-x*&
33705 Match only non-frozen messages.
33706 .endlist
33707
33708 The following options control the format of the output:
33709
33710 .vlist
33711 .vitem &*-c*&
33712 Display only the count of matching messages.
33713
33714 .vitem &*-l*&
33715 Long format &-- display the full message information as output by Exim. This is
33716 the default.
33717
33718 .vitem &*-i*&
33719 Display message ids only.
33720
33721 .vitem &*-b*&
33722 Brief format &-- one line per message.
33723
33724 .vitem &*-R*&
33725 Display messages in reverse order.
33726 .endlist
33727
33728 There is one more option, &%-h%&, which outputs a list of options.
33729
33730
33731
33732 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
33733 .cindex "&'exiqsumm'&"
33734 .cindex "queue" "summary"
33735 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
33736 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
33737 running a command such as
33738 .code
33739 exim -bp | exiqsumm
33740 .endd
33741 The output consists of one line for each domain that has messages waiting for
33742 it, as in the following example:
33743 .code
33744 3   2322   74m   66m  msn.com.example
33745 .endd
33746 Each line lists the number of pending deliveries for a domain, their total
33747 volume, and the length of time that the oldest and the newest messages have
33748 been waiting. Note that the number of pending deliveries is greater than the
33749 number of messages when messages have more than one recipient.
33750
33751 A summary line is output at the end. By default the output is sorted on the
33752 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
33753 the output to be sorted by oldest message and by count of messages,
33754 respectively. There are also three options that split the messages for each
33755 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
33756 separates frozen messages, and &%-s%& separates messages according to their
33757 sender.
33758
33759 The output of &'exim -bp'& contains the original addresses in the message, so
33760 this also applies to the output from &'exiqsumm'&. No domains from addresses
33761 generated by aliasing or forwarding are included (unless the &%one_time%&
33762 option of the &(redirect)& router has been used to convert them into &"top
33763 level"& addresses).
33764
33765
33766
33767
33768 .section "Extracting specific information from the log (exigrep)" &&&
33769          "SECTextspeinf"
33770 .cindex "&'exigrep'&"
33771 .cindex "log" "extracts; grepping for"
33772 The &'exigrep'& utility is a Perl script that searches one or more main log
33773 files for entries that match a given pattern. When it finds a match, it
33774 extracts all the log entries for the relevant message, not just those that
33775 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
33776 given message, or all mail for a given user, or for a given host, for example.
33777 The input files can be in Exim log format or syslog format.
33778 If a matching log line is not associated with a specific message, it is
33779 included in &'exigrep'&'s output without any additional lines. The usage is:
33780 .display
33781 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
33782 .endd
33783 If no log file names are given on the command line, the standard input is read.
33784
33785 The &%-t%& argument specifies a number of seconds. It adds an additional
33786 condition for message selection. Messages that are complete are shown only if
33787 they spent more than <&'n'&> seconds on the queue.
33788
33789 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
33790 makes it case-sensitive. This may give a performance improvement when searching
33791 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
33792 option; with &%-I%& they do not. In both cases it is possible to change the
33793 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
33794
33795 The &%-l%& option means &"literal"&, that is, treat all characters in the
33796 pattern as standing for themselves. Otherwise the pattern must be a Perl
33797 regular expression.
33798
33799 The &%-v%& option inverts the matching condition. That is, a line is selected
33800 if it does &'not'& match the pattern.
33801
33802 If the location of a &'zcat'& command is known from the definition of
33803 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
33804 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
33805
33806
33807 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
33808 .cindex "&'exipick'&"
33809 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
33810 lists messages from the queue according to a variety of criteria. For details
33811 of &'exipick'&'s facilities, visit the web page at
33812 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
33813 the &%--help%& option.
33814
33815
33816 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
33817 .cindex "log" "cycling local files"
33818 .cindex "cycling logs"
33819 .cindex "&'exicyclog'&"
33820 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
33821 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
33822 you are using log files with datestamps in their names (see section
33823 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
33824 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
33825 There are two command line options for &'exicyclog'&:
33826 .ilist
33827 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
33828 default that is set when Exim is built. The default default is 10.
33829 .next
33830 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
33831 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
33832 overriding the script's default, which is to find the setting from Exim's
33833 configuration.
33834 .endlist
33835
33836 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
33837 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
33838 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
33839 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
33840 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
33841 logs are handled similarly.
33842
33843 If the limit is greater than 99, the script uses 3-digit numbers such as
33844 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
33845 to one that is greater, or &'vice versa'&, you will have to fix the names of
33846 any existing log files.
33847
33848 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
33849 the end are deleted. All files with numbers greater than 01 are compressed,
33850 using a compression command which is configured by the COMPRESS_COMMAND
33851 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
33852 root &%crontab%& entry of the form
33853 .code
33854 1 0 * * * su exim -c /usr/exim/bin/exicyclog
33855 .endd
33856 assuming you have used the name &"exim"& for the Exim user. You can run
33857 &'exicyclog'& as root if you wish, but there is no need.
33858
33859
33860
33861 .section "Mail statistics (eximstats)" "SECTmailstat"
33862 .cindex "statistics"
33863 .cindex "&'eximstats'&"
33864 A Perl script called &'eximstats'& is provided for extracting statistical
33865 information from log files. The output is either plain text, or HTML.
33866 Exim log files are also supported by the &'Lire'& system produced by the
33867 LogReport Foundation &url(http://www.logreport.org).
33868
33869 The &'eximstats'& script has been hacked about quite a bit over time. The
33870 latest version is the result of some extensive revision by Steve Campbell. A
33871 lot of information is given by default, but there are options for suppressing
33872 various parts of it. Following any options, the arguments to the script are a
33873 list of files, which should be main log files. For example:
33874 .code
33875 eximstats -nr /var/spool/exim/log/mainlog.01
33876 .endd
33877 By default, &'eximstats'& extracts information about the number and volume of
33878 messages received from or delivered to various hosts. The information is sorted
33879 both by message count and by volume, and the top fifty hosts in each category
33880 are listed on the standard output. Similar information, based on email
33881 addresses or domains instead of hosts can be requested by means of various
33882 options. For messages delivered and received locally, similar statistics are
33883 also produced per user.
33884
33885 The output also includes total counts and statistics about delivery errors, and
33886 histograms showing the number of messages received and deliveries made in each
33887 hour of the day. A delivery with more than one address in its envelope (for
33888 example, an SMTP transaction with more than one RCPT command) is counted
33889 as a single delivery by &'eximstats'&.
33890
33891 Though normally more deliveries than receipts are reported (as messages may
33892 have multiple recipients), it is possible for &'eximstats'& to report more
33893 messages received than delivered, even though the queue is empty at the start
33894 and end of the period in question. If an incoming message contains no valid
33895 recipients, no deliveries are recorded for it. A bounce message is handled as
33896 an entirely separate message.
33897
33898 &'eximstats'& always outputs a grand total summary giving the volume and number
33899 of messages received and deliveries made, and the number of hosts involved in
33900 each case. It also outputs the number of messages that were delayed (that is,
33901 not completely delivered at the first attempt), and the number that had at
33902 least one address that failed.
33903
33904 The remainder of the output is in sections that can be independently disabled
33905 or modified by various options. It consists of a summary of deliveries by
33906 transport, histograms of messages received and delivered per time interval
33907 (default per hour), information about the time messages spent on the queue,
33908 a list of relayed messages, lists of the top fifty sending hosts, local
33909 senders, destination hosts, and destination local users by count and by volume,
33910 and a list of delivery errors that occurred.
33911
33912 The relay information lists messages that were actually relayed, that is, they
33913 came from a remote host and were directly delivered to some other remote host,
33914 without being processed (for example, for aliasing or forwarding) locally.
33915
33916 There are quite a few options for &'eximstats'& to control exactly what it
33917 outputs. These are documented in the Perl script itself, and can be extracted
33918 by running the command &(perldoc)& on the script. For example:
33919 .code
33920 perldoc /usr/exim/bin/eximstats
33921 .endd
33922
33923 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
33924 .cindex "&'exim_checkaccess'&"
33925 .cindex "policy control" "checking access"
33926 .cindex "checking access"
33927 The &%-bh%& command line argument allows you to run a fake SMTP session with
33928 debugging output, in order to check what Exim is doing when it is applying
33929 policy controls to incoming SMTP mail. However, not everybody is sufficiently
33930 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
33931 sometimes you just want to answer the question &"Does this address have
33932 access?"& without bothering with any further details.
33933
33934 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
33935 two arguments, an IP address and an email address:
33936 .code
33937 exim_checkaccess 10.9.8.7 A.User@a.domain.example
33938 .endd
33939 The utility runs a call to Exim with the &%-bh%& option, to test whether the
33940 given email address would be accepted in a RCPT command in a TCP/IP
33941 connection from the host with the given IP address. The output of the utility
33942 is either the word &"accepted"&, or the SMTP error response, for example:
33943 .code
33944 Rejected:
33945 550 Relay not permitted
33946 .endd
33947 When running this test, the utility uses &`<>`& as the envelope sender address
33948 for the MAIL command, but you can change this by providing additional
33949 options. These are passed directly to the Exim command. For example, to specify
33950 that the test is to be run with the sender address &'himself@there.example'&
33951 you can use:
33952 .code
33953 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
33954                  -f himself@there.example
33955 .endd
33956 Note that these additional Exim command line items must be given after the two
33957 mandatory arguments.
33958
33959 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
33960 while running its checks. You can run checks that include callouts by using
33961 &%-bhc%&, but this is not yet available in a &"packaged"& form.
33962
33963
33964
33965 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
33966 .cindex "DBM" "building dbm files"
33967 .cindex "building DBM files"
33968 .cindex "&'exim_dbmbuild'&"
33969 .cindex "lower casing"
33970 .cindex "binary zero" "in lookup key"
33971 The &'exim_dbmbuild'& program reads an input file containing keys and data in
33972 the format used by the &(lsearch)& lookup (see section
33973 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
33974 names as keys and the remainder of the information as data. The lower-casing
33975 can be prevented by calling the program with the &%-nolc%& option.
33976
33977 A terminating zero is included as part of the key string. This is expected by
33978 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
33979 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
33980 strings or the data strings. The &(dbmnz)& lookup type can be used with such
33981 files.
33982
33983 The program requires two arguments: the name of the input file (which can be a
33984 single hyphen to indicate the standard input), and the name of the output file.
33985 It creates the output under a temporary name, and then renames it if all went
33986 well.
33987
33988 .cindex "USE_DB"
33989 If the native DB interface is in use (USE_DB is set in a compile-time
33990 configuration file &-- this is common in free versions of Unix) the two file
33991 names must be different, because in this mode the Berkeley DB functions create
33992 a single output file using exactly the name given. For example,
33993 .code
33994 exim_dbmbuild /etc/aliases /etc/aliases.db
33995 .endd
33996 reads the system alias file and creates a DBM version of it in
33997 &_/etc/aliases.db_&.
33998
33999 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34000 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34001 environment, the suffixes are added to the second argument of
34002 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34003 when the Berkeley functions are used in compatibility mode (though this is not
34004 recommended), because in that case it adds a &_.db_& suffix to the file name.
34005
34006 If a duplicate key is encountered, the program outputs a warning, and when it
34007 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34008 option is used. By default, only the first of a set of duplicates is used &--
34009 this makes it compatible with &(lsearch)& lookups. There is an option
34010 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34011 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34012 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34013 return code is 2.
34014
34015
34016
34017
34018 .section "Finding individual retry times (exinext)" "SECTfinindret"
34019 .cindex "retry" "times"
34020 .cindex "&'exinext'&"
34021 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34022 fish specific information out of the retry database. Given a mail domain (or a
34023 complete address), it looks up the hosts for that domain, and outputs any retry
34024 information for the hosts or for the domain. At present, the retry information
34025 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34026 output. For example:
34027 .code
34028 $ exinext piglet@milne.fict.example
34029 kanga.milne.example:192.168.8.1 error 146: Connection refused
34030   first failed: 21-Feb-1996 14:57:34
34031   last tried:   21-Feb-1996 14:57:34
34032   next try at:  21-Feb-1996 15:02:34
34033 roo.milne.example:192.168.8.3 error 146: Connection refused
34034   first failed: 20-Jan-1996 13:12:08
34035   last tried:   21-Feb-1996 11:42:03
34036   next try at:  21-Feb-1996 19:42:03
34037   past final cutoff time
34038 .endd
34039 You can also give &'exinext'& a local part, without a domain, and it
34040 will give any retry information for that local part in your default domain.
34041 A message id can be used to obtain retry information pertaining to a specific
34042 message. This exists only when an attempt to deliver a message to a remote host
34043 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34044 &'exinext'& is not particularly efficient, but then it is not expected to be
34045 run very often.
34046
34047 The &'exinext'& utility calls Exim to find out information such as the location
34048 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
34049 passed on to the &'exim'& commands. The first specifies an alternate Exim
34050 configuration file, and the second sets macros for use within the configuration
34051 file. These features are mainly to help in testing, but might also be useful in
34052 environments where more than one configuration file is in use.
34053
34054
34055
34056 .section "Hints database maintenance" "SECThindatmai"
34057 .cindex "hints database" "maintenance"
34058 .cindex "maintaining Exim's hints database"
34059 Three utility programs are provided for maintaining the DBM files that Exim
34060 uses to contain its delivery hint information. Each program requires two
34061 arguments. The first specifies the name of Exim's spool directory, and the
34062 second is the name of the database it is to operate on. These are as follows:
34063
34064 .ilist
34065 &'retry'&: the database of retry information
34066 .next
34067 &'wait-'&<&'transport name'&>: databases of information about messages waiting
34068 for remote hosts
34069 .next
34070 &'callout'&: the callout cache
34071 .next
34072 &'ratelimit'&: the data for implementing the ratelimit ACL condition
34073 .next
34074 &'misc'&: other hints data
34075 .endlist
34076
34077 The &'misc'& database is used for
34078
34079 .ilist
34080 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
34081 .next
34082 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
34083 &(smtp)& transport)
34084 .endlist
34085
34086
34087
34088 .section "exim_dumpdb" "SECID261"
34089 .cindex "&'exim_dumpdb'&"
34090 The entire contents of a database are written to the standard output by the
34091 &'exim_dumpdb'& program, which has no options or arguments other than the
34092 spool and database names. For example, to dump the retry database:
34093 .code
34094 exim_dumpdb /var/spool/exim retry
34095 .endd
34096 Two lines of output are produced for each entry:
34097 .code
34098 T:mail.ref.example:192.168.242.242 146 77 Connection refused
34099 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
34100 .endd
34101 The first item on the first line is the key of the record. It starts with one
34102 of the letters R, or T, depending on whether it refers to a routing or
34103 transport retry. For a local delivery, the next part is the local address; for
34104 a remote delivery it is the name of the remote host, followed by its failing IP
34105 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
34106 transport). If the remote port is not the standard one (port 25), it is added
34107 to the IP address. Then there follows an error code, an additional error code,
34108 and a textual description of the error.
34109
34110 The three times on the second line are the time of first failure, the time of
34111 the last delivery attempt, and the computed time for the next attempt. The line
34112 ends with an asterisk if the cutoff time for the last retry rule has been
34113 exceeded.
34114
34115 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
34116 consists of a host name followed by a list of ids for messages that are or were
34117 waiting to be delivered to that host. If there are a very large number for any
34118 one host, continuation records, with a sequence number added to the host name,
34119 may be seen. The data in these records is often out of date, because a message
34120 may be routed to several alternative hosts, and Exim makes no effort to keep
34121 cross-references.
34122
34123
34124
34125 .section "exim_tidydb" "SECID262"
34126 .cindex "&'exim_tidydb'&"
34127 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
34128 database. If run with no options, it removes all records that are more than 30
34129 days old. The age is calculated from the date and time that the record was last
34130 updated. Note that, in the case of the retry database, it is &'not'& the time
34131 since the first delivery failure. Information about a host that has been down
34132 for more than 30 days will remain in the database, provided that the record is
34133 updated sufficiently often.
34134
34135 The cutoff date can be altered by means of the &%-t%& option, which must be
34136 followed by a time. For example, to remove all records older than a week from
34137 the retry database:
34138 .code
34139 exim_tidydb -t 7d /var/spool/exim retry
34140 .endd
34141 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
34142 message ids. In the former these appear as data in records keyed by host &--
34143 they were messages that were waiting for that host &-- and in the latter they
34144 are the keys for retry information for messages that have suffered certain
34145 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
34146 message ids in database records are those of messages that are still on the
34147 queue. Message ids for messages that no longer exist are removed from
34148 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
34149 For the &'retry'& database, records whose keys are non-existent message ids are
34150 removed. The &'exim_tidydb'& utility outputs comments on the standard output
34151 whenever it removes information from the database.
34152
34153 Certain records are automatically removed by Exim when they are no longer
34154 needed, but others are not. For example, if all the MX hosts for a domain are
34155 down, a retry record is created for each one. If the primary MX host comes back
34156 first, its record is removed when Exim successfully delivers to it, but the
34157 records for the others remain because Exim has not tried to use those hosts.
34158
34159 It is important, therefore, to run &'exim_tidydb'& periodically on all the
34160 hints databases. You should do this at a quiet time of day, because it requires
34161 a database to be locked (and therefore inaccessible to Exim) while it does its
34162 work. Removing records from a DBM file does not normally make the file smaller,
34163 but all the common DBM libraries are able to re-use the space that is released.
34164 After an initial phase of increasing in size, the databases normally reach a
34165 point at which they no longer get any bigger, as long as they are regularly
34166 tidied.
34167
34168 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
34169 databases is likely to keep on increasing.
34170
34171
34172
34173
34174 .section "exim_fixdb" "SECID263"
34175 .cindex "&'exim_fixdb'&"
34176 The &'exim_fixdb'& program is a utility for interactively modifying databases.
34177 Its main use is for testing Exim, but it might also be occasionally useful for
34178 getting round problems in a live system. It has no options, and its interface
34179 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
34180 key of a database record can then be entered, and the data for that record is
34181 displayed.
34182
34183 If &"d"& is typed at the next prompt, the entire record is deleted. For all
34184 except the &'retry'& database, that is the only operation that can be carried
34185 out. For the &'retry'& database, each field is output preceded by a number, and
34186 data for individual fields can be changed by typing the field number followed
34187 by new data, for example:
34188 .code
34189 > 4 951102:1000
34190 .endd
34191 resets the time of the next delivery attempt. Time values are given as a
34192 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
34193 used as optional separators.
34194
34195
34196
34197
34198 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
34199 .cindex "mailbox" "maintenance"
34200 .cindex "&'exim_lock'&"
34201 .cindex "locking mailboxes"
34202 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
34203 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
34204 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
34205 a user agent while investigating a problem. The utility requires the name of
34206 the file as its first argument. If the locking is successful, the second
34207 argument is run as a command (using C's &[system()]& function); if there is no
34208 second argument, the value of the SHELL environment variable is used; if this
34209 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
34210 is unlocked and the utility ends. The following options are available:
34211
34212 .vlist
34213 .vitem &%-fcntl%&
34214 Use &[fcntl()]& locking on the open mailbox.
34215
34216 .vitem &%-flock%&
34217 Use &[flock()]& locking on the open mailbox, provided the operating system
34218 supports it.
34219
34220 .vitem &%-interval%&
34221 This must be followed by a number, which is a number of seconds; it sets the
34222 interval to sleep between retries (default 3).
34223
34224 .vitem &%-lockfile%&
34225 Create a lock file before opening the mailbox.
34226
34227 .vitem &%-mbx%&
34228 Lock the mailbox using MBX rules.
34229
34230 .vitem &%-q%&
34231 Suppress verification output.
34232
34233 .vitem &%-retries%&
34234 This must be followed by a number; it sets the number of times to try to get
34235 the lock (default 10).
34236
34237 .vitem &%-restore_time%&
34238 This option causes &%exim_lock%& to restore the modified and read times to the
34239 locked file before exiting. This allows you to access a locked mailbox (for
34240 example, to take a backup copy) without disturbing the times that the user
34241 subsequently sees.
34242
34243 .vitem &%-timeout%&
34244 This must be followed by a number, which is a number of seconds; it sets a
34245 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
34246 default), a non-blocking call is used.
34247
34248 .vitem &%-v%&
34249 Generate verbose output.
34250 .endlist
34251
34252 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
34253 default is to create a lock file and also to use &[fcntl()]& locking on the
34254 mailbox, which is the same as Exim's default. The use of &%-flock%& or
34255 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
34256 requires that the directory containing the file be writeable. Locking by lock
34257 file does not last for ever; Exim assumes that a lock file is expired if it is
34258 more than 30 minutes old.
34259
34260 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
34261 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
34262 to be taken out on the open mailbox, and an exclusive lock on the file
34263 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
34264 number of the mailbox file. When the locking is released, if an exclusive lock
34265 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
34266
34267 The default output contains verification of the locking that takes place. The
34268 &%-v%& option causes some additional information to be given. The &%-q%& option
34269 suppresses all output except error messages.
34270
34271 A command such as
34272 .code
34273 exim_lock /var/spool/mail/spqr
34274 .endd
34275 runs an interactive shell while the file is locked, whereas
34276 .display
34277 &`exim_lock -q /var/spool/mail/spqr <<End`&
34278 <&'some commands'&>
34279 &`End`&
34280 .endd
34281 runs a specific non-interactive sequence of commands while the file is locked,
34282 suppressing all verification output. A single command can be run by a command
34283 such as
34284 .code
34285 exim_lock -q /var/spool/mail/spqr \
34286   "cp /var/spool/mail/spqr /some/where"
34287 .endd
34288 Note that if a command is supplied, it must be entirely contained within the
34289 second argument &-- hence the quotes.
34290 .ecindex IIDutils
34291
34292
34293 . ////////////////////////////////////////////////////////////////////////////
34294 . ////////////////////////////////////////////////////////////////////////////
34295
34296 .chapter "The Exim monitor" "CHAPeximon"
34297 .scindex IIDeximon "Exim monitor" "description"
34298 .cindex "X-windows"
34299 .cindex "&'eximon'&"
34300 .cindex "Local/eximon.conf"
34301 .cindex "&_exim_monitor/EDITME_&"
34302 The Exim monitor is an application which displays in an X window information
34303 about the state of Exim's queue and what Exim is doing. An admin user can
34304 perform certain operations on messages from this GUI interface; however all
34305 such facilities are also available from the command line, and indeed, the
34306 monitor itself makes use of the command line to perform any actions requested.
34307
34308
34309
34310 .section "Running the monitor" "SECID264"
34311 The monitor is started by running the script called &'eximon'&. This is a shell
34312 script that sets up a number of environment variables, and then runs the
34313 binary called &_eximon.bin_&. The default appearance of the monitor window can
34314 be changed by editing the &_Local/eximon.conf_& file created by editing
34315 &_exim_monitor/EDITME_&. Comments in that file describe what the various
34316 parameters are for.
34317
34318 The parameters that get built into the &'eximon'& script can be overridden for
34319 a particular invocation by setting up environment variables of the same names,
34320 preceded by &`EXIMON_`&. For example, a shell command such as
34321 .code
34322 EXIMON_LOG_DEPTH=400 eximon
34323 .endd
34324 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
34325 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
34326 overrides the Exim log file configuration. This makes it possible to have
34327 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
34328 syslog messages are routed to a file on the local host.
34329
34330 X resources can be used to change the appearance of the window in the normal
34331 way. For example, a resource setting of the form
34332 .code
34333 Eximon*background: gray94
34334 .endd
34335 changes the colour of the background to light grey rather than white. The
34336 stripcharts are drawn with both the data lines and the reference lines in
34337 black. This means that the reference lines are not visible when on top of the
34338 data. However, their colour can be changed by setting a resource called
34339 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
34340 For example, if your X server is running Unix, you could set up lighter
34341 reference lines in the stripcharts by obeying
34342 .code
34343 xrdb -merge <<End
34344 Eximon*highlight: gray
34345 End
34346 .endd
34347 .cindex "admin user"
34348 In order to see the contents of messages on the queue, and to operate on them,
34349 &'eximon'& must either be run as root or by an admin user.
34350
34351 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
34352 contain X11 resource parameters interpreted by the X11 library.  In addition,
34353 if the first parameter starts with the string "gdb" then it is removed and the
34354 binary is invoked under gdb (the parameter is used as the gdb command-name, so
34355 versioned variants of gdb can be invoked).
34356
34357 The monitor's window is divided into three parts. The first contains one or
34358 more stripcharts and two action buttons, the second contains a &"tail"& of the
34359 main log file, and the third is a display of the queue of messages awaiting
34360 delivery, with two more action buttons. The following sections describe these
34361 different parts of the display.
34362
34363
34364
34365
34366 .section "The stripcharts" "SECID265"
34367 .cindex "stripchart"
34368 The first stripchart is always a count of messages on the queue. Its name can
34369 be configured by setting QUEUE_STRIPCHART_NAME in the
34370 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
34371 configuration script by regular expression matches on log file entries, making
34372 it possible to display, for example, counts of messages delivered to certain
34373 hosts or using certain transports. The supplied defaults display counts of
34374 received and delivered messages, and of local and SMTP deliveries. The default
34375 period between stripchart updates is one minute; this can be adjusted by a
34376 parameter in the &_Local/eximon.conf_& file.
34377
34378 The stripchart displays rescale themselves automatically as the value they are
34379 displaying changes. There are always 10 horizontal lines in each chart; the
34380 title string indicates the value of each division when it is greater than one.
34381 For example, &"x2"& means that each division represents a value of 2.
34382
34383 It is also possible to have a stripchart which shows the percentage fullness of
34384 a particular disk partition, which is useful when local deliveries are confined
34385 to a single partition.
34386
34387 .cindex "&%statvfs%& function"
34388 This relies on the availability of the &[statvfs()]& function or equivalent in
34389 the operating system. Most, but not all versions of Unix that support Exim have
34390 this. For this particular stripchart, the top of the chart always represents
34391 100%, and the scale is given as &"x10%"&. This chart is configured by setting
34392 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
34393 &_Local/eximon.conf_& file.
34394
34395
34396
34397
34398 .section "Main action buttons" "SECID266"
34399 .cindex "size" "of monitor window"
34400 .cindex "Exim monitor" "window size"
34401 .cindex "window size"
34402 Below the stripcharts there is an action button for quitting the monitor. Next
34403 to this is another button marked &"Size"&. They are placed here so that
34404 shrinking the window to its default minimum size leaves just the queue count
34405 stripchart and these two buttons visible. Pressing the &"Size"& button causes
34406 the window to expand to its maximum size, unless it is already at the maximum,
34407 in which case it is reduced to its minimum.
34408
34409 When expanding to the maximum, if the window cannot be fully seen where it
34410 currently is, it is moved back to where it was the last time it was at full
34411 size. When it is expanding from its minimum size, the old position is
34412 remembered, and next time it is reduced to the minimum it is moved back there.
34413
34414 The idea is that you can keep a reduced window just showing one or two
34415 stripcharts at a convenient place on your screen, easily expand it to show
34416 the full window when required, and just as easily put it back to what it was.
34417 The idea is copied from what the &'twm'& window manager does for its
34418 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
34419 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
34420
34421 Normally, the monitor starts up with the window at its full size, but it can be
34422 built so that it starts up with the window at its smallest size, by setting
34423 START_SMALL=yes in &_Local/eximon.conf_&.
34424
34425
34426
34427 .section "The log display" "SECID267"
34428 .cindex "log" "tail of; in monitor"
34429 The second section of the window is an area in which a display of the tail of
34430 the main log is maintained.
34431 To save space on the screen, the timestamp on each log line is shortened by
34432 removing the date and, if &%log_timezone%& is set, the timezone.
34433 The log tail is not available when the only destination for logging data is
34434 syslog, unless the syslog lines are routed to a local file whose name is passed
34435 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
34436
34437 The log sub-window has a scroll bar at its lefthand side which can be used to
34438 move back to look at earlier text, and the up and down arrow keys also have a
34439 scrolling effect. The amount of log that is kept depends on the setting of
34440 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
34441 to use. When this is full, the earlier 50% of data is discarded &-- this is
34442 much more efficient than throwing it away line by line. The sub-window also has
34443 a horizontal scroll bar for accessing the ends of long log lines. This is the
34444 only means of horizontal scrolling; the right and left arrow keys are not
34445 available. Text can be cut from this part of the window using the mouse in the
34446 normal way. The size of this subwindow is controlled by parameters in the
34447 configuration file &_Local/eximon.conf_&.
34448
34449 Searches of the text in the log window can be carried out by means of the ^R
34450 and ^S keystrokes, which default to a reverse and a forward search,
34451 respectively. The search covers only the text that is displayed in the window.
34452 It cannot go further back up the log.
34453
34454 The point from which the search starts is indicated by a caret marker. This is
34455 normally at the end of the text in the window, but can be positioned explicitly
34456 by pointing and clicking with the left mouse button, and is moved automatically
34457 by a successful search. If new text arrives in the window when it is scrolled
34458 back, the caret remains where it is, but if the window is not scrolled back,
34459 the caret is moved to the end of the new text.
34460
34461 Pressing ^R or ^S pops up a window into which the search text can be typed.
34462 There are buttons for selecting forward or reverse searching, for carrying out
34463 the search, and for cancelling. If the &"Search"& button is pressed, the search
34464 happens and the window remains so that further searches can be done. If the
34465 &"Return"& key is pressed, a single search is done and the window is closed. If
34466 ^C is typed the search is cancelled.
34467
34468 The searching facility is implemented using the facilities of the Athena text
34469 widget. By default this pops up a window containing both &"search"& and
34470 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
34471 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
34472 However, the linkers in BSDI and HP-UX seem unable to handle an externally
34473 provided version of &%TextPop%& when the remaining parts of the text widget
34474 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
34475 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
34476 on these systems, at the expense of having unwanted items in the search popup
34477 window.
34478
34479
34480
34481 .section "The queue display" "SECID268"
34482 .cindex "queue" "display in monitor"
34483 The bottom section of the monitor window contains a list of all messages that
34484 are on the queue, which includes those currently being received or delivered,
34485 as well as those awaiting delivery. The size of this subwindow is controlled by
34486 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
34487 at which it is updated is controlled by another parameter in the same file &--
34488 the default is 5 minutes, since queue scans can be quite expensive. However,
34489 there is an &"Update"& action button just above the display which can be used
34490 to force an update of the queue display at any time.
34491
34492 When a host is down for some time, a lot of pending mail can build up for it,
34493 and this can make it hard to deal with other messages on the queue. To help
34494 with this situation there is a button next to &"Update"& called &"Hide"&. If
34495 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
34496 type anything in here and press &"Return"&, the text is added to a chain of
34497 such texts, and if every undelivered address in a message matches at least one
34498 of the texts, the message is not displayed.
34499
34500 If there is an address that does not match any of the texts, all the addresses
34501 are displayed as normal. The matching happens on the ends of addresses so, for
34502 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
34503 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
34504 has been set up, a button called &"Unhide"& is displayed. If pressed, it
34505 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
34506 a hide request is automatically cancelled after one hour.
34507
34508 While the dialogue box is displayed, you can't press any buttons or do anything
34509 else to the monitor window. For this reason, if you want to cut text from the
34510 queue display to use in the dialogue box, you have to do the cutting before
34511 pressing the &"Hide"& button.
34512
34513 The queue display contains, for each unhidden queued message, the length of
34514 time it has been on the queue, the size of the message, the message id, the
34515 message sender, and the first undelivered recipient, all on one line. If it is
34516 a bounce message, the sender is shown as &"<>"&. If there is more than one
34517 recipient to which the message has not yet been delivered, subsequent ones are
34518 listed on additional lines, up to a maximum configured number, following which
34519 an ellipsis is displayed. Recipients that have already received the message are
34520 not shown.
34521
34522 .cindex "frozen messages" "display"
34523 If a message is frozen, an asterisk is displayed at the left-hand side.
34524
34525 The queue display has a vertical scroll bar, and can also be scrolled by means
34526 of the arrow keys. Text can be cut from it using the mouse in the normal way.
34527 The text searching facilities, as described above for the log window, are also
34528 available, but the caret is always moved to the end of the text when the queue
34529 display is updated.
34530
34531
34532
34533 .section "The queue menu" "SECID269"
34534 .cindex "queue" "menu in monitor"
34535 If the &%shift%& key is held down and the left button is clicked when the mouse
34536 pointer is over the text for any message, an action menu pops up, and the first
34537 line of the queue display for the message is highlighted. This does not affect
34538 any selected text.
34539
34540 If you want to use some other event for popping up the menu, you can set the
34541 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
34542 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
34543 value set in this parameter is a standard X event description. For example, to
34544 run eximon using &%ctrl%& rather than &%shift%& you could use
34545 .code
34546 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
34547 .endd
34548 The title of the menu is the message id, and it contains entries which act as
34549 follows:
34550
34551 .ilist
34552 &'message log'&: The contents of the message log for the message are displayed
34553 in a new text window.
34554 .next
34555 &'headers'&: Information from the spool file that contains the envelope
34556 information and headers is displayed in a new text window. See chapter
34557 &<<CHAPspool>>& for a description of the format of spool files.
34558 .next
34559 &'body'&: The contents of the spool file containing the body of the message are
34560 displayed in a new text window. There is a default limit of 20,000 bytes to the
34561 amount of data displayed. This can be changed by setting the BODY_MAX
34562 option at compile time, or the EXIMON_BODY_MAX option at run time.
34563 .next
34564 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
34565 delivery of the message. This causes an automatic thaw if the message is
34566 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
34567 a new text window. The delivery is run in a separate process, to avoid holding
34568 up the monitor while the delivery proceeds.
34569 .next
34570 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
34571 that the message be frozen.
34572 .next
34573 .cindex "thawing messages"
34574 .cindex "unfreezing messages"
34575 .cindex "frozen messages" "thawing"
34576 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
34577 that the message be thawed.
34578 .next
34579 .cindex "delivery" "forcing failure"
34580 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
34581 that Exim gives up trying to deliver the message. A bounce message is generated
34582 for any remaining undelivered addresses.
34583 .next
34584 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
34585 that the message be deleted from the system without generating a bounce
34586 message.
34587 .next
34588 &'add recipient'&: A dialog box is displayed into which a recipient address can
34589 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34590 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34591 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34592 causes a call to Exim to be made using the &%-Mar%& option to request that an
34593 additional recipient be added to the message, unless the entry box is empty, in
34594 which case no action is taken.
34595 .next
34596 &'mark delivered'&: A dialog box is displayed into which a recipient address
34597 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34598 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34599 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34600 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
34601 recipient address as already delivered, unless the entry box is empty, in which
34602 case no action is taken.
34603 .next
34604 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
34605 mark all recipient addresses as already delivered.
34606 .next
34607 &'edit sender'&: A dialog box is displayed initialized with the current
34608 sender's address. Pressing RETURN causes a call to Exim to be made using the
34609 &%-Mes%& option to replace the sender address, unless the entry box is empty,
34610 in which case no action is taken. If you want to set an empty sender (as in
34611 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
34612 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
34613 the address is qualified with that domain.
34614 .endlist
34615
34616 When a delivery is forced, a window showing the &%-v%& output is displayed. In
34617 other cases when a call to Exim is made, if there is any output from Exim (in
34618 particular, if the command fails) a window containing the command and the
34619 output is displayed. Otherwise, the results of the action are normally apparent
34620 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
34621 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
34622 if no output is generated.
34623
34624 The queue display is automatically updated for actions such as freezing and
34625 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
34626 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
34627 force an update of the display after one of these actions.
34628
34629 In any text window that is displayed as result of a menu action, the normal
34630 cut-and-paste facility is available, and searching can be carried out using ^R
34631 and ^S, as described above for the log tail window.
34632 .ecindex IIDeximon
34633
34634
34635
34636
34637
34638 . ////////////////////////////////////////////////////////////////////////////
34639 . ////////////////////////////////////////////////////////////////////////////
34640
34641 .chapter "Security considerations" "CHAPsecurity"
34642 .scindex IIDsecurcon "security" "discussion of"
34643 This chapter discusses a number of issues concerned with security, some of
34644 which are also covered in other parts of this manual.
34645
34646 For reasons that this author does not understand, some people have promoted
34647 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
34648 existence of this chapter in the documentation. However, the intent of the
34649 chapter is simply to describe the way Exim works in relation to certain
34650 security concerns, not to make any specific claims about the effectiveness of
34651 its security as compared with other MTAs.
34652
34653 What follows is a description of the way Exim is supposed to be. Best efforts
34654 have been made to try to ensure that the code agrees with the theory, but an
34655 absence of bugs can never be guaranteed. Any that are reported will get fixed
34656 as soon as possible.
34657
34658
34659 .section "Building a more &""hardened""& Exim" "SECID286"
34660 .cindex "security" "build-time features"
34661 There are a number of build-time options that can be set in &_Local/Makefile_&
34662 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
34663 Exim administrator who does not have the root password, or by someone who has
34664 penetrated the Exim (but not the root) account. These options are as follows:
34665
34666 .ilist
34667 ALT_CONFIG_PREFIX can be set to a string that is required to match the
34668 start of any file names used with the &%-C%& option. When it is set, these file
34669 names are also not allowed to contain the sequence &"/../"&. (However, if the
34670 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
34671 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
34672 default setting for &%ALT_CONFIG_PREFIX%&.
34673
34674 If the permitted configuration files are confined to a directory to
34675 which only root has access, this guards against someone who has broken
34676 into the Exim account from running a privileged Exim with an arbitrary
34677 configuration file, and using it to break into other accounts.
34678 .next
34679
34680 If a non-trusted configuration file (i.e. not the default configuration file
34681 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
34682 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
34683 the next item), then root privilege is retained only if the caller of Exim is
34684 root. This locks out the possibility of testing a configuration using &%-C%&
34685 right through message reception and delivery, even if the caller is root. The
34686 reception works, but by that time, Exim is running as the Exim user, so when
34687 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
34688 privilege to be lost. However, root can test reception and delivery using two
34689 separate commands.
34690
34691 .next
34692 The WHITELIST_D_MACROS build option declares some macros to be safe to override
34693 with &%-D%& if the real uid is one of root, the Exim run-time user or the
34694 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
34695 requiring the run-time value supplied to &%-D%& to match a regex that errs on
34696 the restrictive side.  Requiring build-time selection of safe macros is onerous
34697 but this option is intended solely as a transition mechanism to permit
34698 previously-working configurations to continue to work after release 4.73.
34699 .next
34700 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
34701 is disabled.
34702 .next
34703 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
34704 never to be used for any deliveries. This is like the &%never_users%& runtime
34705 option, but it cannot be overridden; the runtime option adds additional users
34706 to the list. The default setting is &"root"&; this prevents a non-root user who
34707 is permitted to modify the runtime file from using Exim as a way to get root.
34708 .endlist
34709
34710
34711
34712 .section "Root privilege" "SECID270"
34713 .cindex "setuid"
34714 .cindex "root privilege"
34715 The Exim binary is normally setuid to root, which means that it gains root
34716 privilege (runs as root) when it starts execution. In some special cases (for
34717 example, when the daemon is not in use and there are no local deliveries), it
34718 may be possible to run Exim setuid to some user other than root. This is
34719 discussed in the next section. However, in most installations, root privilege
34720 is required for two things:
34721
34722 .ilist
34723 To set up a socket connected to the standard SMTP port (25) when initialising
34724 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
34725 not required.
34726 .next
34727 To be able to change uid and gid in order to read users' &_.forward_& files and
34728 perform local deliveries as the receiving user or as specified in the
34729 configuration.
34730 .endlist
34731
34732 It is not necessary to be root to do any of the other things Exim does, such as
34733 receiving messages and delivering them externally over SMTP, and it is
34734 obviously more secure if Exim does not run as root except when necessary.
34735 For this reason, a user and group for Exim to use must be defined in
34736 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
34737 group"&. Their values can be changed by the run time configuration, though this
34738 is not recommended. Often a user called &'exim'& is used, but some sites use
34739 &'mail'& or another user name altogether.
34740
34741 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
34742 abdication; the process cannot regain root afterwards. Prior to release 4.00,
34743 &[seteuid()]& was used in some circumstances, but this is no longer the case.
34744
34745 After a new Exim process has interpreted its command line options, it changes
34746 uid and gid in the following cases:
34747
34748 .ilist
34749 .oindex "&%-C%&"
34750 .oindex "&%-D%&"
34751 If the &%-C%& option is used to specify an alternate configuration file, or if
34752 the &%-D%& option is used to define macro values for the configuration, and the
34753 calling process is not running as root, the uid and gid are changed to those of
34754 the calling process.
34755 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
34756 option may not be used at all.
34757 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
34758 can be supplied if the calling process is running as root, the Exim run-time
34759 user or CONFIGURE_OWNER, if defined.
34760 .next
34761 .oindex "&%-be%&"
34762 .oindex "&%-bf%&"
34763 .oindex "&%-bF%&"
34764 If the expansion test option (&%-be%&) or one of the filter testing options
34765 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
34766 calling process.
34767 .next
34768 If the process is not a daemon process or a queue runner process or a delivery
34769 process or a process for testing address routing (started with &%-bt%&), the
34770 uid and gid are changed to the Exim user and group. This means that Exim always
34771 runs under its own uid and gid when receiving messages. This also applies when
34772 testing address verification
34773 .oindex "&%-bv%&"
34774 .oindex "&%-bh%&"
34775 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
34776 option).
34777 .next
34778 For a daemon, queue runner, delivery, or address testing process, the uid
34779 remains as root at this stage, but the gid is changed to the Exim group.
34780 .endlist
34781
34782 The processes that initially retain root privilege behave as follows:
34783
34784 .ilist
34785 A daemon process changes the gid to the Exim group and the uid to the Exim
34786 user after setting up one or more listening sockets. The &[initgroups()]&
34787 function is called, so that if the Exim user is in any additional groups, they
34788 will be used during message reception.
34789 .next
34790 A queue runner process retains root privilege throughout its execution. Its
34791 job is to fork a controlled sequence of delivery processes.
34792 .next
34793 A delivery process retains root privilege throughout most of its execution,
34794 but any actual deliveries (that is, the transports themselves) are run in
34795 subprocesses which always change to a non-root uid and gid. For local
34796 deliveries this is typically the uid and gid of the owner of the mailbox; for
34797 remote deliveries, the Exim uid and gid are used. Once all the delivery
34798 subprocesses have been run, a delivery process changes to the Exim uid and gid
34799 while doing post-delivery tidying up such as updating the retry database and
34800 generating bounce and warning messages.
34801
34802 While the recipient addresses in a message are being routed, the delivery
34803 process runs as root. However, if a user's filter file has to be processed,
34804 this is done in a subprocess that runs under the individual user's uid and
34805 gid. A system filter is run as root unless &%system_filter_user%& is set.
34806 .next
34807 A process that is testing addresses (the &%-bt%& option) runs as root so that
34808 the routing is done in the same environment as a message delivery.
34809 .endlist
34810
34811
34812
34813
34814 .section "Running Exim without privilege" "SECTrunexiwitpri"
34815 .cindex "privilege, running without"
34816 .cindex "unprivileged running"
34817 .cindex "root privilege" "running without"
34818 Some installations like to run Exim in an unprivileged state for more of its
34819 operation, for added security. Support for this mode of operation is provided
34820 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
34821 gid are changed to the Exim user and group at the start of a delivery process
34822 (and also queue runner and address testing processes). This means that address
34823 routing is no longer run as root, and the deliveries themselves cannot change
34824 to any other uid.
34825
34826 .cindex SIGHUP
34827 .cindex "daemon" "restarting"
34828 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
34829 that the daemon can still be started in the usual way, and it can respond
34830 correctly to SIGHUP because the re-invocation regains root privilege.
34831
34832 An alternative approach is to make Exim setuid to the Exim user and also setgid
34833 to the Exim group. If you do this, the daemon must be started from a root
34834 process. (Calling Exim from a root process makes it behave in the way it does
34835 when it is setuid root.) However, the daemon cannot restart itself after a
34836 SIGHUP signal because it cannot regain privilege.
34837
34838 It is still useful to set &%deliver_drop_privilege%& in this case, because it
34839 stops Exim from trying to re-invoke itself to do a delivery after a message has
34840 been received. Such a re-invocation is a waste of resources because it has no
34841 effect.
34842
34843 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
34844 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
34845 to the Exim user seems a clean approach, but there is one complication:
34846
34847 In this style of operation, Exim is running with the real uid and gid set to
34848 those of the calling process, and the effective uid/gid set to Exim's values.
34849 Ideally, any association with the calling process' uid/gid should be dropped,
34850 that is, the real uid/gid should be reset to the effective values so as to
34851 discard any privileges that the caller may have. While some operating systems
34852 have a function that permits this action for a non-root effective uid, quite a
34853 number of them do not. Because of this lack of standardization, Exim does not
34854 address this problem at this time.
34855
34856 For this reason, the recommended approach for &"mostly unprivileged"& running
34857 is to keep the Exim binary setuid to root, and to set
34858 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
34859 be used in the most straightforward way.
34860
34861 If you configure Exim not to run delivery processes as root, there are a
34862 number of restrictions on what you can do:
34863
34864 .ilist
34865 You can deliver only as the Exim user/group. You should  explicitly use the
34866 &%user%& and &%group%& options to override routers or local transports that
34867 normally deliver as the recipient. This makes sure that configurations that
34868 work in this mode function the same way in normal mode. Any implicit or
34869 explicit specification of another user causes an error.
34870 .next
34871 Use of &_.forward_& files is severely restricted, such that it is usually
34872 not worthwhile to include them in the configuration.
34873 .next
34874 Users who wish to use &_.forward_& would have to make their home directory and
34875 the file itself accessible to the Exim user. Pipe and append-to-file entries,
34876 and their equivalents in Exim filters, cannot be used. While they could be
34877 enabled in the Exim user's name, that would be insecure and not very useful.
34878 .next
34879 Unless the local user mailboxes are all owned by the Exim user (possible in
34880 some POP3 or IMAP-only environments):
34881
34882 .olist
34883 They must be owned by the Exim group and be writeable by that group. This
34884 implies you must set &%mode%& in the appendfile configuration, as well as the
34885 mode of the mailbox files themselves.
34886 .next
34887 You must set &%no_check_owner%&, since most or all of the files will not be
34888 owned by the Exim user.
34889 .next
34890 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
34891 on a newly created mailbox when unprivileged. This also implies that new
34892 mailboxes need to be created manually.
34893 .endlist olist
34894 .endlist ilist
34895
34896
34897 These restrictions severely restrict what can be done in local deliveries.
34898 However, there are no restrictions on remote deliveries. If you are running a
34899 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
34900 gives more security at essentially no cost.
34901
34902 If you are using the &%mua_wrapper%& facility (see chapter
34903 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
34904
34905
34906
34907
34908 .section "Delivering to local files" "SECID271"
34909 Full details of the checks applied by &(appendfile)& before it writes to a file
34910 are given in chapter &<<CHAPappendfile>>&.
34911
34912
34913
34914 .section "IPv4 source routing" "SECID272"
34915 .cindex "source routing" "in IP packets"
34916 .cindex "IP source routing"
34917 Many operating systems suppress IP source-routed packets in the kernel, but
34918 some cannot be made to do this, so Exim does its own check. It logs incoming
34919 IPv4 source-routed TCP calls, and then drops them. Things are all different in
34920 IPv6. No special checking is currently done.
34921
34922
34923
34924 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
34925 Support for these SMTP commands is disabled by default. If required, they can
34926 be enabled by defining suitable ACLs.
34927
34928
34929
34930
34931 .section "Privileged users" "SECID274"
34932 .cindex "trusted users"
34933 .cindex "admin user"
34934 .cindex "privileged user"
34935 .cindex "user" "trusted"
34936 .cindex "user" "admin"
34937 Exim recognizes two sets of users with special privileges. Trusted users are
34938 able to submit new messages to Exim locally, but supply their own sender
34939 addresses and information about a sending host. For other users submitting
34940 local messages, Exim sets up the sender address from the uid, and doesn't
34941 permit a remote host to be specified.
34942
34943 .oindex "&%-f%&"
34944 However, an untrusted user is permitted to use the &%-f%& command line option
34945 in the special form &%-f <>%& to indicate that a delivery failure for the
34946 message should not cause an error report. This affects the message's envelope,
34947 but it does not affect the &'Sender:'& header. Untrusted users may also be
34948 permitted to use specific forms of address with the &%-f%& option by setting
34949 the &%untrusted_set_sender%& option.
34950
34951 Trusted users are used to run processes that receive mail messages from some
34952 other mail domain and pass them on to Exim for delivery either locally, or over
34953 the Internet. Exim trusts a caller that is running as root, as the Exim user,
34954 as any user listed in the &%trusted_users%& configuration option, or under any
34955 group listed in the &%trusted_groups%& option.
34956
34957 Admin users are permitted to do things to the messages on Exim's queue. They
34958 can freeze or thaw messages, cause them to be returned to their senders, remove
34959 them entirely, or modify them in various ways. In addition, admin users can run
34960 the Exim monitor and see all the information it is capable of providing, which
34961 includes the contents of files on the spool.
34962
34963 .oindex "&%-M%&"
34964 .oindex "&%-q%&"
34965 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
34966 delivery of messages on its queue is restricted to admin users. This
34967 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
34968 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
34969 queue is also restricted to admin users. This restriction can be relaxed by
34970 setting &%no_queue_list_requires_admin%&.
34971
34972 Exim recognizes an admin user if the calling process is running as root or as
34973 the Exim user or if any of the groups associated with the calling process is
34974 the Exim group. It is not necessary actually to be running under the Exim
34975 group. However, if admin users who are not root or the Exim user are to access
34976 the contents of files on the spool via the Exim monitor (which runs
34977 unprivileged), Exim must be built to allow group read access to its spool
34978 files.
34979
34980
34981
34982 .section "Spool files" "SECID275"
34983 .cindex "spool directory" "files"
34984 Exim's spool directory and everything it contains is owned by the Exim user and
34985 set to the Exim group. The mode for spool files is defined in the
34986 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
34987 any user who is a member of the Exim group can access these files.
34988
34989
34990
34991 .section "Use of argv[0]" "SECID276"
34992 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
34993 of specific strings, Exim assumes certain options. For example, calling Exim
34994 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
34995 to calling it with the option &%-bS%&. There are no security implications in
34996 this.
34997
34998
34999
35000 .section "Use of %f formatting" "SECID277"
35001 The only use made of &"%f"& by Exim is in formatting load average values. These
35002 are actually stored in integer variables as 1000 times the load average.
35003 Consequently, their range is limited and so therefore is the length of the
35004 converted output.
35005
35006
35007
35008 .section "Embedded Exim path" "SECID278"
35009 Exim uses its own path name, which is embedded in the code, only when it needs
35010 to re-exec in order to regain root privilege. Therefore, it is not root when it
35011 does so. If some bug allowed the path to get overwritten, it would lead to an
35012 arbitrary program's being run as exim, not as root.
35013
35014
35015
35016 .section "Dynamic module directory" "SECTdynmoddir"
35017 Any dynamically loadable modules must be installed into the directory
35018 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
35019 loading it.
35020
35021
35022 .section "Use of sprintf()" "SECID279"
35023 .cindex "&[sprintf()]&"
35024 A large number of occurrences of &"sprintf"& in the code are actually calls to
35025 &'string_sprintf()'&, a function that returns the result in malloc'd store.
35026 The intermediate formatting is done into a large fixed buffer by a function
35027 that runs through the format string itself, and checks the length of each
35028 conversion before performing it, thus preventing buffer overruns.
35029
35030 The remaining uses of &[sprintf()]& happen in controlled circumstances where
35031 the output buffer is known to be sufficiently long to contain the converted
35032 string.
35033
35034
35035
35036 .section "Use of debug_printf() and log_write()" "SECID280"
35037 Arbitrary strings are passed to both these functions, but they do their
35038 formatting by calling the function &'string_vformat()'&, which runs through
35039 the format string itself, and checks the length of each conversion.
35040
35041
35042
35043 .section "Use of strcat() and strcpy()" "SECID281"
35044 These are used only in cases where the output buffer is known to be large
35045 enough to hold the result.
35046 .ecindex IIDsecurcon
35047
35048
35049
35050
35051 . ////////////////////////////////////////////////////////////////////////////
35052 . ////////////////////////////////////////////////////////////////////////////
35053
35054 .chapter "Format of spool files" "CHAPspool"
35055 .scindex IIDforspo1 "format" "spool files"
35056 .scindex IIDforspo2 "spool directory" "format of files"
35057 .scindex IIDforspo3 "spool files" "format of"
35058 .cindex "spool files" "editing"
35059 A message on Exim's queue consists of two files, whose names are the message id
35060 followed by -D and -H, respectively. The data portion of the message is kept in
35061 the -D file on its own. The message's envelope, status, and headers are all
35062 kept in the -H file, whose format is described in this chapter. Each of these
35063 two files contains the final component of its own name as its first line. This
35064 is insurance against disk crashes where the directory is lost but the files
35065 themselves are recoverable.
35066
35067 Some people are tempted into editing -D files in order to modify messages. You
35068 need to be extremely careful if you do this; it is not recommended and you are
35069 on your own if you do it. Here are some of the pitfalls:
35070
35071 .ilist
35072 You must ensure that Exim does not try to deliver the message while you are
35073 fiddling with it. The safest way is to take out a write lock on the -D file,
35074 which is what Exim itself does, using &[fcntl()]&. If you update the file in
35075 place, the lock will be retained. If you write a new file and rename it, the
35076 lock will be lost at the instant of rename.
35077 .next
35078 .vindex "&$body_linecount$&"
35079 If you change the number of lines in the file, the value of
35080 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
35081 present, this value is not used by Exim, but there is no guarantee that this
35082 will always be the case.
35083 .next
35084 If the message is in MIME format, you must take care not to break it.
35085 .next
35086 If the message is cryptographically signed, any change will invalidate the
35087 signature.
35088 .endlist
35089 All in all, modifying -D files is fraught with danger.
35090
35091 Files whose names end with -J may also be seen in the &_input_& directory (or
35092 its subdirectories when &%split_spool_directory%& is set). These are journal
35093 files, used to record addresses to which the message has been delivered during
35094 the course of a delivery attempt. If there are still undelivered recipients at
35095 the end, the -H file is updated, and the -J file is deleted. If, however, there
35096 is some kind of crash (for example, a power outage) before this happens, the -J
35097 file remains in existence. When Exim next processes the message, it notices the
35098 -J file and uses it to update the -H file before starting the next delivery
35099 attempt.
35100
35101 .section "Format of the -H file" "SECID282"
35102 .cindex "uid (user id)" "in spool file"
35103 .cindex "gid (group id)" "in spool file"
35104 The second line of the -H file contains the login name for the uid of the
35105 process that called Exim to read the message, followed by the numerical uid and
35106 gid. For a locally generated message, this is normally the user who sent the
35107 message. For a message received over TCP/IP via the daemon, it is
35108 normally the Exim user.
35109
35110 The third line of the file contains the address of the message's sender as
35111 transmitted in the envelope, contained in angle brackets. The sender address is
35112 empty for bounce messages. For incoming SMTP mail, the sender address is given
35113 in the MAIL command. For locally generated mail, the sender address is
35114 created by Exim from the login name of the current user and the configured
35115 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
35116 leading &"From&~"& line if the caller is trusted, or if the supplied address is
35117 &"<>"& or an address that matches &%untrusted_set_senders%&.
35118
35119 The fourth line contains two numbers. The first is the time that the message
35120 was received, in the conventional Unix form &-- the number of seconds since the
35121 start of the epoch. The second number is a count of the number of messages
35122 warning of delayed delivery that have been sent to the sender.
35123
35124 There follow a number of lines starting with a hyphen. These can appear in any
35125 order, and are omitted when not relevant:
35126
35127 .vlist
35128 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
35129 This item is obsolete, and is not generated from Exim release 4.61 onwards;
35130 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
35131 recognized, to provide backward compatibility. In the old format, a line of
35132 this form is present for every ACL variable that is not empty. The number
35133 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
35134 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
35135 the data string for the variable. The string itself starts at the beginning of
35136 the next line, and is followed by a newline character. It may contain internal
35137 newlines.
35138
35139 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
35140 A line of this form is present for every ACL connection variable that is
35141 defined. Note that there is a space between &%-aclc%& and the rest of the name.
35142 The length is the length of the data string for the variable. The string itself
35143 starts at the beginning of the next line, and is followed by a newline
35144 character. It may contain internal newlines.
35145
35146 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
35147 A line of this form is present for every ACL message variable that is defined.
35148 Note that there is a space between &%-aclm%& and the rest of the name. The
35149 length is the length of the data string for the variable. The string itself
35150 starts at the beginning of the next line, and is followed by a newline
35151 character. It may contain internal newlines.
35152
35153 .vitem "&%-active_hostname%&&~<&'hostname'&>"
35154 This is present if, when the message was received over SMTP, the value of
35155 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
35156
35157 .vitem &%-allow_unqualified_recipient%&
35158 This is present if unqualified recipient addresses are permitted in header
35159 lines (to stop such addresses from being qualified if rewriting occurs at
35160 transport time). Local messages that were input using &%-bnq%& and remote
35161 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
35162
35163 .vitem &%-allow_unqualified_sender%&
35164 This is present if unqualified sender addresses are permitted in header lines
35165 (to stop such addresses from being qualified if rewriting occurs at transport
35166 time). Local messages that were input using &%-bnq%& and remote messages from
35167 hosts that match &%sender_unqualified_hosts%& set this flag.
35168
35169 .vitem "&%-auth_id%&&~<&'text'&>"
35170 The id information for a message received on an authenticated SMTP connection
35171 &-- the value of the &$authenticated_id$& variable.
35172
35173 .vitem "&%-auth_sender%&&~<&'address'&>"
35174 The address of an authenticated sender &-- the value of the
35175 &$authenticated_sender$& variable.
35176
35177 .vitem "&%-body_linecount%&&~<&'number'&>"
35178 This records the number of lines in the body of the message, and is always
35179 present.
35180
35181 .vitem "&%-body_zerocount%&&~<&'number'&>"
35182 This records the number of binary zero bytes in the body of the message, and is
35183 present if the number is greater than zero.
35184
35185 .vitem &%-deliver_firsttime%&
35186 This is written when a new message is first added to the spool. When the spool
35187 file is updated after a deferral, it is omitted.
35188
35189 .vitem "&%-frozen%&&~<&'time'&>"
35190 .cindex "frozen messages" "spool data"
35191 The message is frozen, and the freezing happened at <&'time'&>.
35192
35193 .vitem "&%-helo_name%&&~<&'text'&>"
35194 This records the host name as specified by a remote host in a HELO or EHLO
35195 command.
35196
35197 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
35198 This records the IP address of the host from which the message was received and
35199 the remote port number that was used. It is omitted for locally generated
35200 messages.
35201
35202 .vitem "&%-host_auth%&&~<&'text'&>"
35203 If the message was received on an authenticated SMTP connection, this records
35204 the name of the authenticator &-- the value of the
35205 &$sender_host_authenticated$& variable.
35206
35207 .vitem &%-host_lookup_failed%&
35208 This is present if an attempt to look up the sending host's name from its IP
35209 address failed. It corresponds to the &$host_lookup_failed$& variable.
35210
35211 .vitem "&%-host_name%&&~<&'text'&>"
35212 .cindex "reverse DNS lookup"
35213 .cindex "DNS" "reverse lookup"
35214 This records the name of the remote host from which the message was received,
35215 if the host name was looked up from the IP address when the message was being
35216 received. It is not present if no reverse lookup was done.
35217
35218 .vitem "&%-ident%&&~<&'text'&>"
35219 For locally submitted messages, this records the login of the originating user,
35220 unless it was a trusted user and the &%-oMt%& option was used to specify an
35221 ident value. For messages received over TCP/IP, this records the ident string
35222 supplied by the remote host, if any.
35223
35224 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
35225 This records the IP address of the local interface and the port number through
35226 which a message was received from a remote host. It is omitted for locally
35227 generated messages.
35228
35229 .vitem &%-local%&
35230 The message is from a local sender.
35231
35232 .vitem &%-localerror%&
35233 The message is a locally-generated bounce message.
35234
35235 .vitem "&%-local_scan%&&~<&'string'&>"
35236 This records the data string that was returned by the &[local_scan()]& function
35237 when the message was received &-- the value of the &$local_scan_data$&
35238 variable. It is omitted if no data was returned.
35239
35240 .vitem &%-manual_thaw%&
35241 The message was frozen but has been thawed manually, that is, by an explicit
35242 Exim command rather than via the auto-thaw process.
35243
35244 .vitem &%-N%&
35245 A testing delivery process was started using the &%-N%& option to suppress any
35246 actual deliveries, but delivery was deferred. At any further delivery attempts,
35247 &%-N%& is assumed.
35248
35249 .vitem &%-received_protocol%&
35250 This records the value of the &$received_protocol$& variable, which contains
35251 the name of the protocol by which the message was received.
35252
35253 .vitem &%-sender_set_untrusted%&
35254 The envelope sender of this message was set by an untrusted local caller (used
35255 to ensure that the caller is displayed in queue listings).
35256
35257 .vitem "&%-spam_score_int%&&~<&'number'&>"
35258 If a message was scanned by SpamAssassin, this is present. It records the value
35259 of &$spam_score_int$&.
35260
35261 .vitem &%-tls_certificate_verified%&
35262 A TLS certificate was received from the client that sent this message, and the
35263 certificate was verified by the server.
35264
35265 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
35266 When the message was received over an encrypted connection, this records the
35267 name of the cipher suite that was used.
35268
35269 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
35270 When the message was received over an encrypted connection, and a certificate
35271 was received from the client, this records the Distinguished Name from that
35272 certificate.
35273 .endlist
35274
35275 Following the options there is a list of those addresses to which the message
35276 is not to be delivered. This set of addresses is initialized from the command
35277 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
35278 is set; otherwise it starts out empty. Whenever a successful delivery is made,
35279 the address is added to this set. The addresses are kept internally as a
35280 balanced binary tree, and it is a representation of that tree which is written
35281 to the spool file. If an address is expanded via an alias or forward file, the
35282 original address is added to the tree when deliveries to all its child
35283 addresses are complete.
35284
35285 If the tree is empty, there is a single line in the spool file containing just
35286 the text &"XX"&. Otherwise, each line consists of two letters, which are either
35287 Y or N, followed by an address. The address is the value for the node of the
35288 tree, and the letters indicate whether the node has a left branch and/or a
35289 right branch attached to it, respectively. If branches exist, they immediately
35290 follow. Here is an example of a three-node tree:
35291 .code
35292 YY darcy@austen.fict.example
35293 NN alice@wonderland.fict.example
35294 NN editor@thesaurus.ref.example
35295 .endd
35296 After the non-recipients tree, there is a list of the message's recipients.
35297 This is a simple list, preceded by a count. It includes all the original
35298 recipients of the message, including those to whom the message has already been
35299 delivered. In the simplest case, the list contains one address per line. For
35300 example:
35301 .code
35302 4
35303 editor@thesaurus.ref.example
35304 darcy@austen.fict.example
35305 rdo@foundation
35306 alice@wonderland.fict.example
35307 .endd
35308 However, when a child address has been added to the top-level addresses as a
35309 result of the use of the &%one_time%& option on a &(redirect)& router, each
35310 line is of the following form:
35311 .display
35312 <&'top-level address'&> <&'errors_to address'&> &&&
35313   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
35314 .endd
35315 The 01 flag bit indicates the presence of the three other fields that follow
35316 the top-level address. Other bits may be used in future to support additional
35317 fields. The <&'parent number'&> is the offset in the recipients list of the
35318 original parent of the &"one time"& address. The first two fields are the
35319 envelope sender that is associated with this address and its length. If the
35320 length is zero, there is no special envelope sender (there are then two space
35321 characters in the line). A non-empty field can arise from a &(redirect)& router
35322 that has an &%errors_to%& setting.
35323
35324
35325 A blank line separates the envelope and status information from the headers
35326 which follow. A header may occupy several lines of the file, and to save effort
35327 when reading it in, each header is preceded by a number and an identifying
35328 character. The number is the number of characters in the header, including any
35329 embedded newlines and the terminating newline. The character is one of the
35330 following:
35331
35332 .table2 50pt
35333 .row <&'blank'&>         "header in which Exim has no special interest"
35334 .row &`B`&               "&'Bcc:'& header"
35335 .row &`C`&               "&'Cc:'& header"
35336 .row &`F`&               "&'From:'& header"
35337 .row &`I`&               "&'Message-id:'& header"
35338 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
35339 .row &`R`&               "&'Reply-To:'& header"
35340 .row &`S`&               "&'Sender:'& header"
35341 .row &`T`&               "&'To:'& header"
35342 .row &`*`&               "replaced or deleted header"
35343 .endtable
35344
35345 Deleted or replaced (rewritten) headers remain in the spool file for debugging
35346 purposes. They are not transmitted when the message is delivered. Here is a
35347 typical set of headers:
35348 .code
35349 111P Received: by hobbit.fict.example with local (Exim 4.00)
35350 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
35351 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
35352 038* X-rewrote-sender: bb@hobbit.fict.example
35353 042* From: Bilbo Baggins <bb@hobbit.fict.example>
35354 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
35355 099* To: alice@wonderland.fict.example, rdo@foundation,
35356 darcy@austen.fict.example, editor@thesaurus.ref.example
35357 104T To: alice@wonderland.fict.example, rdo@foundation.example,
35358 darcy@austen.fict.example, editor@thesaurus.ref.example
35359 038  Date: Fri, 11 May 2001 10:28:59 +0100
35360 .endd
35361 The asterisked headers indicate that the envelope sender, &'From:'& header, and
35362 &'To:'& header have been rewritten, the last one because routing expanded the
35363 unqualified domain &'foundation'&.
35364 .ecindex IIDforspo1
35365 .ecindex IIDforspo2
35366 .ecindex IIDforspo3
35367
35368 . ////////////////////////////////////////////////////////////////////////////
35369 . ////////////////////////////////////////////////////////////////////////////
35370
35371 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHID12" &&&
35372          "DKIM Support"
35373 .cindex "DKIM"
35374
35375 DKIM is a mechanism by which messages sent by some entity can be provably
35376 linked to a domain which that entity controls.  It permits reputation to
35377 be tracked on a per-domain basis, rather than merely upon source IP address.
35378 DKIM is documented in RFC 4871.
35379
35380 Since version 4.70, DKIM support is compiled into Exim by default. It can be
35381 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
35382
35383 Exim's DKIM implementation allows to
35384 .olist
35385 Sign outgoing messages: This function is implemented in the SMTP transport.
35386 It can co-exist with all other Exim features, including transport filters.
35387 .next
35388 Verify signatures in incoming messages: This is implemented by an additional
35389 ACL (acl_smtp_dkim), which can be called several times per message, with
35390 different signature contexts.
35391 .endlist
35392
35393 In typical Exim style, the verification implementation does not include any
35394 default "policy". Instead it enables you to build your own policy using
35395 Exim's standard controls.
35396
35397 Please note that verification of DKIM signatures in incoming mail is turned
35398 on by default for logging purposes. For each signature in incoming email,
35399 exim will log a line displaying the most important signature details, and the
35400 signature status. Here is an example (with line-breaks added for clarity):
35401 .code
35402 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
35403     d=facebookmail.com s=q1-2009b
35404     c=relaxed/relaxed a=rsa-sha1
35405     i=@facebookmail.com t=1252484542 [verification succeeded]
35406 .endd
35407 You might want to turn off DKIM verification processing entirely for internal
35408 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
35409 control modifier. This should typically be done in the RCPT ACL, at points
35410 where you accept mail from relay sources (internal hosts or authenticated
35411 senders).
35412
35413
35414 .section "Signing outgoing messages" "SECID513"
35415 .cindex "DKIM" "signing"
35416
35417 Signing is implemented by setting private options on the SMTP transport.
35418 These options take (expandable) strings as arguments.
35419
35420 .option dkim_domain smtp string&!! unset
35421 MANDATORY:
35422 The domain you want to sign with. The result of this expanded
35423 option is put into the &%$dkim_domain%& expansion variable.
35424
35425 .option dkim_selector smtp string&!! unset
35426 MANDATORY:
35427 This sets the key selector string. You can use the &%$dkim_domain%& expansion
35428 variable to look up a matching selector. The result is put in the expansion
35429 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
35430 option along with &%$dkim_domain%&.
35431
35432 .option dkim_private_key smtp string&!! unset
35433 MANDATORY:
35434 This sets the private key to use. You can use the &%$dkim_domain%& and
35435 &%$dkim_selector%& expansion variables to determine the private key to use.
35436 The result can either
35437 .ilist
35438 be a valid RSA private key in ASCII armor, including line breaks.
35439 .next
35440 start with a slash, in which case it is treated as a file that contains
35441 the private key.
35442 .next
35443 be "0", "false" or the empty string, in which case the message will not
35444 be signed. This case will not result in an error, even if &%dkim_strict%&
35445 is set.
35446 .endlist
35447
35448 .option dkim_canon smtp string&!! unset
35449 OPTIONAL:
35450 This option sets the canonicalization method used when signing a message.
35451 The DKIM RFC currently supports two methods: "simple" and "relaxed".
35452 The option defaults to "relaxed" when unset. Note: the current implementation
35453 only supports using the same canonicalization method for both headers and body.
35454
35455 .option dkim_strict smtp string&!! unset
35456 OPTIONAL:
35457 This  option  defines  how  Exim  behaves  when  signing a message that
35458 should be signed fails for some reason.  When the expansion evaluates to
35459 either "1" or "true", Exim will defer. Otherwise Exim will send the message
35460 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
35461 variables here.
35462
35463 .option dkim_sign_headers smtp string&!! unset
35464 OPTIONAL:
35465 When set, this option must expand to (or be specified as) a colon-separated
35466 list of header names. Headers with these names will be included in the message
35467 signature. When unspecified, the header names recommended in RFC4871 will be
35468 used.
35469
35470
35471 .section "Verifying DKIM signatures in incoming mail" "SECID514"
35472 .cindex "DKIM" "verification"
35473
35474 Verification of DKIM signatures in incoming email is implemented via the
35475 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
35476 syntactically(!) correct signature in the incoming message.
35477
35478 To evaluate the signature in the ACL a large number of expansion variables
35479 containing the signature status and its details are set up during the
35480 runtime of the ACL.
35481
35482 Calling the ACL only for existing signatures is not sufficient to build
35483 more advanced policies. For that reason, the global option
35484 &%dkim_verify_signers%&, and a global expansion variable
35485 &%$dkim_signers%& exist.
35486
35487 The global option &%dkim_verify_signers%& can be set to a colon-separated
35488 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
35489 called. It is expanded when the message has been received. At this point,
35490 the expansion variable &%$dkim_signers%& already contains a colon-separated
35491 list of signer domains and identities for the message. When
35492 &%dkim_verify_signers%& is not specified in the main configuration,
35493 it defaults as:
35494 .code
35495 dkim_verify_signers = $dkim_signers
35496 .endd
35497 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
35498 DKIM signature in the message. Current DKIM verifiers may want to explicitly
35499 call the ACL for known domains or identities. This would be achieved as follows:
35500 .code
35501 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
35502 .endd
35503 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
35504 and "ebay.com", plus all domains and identities that have signatures in the message.
35505 You can also be more creative in constructing your policy. For example:
35506 .code
35507 dkim_verify_signers = $sender_address_domain:$dkim_signers
35508 .endd
35509
35510 If a domain or identity is listed several times in the (expanded) value of
35511 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
35512
35513
35514 Inside the &%acl_smtp_dkim%&, the following expansion variables are
35515 available (from most to least important):
35516
35517
35518 .vlist
35519 .vitem &%$dkim_cur_signer%&
35520 The signer that is being evaluated in this ACL run. This can be a domain or
35521 an identity. This is one of the list items from the expanded main option
35522 &%dkim_verify_signers%& (see above).
35523 .vitem &%$dkim_verify_status%&
35524 A string describing the general status of the signature. One of
35525 .ilist
35526 &%none%&: There is no signature in the message for the current domain or
35527 identity (as reflected by &%$dkim_cur_signer%&).
35528 .next
35529 &%invalid%&: The signature could not be verified due to a processing error.
35530 More detail is available in &%$dkim_verify_reason%&.
35531 .next
35532 &%fail%&: Verification of the signature failed.  More detail is
35533 available in &%$dkim_verify_reason%&.
35534 .next
35535 &%pass%&: The signature passed verification. It is valid.
35536 .endlist
35537 .vitem &%$dkim_verify_reason%&
35538 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
35539 "fail" or "invalid". One of
35540 .ilist
35541 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
35542 key for the domain could not be retrieved. This may be a temporary problem.
35543 .next
35544 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
35545 record for the domain is syntactically invalid.
35546 .next
35547 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
35548 body hash does not match the one specified in the signature header. This
35549 means that the message body was modified in transit.
35550 .next
35551 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
35552 could not be verified. This may mean that headers were modified,
35553 re-written or otherwise changed in a way which is incompatible with
35554 DKIM verification. It may of course also mean that the signature is forged.
35555 .endlist
35556 .vitem &%$dkim_domain%&
35557 The signing domain. IMPORTANT: This variable is only populated if there is
35558 an actual signature in the message for the current domain or identity (as
35559 reflected by &%$dkim_cur_signer%&).
35560 .vitem &%$dkim_identity%&
35561 The signing identity, if present. IMPORTANT: This variable is only populated
35562 if there is an actual signature in the message for the current domain or
35563 identity (as reflected by &%$dkim_cur_signer%&).
35564 .vitem &%$dkim_selector%&
35565 The key record selector string.
35566 .vitem &%$dkim_algo%&
35567 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
35568 .vitem &%$dkim_canon_body%&
35569 The body canonicalization method. One of 'relaxed' or 'simple'.
35570 .vitem &%dkim_canon_headers%&
35571 The header canonicalization method. One of 'relaxed' or 'simple'.
35572 .vitem &%$dkim_copiedheaders%&
35573 A transcript of headers and their values which are included in the signature
35574 (copied from the 'z=' tag of the signature).
35575 .vitem &%$dkim_bodylength%&
35576 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
35577 limit was set by the signer, "9999999999999" is returned. This makes sure
35578 that this variable always expands to an integer value.
35579 .vitem &%$dkim_created%&
35580 UNIX timestamp reflecting the date and time when the signature was created.
35581 When this was not specified by the signer, "0" is returned.
35582 .vitem &%$dkim_expires%&
35583 UNIX timestamp reflecting the date and time when the signer wants the
35584 signature to be treated as "expired". When this was not specified by the
35585 signer, "9999999999999" is returned. This makes it possible to do useful
35586 integer size comparisons against this value.
35587 .vitem &%$dkim_headernames%&
35588 A colon-separated list of names of headers included in the signature.
35589 .vitem &%$dkim_key_testing%&
35590 "1" if the key record has the "testing" flag set, "0" if not.
35591 .vitem &%$nosubdomains%&
35592 "1" if the key record forbids subdomaining, "0" otherwise.
35593 .vitem &%$dkim_key_srvtype%&
35594 Service type (tag s=) from the key record. Defaults to "*" if not specified
35595 in the key record.
35596 .vitem &%$dkim_key_granularity%&
35597 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
35598 in the key record.
35599 .vitem &%$dkim_key_notes%&
35600 Notes from the key record (tag n=).
35601 .endlist
35602
35603 In addition, two ACL conditions are provided:
35604
35605 .vlist
35606 .vitem &%dkim_signers%&
35607 ACL condition that checks a colon-separated list of domains or identities
35608 for a match against the domain or identity that the ACL is currently verifying
35609 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
35610 verb to a group of domains or identities. For example:
35611
35612 .code
35613 # Warn when Mail purportedly from GMail has no signature at all
35614 warn log_message = GMail sender without DKIM signature
35615      sender_domains = gmail.com
35616      dkim_signers = gmail.com
35617      dkim_status = none
35618 .endd
35619
35620 .vitem &%dkim_status%&
35621 ACL condition that checks a colon-separated list of possible DKIM verification
35622 results agains the actual result of verification. This is typically used
35623 to restrict an ACL verb to a list of verification outcomes, for example:
35624
35625 .code
35626 deny message = Mail from Paypal with invalid/missing signature
35627      sender_domains = paypal.com:paypal.de
35628      dkim_signers = paypal.com:paypal.de
35629      dkim_status = none:invalid:fail
35630 .endd
35631
35632 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
35633 see the documentation of the &%$dkim_verify_status%& expansion variable above
35634 for more information of what they mean.
35635 .endlist
35636
35637 . ////////////////////////////////////////////////////////////////////////////
35638 . ////////////////////////////////////////////////////////////////////////////
35639
35640 .chapter "Adding new drivers or lookup types" "CHID13" &&&
35641          "Adding drivers or lookups"
35642 .cindex "adding drivers"
35643 .cindex "new drivers, adding"
35644 .cindex "drivers" "adding new"
35645 The following actions have to be taken in order to add a new router, transport,
35646 authenticator, or lookup type to Exim:
35647
35648 .olist
35649 Choose a name for the driver or lookup type that does not conflict with any
35650 existing name; I will use &"newdriver"& in what follows.
35651 .next
35652 Add to &_src/EDITME_& the line:
35653 .display
35654 <&'type'&>&`_NEWDRIVER=yes`&
35655 .endd
35656 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
35657 code is not to be included in the binary by default, comment this line out. You
35658 should also add any relevant comments about the driver or lookup type.
35659 .next
35660 Add to &_src/config.h.defaults_& the line:
35661 .code
35662 #define <type>_NEWDRIVER
35663 .endd
35664 .next
35665 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
35666 and create a table entry as is done for all the other drivers and lookup types.
35667 .next
35668 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
35669 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
35670 driver or lookup type and add it to the definition of OBJ.
35671 .next
35672 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
35673 &_src_&.
35674 .next
35675 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
35676 as for other drivers and lookups.
35677 .endlist
35678
35679 Then all you need to do is write the code! A good way to start is to make a
35680 proforma by copying an existing module of the same type, globally changing all
35681 occurrences of the name, and cutting out most of the code. Note that any
35682 options you create must be listed in alphabetical order, because the tables are
35683 searched using a binary chop procedure.
35684
35685 There is a &_README_& file in each of the sub-directories of &_src_& describing
35686 the interface that is expected.
35687
35688
35689
35690
35691 . ////////////////////////////////////////////////////////////////////////////
35692 . ////////////////////////////////////////////////////////////////////////////
35693
35694 . /////////////////////////////////////////////////////////////////////////////
35695 . These lines are processing instructions for the Simple DocBook Processor that
35696 . Philip Hazel has developed as a less cumbersome way of making PostScript and
35697 . PDFs than using xmlto and fop. They will be ignored by all other XML
35698 . processors.
35699 . /////////////////////////////////////////////////////////////////////////////
35700
35701 .literal xml
35702 <?sdop
35703   format="newpage"
35704   foot_right_recto="&chaptertitle;"
35705   foot_right_verso="&chaptertitle;"
35706 ?>
35707 .literal off
35708
35709 .makeindex "Options index"   "option"
35710 .makeindex "Variables index" "variable"
35711 .makeindex "Concept index"   "concept"
35712
35713
35714 . /////////////////////////////////////////////////////////////////////////////
35715 . /////////////////////////////////////////////////////////////////////////////