Update release date, prep for 4.77 final cut
[users/jgh/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 .section "PCRE library" "SECTpcre"
1651 .cindex "PCRE library"
1652 Exim no longer has an embedded PCRE library as the vast majority of
1653 modern systems include PCRE as a system library, although you may need
1654 to install the PCRE or PCRE development package for your operating
1655 system. If your system has a normal PCRE installation the Exim build
1656 process will need no further configuration. If the library or the
1657 headers are in an unusual location you will need to set the PCRE_LIBS
1658 and INCLUDE directives appropriately. If your operating system has no
1659 PCRE support then you will need to obtain and build the current PCRE
1660 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1661
1662 .section "DBM libraries" "SECTdb"
1663 .cindex "DBM libraries" "discussion of"
1664 .cindex "hints database" "DBM files used for"
1665 Even if you do not use any DBM files in your configuration, Exim still needs a
1666 DBM library in order to operate, because it uses indexed files for its hints
1667 databases. Unfortunately, there are a number of DBM libraries in existence, and
1668 different operating systems often have different ones installed.
1669
1670 .cindex "Solaris" "DBM library for"
1671 .cindex "IRIX, DBM library for"
1672 .cindex "BSD, DBM library for"
1673 .cindex "Linux, DBM library for"
1674 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1675 Linux distribution, the DBM configuration should happen automatically, and you
1676 may be able to ignore this section. Otherwise, you may have to learn more than
1677 you would like about DBM libraries from what follows.
1678
1679 .cindex "&'ndbm'& DBM library"
1680 Licensed versions of Unix normally contain a library of DBM functions operating
1681 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1682 versions of Unix seem to vary in what they contain as standard. In particular,
1683 some early versions of Linux have no default DBM library, and different
1684 distributors have chosen to bundle different libraries with their packaged
1685 versions. However, the more recent releases seem to have standardized on the
1686 Berkeley DB library.
1687
1688 Different DBM libraries have different conventions for naming the files they
1689 use. When a program opens a file called &_dbmfile_&, there are several
1690 possibilities:
1691
1692 .olist
1693 A traditional &'ndbm'& implementation, such as that supplied as part of
1694 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1695 .next
1696 .cindex "&'gdbm'& DBM library"
1697 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1698 compatibility interface it makes two different hard links to it with names
1699 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1700 file name is used unmodified.
1701 .next
1702 .cindex "Berkeley DB library"
1703 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1704 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1705 programmer exactly the same as the traditional &'ndbm'& implementation.
1706 .next
1707 If the Berkeley package is used in its native mode, it operates on a single
1708 file called &_dbmfile_&; the programmer's interface is somewhat different to
1709 the traditional &'ndbm'& interface.
1710 .next
1711 To complicate things further, there are several very different versions of the
1712 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1713 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1714 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1715 versions of Berkeley DB can be obtained from
1716 &url(http://www.sleepycat.com/).
1717 .next
1718 .cindex "&'tdb'& DBM library"
1719 Yet another DBM library, called &'tdb'&, is available from
1720 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1721 operates on a single file.
1722 .endlist
1723
1724 .cindex "USE_DB"
1725 .cindex "DBM libraries" "configuration for building"
1726 Exim and its utilities can be compiled to use any of these interfaces. In order
1727 to use any version of the Berkeley DB package in native mode, you must set
1728 USE_DB in an appropriate configuration file (typically
1729 &_Local/Makefile_&). For example:
1730 .code
1731 USE_DB=yes
1732 .endd
1733 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1734 error is diagnosed if you set more than one of these.
1735
1736 At the lowest level, the build-time configuration sets none of these options,
1737 thereby assuming an interface of type (1). However, some operating system
1738 configuration files (for example, those for the BSD operating systems and
1739 Linux) assume type (4) by setting USE_DB as their default, and the
1740 configuration files for Cygwin set USE_GDBM. Anything you set in
1741 &_Local/Makefile_&, however, overrides these system defaults.
1742
1743 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1744 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1745 in one of these lines:
1746 .code
1747 DBMLIB = -ldb
1748 DBMLIB = -ltdb
1749 .endd
1750 Settings like that will work if the DBM library is installed in the standard
1751 place. Sometimes it is not, and the library's header file may also not be in
1752 the default path. You may need to set INCLUDE to specify where the header
1753 file is, and to specify the path to the library more fully in DBMLIB, as in
1754 this example:
1755 .code
1756 INCLUDE=-I/usr/local/include/db-4.1
1757 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1758 .endd
1759 There is further detailed discussion about the various DBM libraries in the
1760 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1761
1762
1763
1764 .section "Pre-building configuration" "SECID25"
1765 .cindex "building Exim" "pre-building configuration"
1766 .cindex "configuration for building Exim"
1767 .cindex "&_Local/Makefile_&"
1768 .cindex "&_src/EDITME_&"
1769 Before building Exim, a local configuration file that specifies options
1770 independent of any operating system has to be created with the name
1771 &_Local/Makefile_&. A template for this file is supplied as the file
1772 &_src/EDITME_&, and it contains full descriptions of all the option settings
1773 therein. These descriptions are therefore not repeated here. If you are
1774 building Exim for the first time, the simplest thing to do is to copy
1775 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1776
1777 There are three settings that you must supply, because Exim will not build
1778 without them. They are the location of the run time configuration file
1779 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1780 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1781 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1782 a colon-separated list of file names; Exim uses the first of them that exists.
1783
1784 There are a few other parameters that can be specified either at build time or
1785 at run time, to enable the same binary to be used on a number of different
1786 machines. However, if the locations of Exim's spool directory and log file
1787 directory (if not within the spool directory) are fixed, it is recommended that
1788 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1789 detected early in Exim's execution (such as a malformed configuration file) can
1790 be logged.
1791
1792 .cindex "content scanning" "specifying at build time"
1793 Exim's interfaces for calling virus and spam scanning software directly from
1794 access control lists are not compiled by default. If you want to include these
1795 facilities, you need to set
1796 .code
1797 WITH_CONTENT_SCAN=yes
1798 .endd
1799 in your &_Local/Makefile_&. For details of the facilities themselves, see
1800 chapter &<<CHAPexiscan>>&.
1801
1802
1803 .cindex "&_Local/eximon.conf_&"
1804 .cindex "&_exim_monitor/EDITME_&"
1805 If you are going to build the Exim monitor, a similar configuration process is
1806 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1807 your installation and saved under the name &_Local/eximon.conf_&. If you are
1808 happy with the default settings described in &_exim_monitor/EDITME_&,
1809 &_Local/eximon.conf_& can be empty, but it must exist.
1810
1811 This is all the configuration that is needed in straightforward cases for known
1812 operating systems. However, the building process is set up so that it is easy
1813 to override options that are set by default or by operating-system-specific
1814 configuration files, for example to change the name of the C compiler, which
1815 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1816 do this.
1817
1818
1819
1820 .section "Support for iconv()" "SECID26"
1821 .cindex "&[iconv()]& support"
1822 .cindex "RFC 2047"
1823 The contents of header lines in messages may be encoded according to the rules
1824 described RFC 2047. This makes it possible to transmit characters that are not
1825 in the ASCII character set, and to label them as being in a particular
1826 character set. When Exim is inspecting header lines by means of the &%$h_%&
1827 mechanism, it decodes them, and translates them into a specified character set
1828 (default ISO-8859-1). The translation is possible only if the operating system
1829 supports the &[iconv()]& function.
1830
1831 However, some of the operating systems that supply &[iconv()]& do not support
1832 very many conversions. The GNU &%libiconv%& library (available from
1833 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1834 systems to remedy this deficiency, as well as on systems that do not supply
1835 &[iconv()]& at all. After installing &%libiconv%&, you should add
1836 .code
1837 HAVE_ICONV=yes
1838 .endd
1839 to your &_Local/Makefile_& and rebuild Exim.
1840
1841
1842
1843 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1844 .cindex "TLS" "including support for TLS"
1845 .cindex "encryption" "including support for"
1846 .cindex "SUPPORT_TLS"
1847 .cindex "OpenSSL" "building Exim with"
1848 .cindex "GnuTLS" "building Exim with"
1849 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1850 command as per RFC 2487. It can also support legacy clients that expect to
1851 start a TLS session immediately on connection to a non-standard port (see the
1852 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1853 line option).
1854
1855 If you want to build Exim with TLS support, you must first install either the
1856 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1857 implementing SSL.
1858
1859 If OpenSSL is installed, you should set
1860 .code
1861 SUPPORT_TLS=yes
1862 TLS_LIBS=-lssl -lcrypto
1863 .endd
1864 in &_Local/Makefile_&. You may also need to specify the locations of the
1865 OpenSSL library and include files. For example:
1866 .code
1867 SUPPORT_TLS=yes
1868 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1869 TLS_INCLUDE=-I/usr/local/openssl/include/
1870 .endd
1871 .cindex "USE_GNUTLS"
1872 If GnuTLS is installed, you should set
1873 .code
1874 SUPPORT_TLS=yes
1875 USE_GNUTLS=yes
1876 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1877 .endd
1878 in &_Local/Makefile_&, and again you may need to specify the locations of the
1879 library and include files. For example:
1880 .code
1881 SUPPORT_TLS=yes
1882 USE_GNUTLS=yes
1883 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1884 TLS_INCLUDE=-I/usr/gnu/include
1885 .endd
1886 You do not need to set TLS_INCLUDE if the relevant directory is already
1887 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1888 given in chapter &<<CHAPTLS>>&.
1889
1890
1891
1892
1893 .section "Use of tcpwrappers" "SECID27"
1894
1895 .cindex "tcpwrappers, building Exim to support"
1896 .cindex "USE_TCP_WRAPPERS"
1897 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1898 .cindex "tcp_wrappers_daemon_name"
1899 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1900 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1901 alternative to Exim's own checking facilities for installations that are
1902 already making use of &'tcpwrappers'& for other purposes. To do this, you
1903 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1904 &_tcpd.h_& to be available at compile time, and also ensure that the library
1905 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1906 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1907 you might have
1908 .code
1909 USE_TCP_WRAPPERS=yes
1910 CFLAGS=-O -I/usr/local/include
1911 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1912 .endd
1913 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1914 files is &"exim"&. For example, the line
1915 .code
1916 exim : LOCAL  192.168.1.  .friendly.domain.example
1917 .endd
1918 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1919 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1920 All other connections are denied. The daemon name used by &'tcpwrappers'&
1921 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1922 in &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1923 configure file. Consult the &'tcpwrappers'& documentation for
1924 further details.
1925
1926
1927 .section "Including support for IPv6" "SECID28"
1928 .cindex "IPv6" "including support for"
1929 Exim contains code for use on systems that have IPv6 support. Setting
1930 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1931 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1932 where the IPv6 support is not fully integrated into the normal include and
1933 library files.
1934
1935 Two different types of DNS record for handling IPv6 addresses have been
1936 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1937 currently seen as the mainstream. Another record type called A6 was proposed
1938 as better than AAAA because it had more flexibility. However, it was felt to be
1939 over-complex, and its status was reduced to &"experimental"&. It is not known
1940 if anyone is actually using A6 records. Exim has support for A6 records, but
1941 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1942 support has not been tested for some time.
1943
1944
1945
1946 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1947 .cindex "lookup modules"
1948 .cindex "dynamic modules"
1949 .cindex ".so building"
1950 On some platforms, Exim supports not compiling all lookup types directly into
1951 the main binary, instead putting some into external modules which can be loaded
1952 on demand.
1953 This permits packagers to build Exim with support for lookups with extensive
1954 library dependencies without requiring all users to install all of those
1955 dependencies.
1956 Most, but not all, lookup types can be built this way.
1957
1958 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
1959 installed; Exim will only load modules from that directory, as a security
1960 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
1961 for your OS; see &_OS/Makefile-Linux_& for an example.
1962 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
1963 see &_src/EDITME_& for details.
1964
1965 Then, for each module to be loaded dynamically, define the relevant
1966 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
1967 For example, this will build in lsearch but load sqlite and mysql support
1968 on demand:
1969 .code
1970 LOOKUP_LSEARCH=yes
1971 LOOKUP_SQLITE=2
1972 LOOKUP_MYSQL=2
1973 .endd
1974
1975
1976 .section "The building process" "SECID29"
1977 .cindex "build directory"
1978 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
1979 created, run &'make'& at the top level. It determines the architecture and
1980 operating system types, and creates a build directory if one does not exist.
1981 For example, on a Sun system running Solaris 8, the directory
1982 &_build-SunOS5-5.8-sparc_& is created.
1983 .cindex "symbolic link" "to source files"
1984 Symbolic links to relevant source files are installed in the build directory.
1985
1986 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
1987 building process fails if it is set.
1988
1989 If this is the first time &'make'& has been run, it calls a script that builds
1990 a make file inside the build directory, using the configuration files from the
1991 &_Local_& directory. The new make file is then passed to another instance of
1992 &'make'&. This does the real work, building a number of utility scripts, and
1993 then compiling and linking the binaries for the Exim monitor (if configured), a
1994 number of utility programs, and finally Exim itself. The command &`make
1995 makefile`& can be used to force a rebuild of the make file in the build
1996 directory, should this ever be necessary.
1997
1998 If you have problems building Exim, check for any comments there may be in the
1999 &_README_& file concerning your operating system, and also take a look at the
2000 FAQ, where some common problems are covered.
2001
2002
2003
2004 .section 'Output from &"make"&' "SECID283"
2005 The output produced by the &'make'& process for compile lines is often very
2006 unreadable, because these lines can be very long. For this reason, the normal
2007 output is suppressed by default, and instead output similar to that which
2008 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2009 each module that is being compiled or linked. However, it is still possible to
2010 get the full output, by calling &'make'& like this:
2011 .code
2012 FULLECHO='' make -e
2013 .endd
2014 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2015 command reflection in &'make'&. When you ask for the full output, it is
2016 given in addition to the short output.
2017
2018
2019
2020 .section "Overriding build-time options for Exim" "SECToverride"
2021 .cindex "build-time options, overriding"
2022 The main make file that is created at the beginning of the building process
2023 consists of the concatenation of a number of files which set configuration
2024 values, followed by a fixed set of &'make'& instructions. If a value is set
2025 more than once, the last setting overrides any previous ones. This provides a
2026 convenient way of overriding defaults. The files that are concatenated are, in
2027 order:
2028 .display
2029 &_OS/Makefile-Default_&
2030 &_OS/Makefile-_&<&'ostype'&>
2031 &_Local/Makefile_&
2032 &_Local/Makefile-_&<&'ostype'&>
2033 &_Local/Makefile-_&<&'archtype'&>
2034 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2035 &_OS/Makefile-Base_&
2036 .endd
2037 .cindex "&_Local/Makefile_&"
2038 .cindex "building Exim" "operating system type"
2039 .cindex "building Exim" "architecture type"
2040 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2041 architecture type. &_Local/Makefile_& is required to exist, and the building
2042 process fails if it is absent. The other three &_Local_& files are optional,
2043 and are often not needed.
2044
2045 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2046 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2047 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2048 values are used, thereby providing a means of forcing particular settings.
2049 Otherwise, the scripts try to get values from the &%uname%& command. If this
2050 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2051 of &'ad hoc'& transformations are then applied, to produce the standard names
2052 that Exim expects. You can run these scripts directly from the shell in order
2053 to find out what values are being used on your system.
2054
2055
2056 &_OS/Makefile-Default_& contains comments about the variables that are set
2057 therein. Some (but not all) are mentioned below. If there is something that
2058 needs changing, review the contents of this file and the contents of the make
2059 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2060 default values are.
2061
2062
2063 .cindex "building Exim" "overriding default settings"
2064 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2065 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2066 need to change the original files. Instead, you should make the changes by
2067 putting the new values in an appropriate &_Local_& file. For example,
2068 .cindex "Tru64-Unix build-time settings"
2069 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2070 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2071 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2072 called with the option &%-std1%&, to make it recognize some of the features of
2073 Standard C that Exim uses. (Most other compilers recognize Standard C by
2074 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2075 containing the lines
2076 .code
2077 CC=cc
2078 CFLAGS=-std1
2079 .endd
2080 If you are compiling for just one operating system, it may be easier to put
2081 these lines directly into &_Local/Makefile_&.
2082
2083 Keeping all your local configuration settings separate from the distributed
2084 files makes it easy to transfer them to new versions of Exim simply by copying
2085 the contents of the &_Local_& directory.
2086
2087
2088 .cindex "NIS lookup type" "including support for"
2089 .cindex "NIS+ lookup type" "including support for"
2090 .cindex "LDAP" "including support for"
2091 .cindex "lookup" "inclusion in binary"
2092 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2093 lookup, but not all systems have these components installed, so the default is
2094 not to include the relevant code in the binary. All the different kinds of file
2095 and database lookup that Exim supports are implemented as separate code modules
2096 which are included only if the relevant compile-time options are set. In the
2097 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2098 .code
2099 LOOKUP_LDAP=yes
2100 LOOKUP_NIS=yes
2101 LOOKUP_NISPLUS=yes
2102 .endd
2103 and similar settings apply to the other lookup types. They are all listed in
2104 &_src/EDITME_&. In many cases the relevant include files and interface
2105 libraries need to be installed before compiling Exim.
2106 .cindex "cdb" "including support for"
2107 However, there are some optional lookup types (such as cdb) for which
2108 the code is entirely contained within Exim, and no external include
2109 files or libraries are required. When a lookup type is not included in the
2110 binary, attempts to configure Exim to use it cause run time configuration
2111 errors.
2112
2113 .cindex "Perl" "including support for"
2114 Exim can be linked with an embedded Perl interpreter, allowing Perl
2115 subroutines to be called during string expansion. To enable this facility,
2116 .code
2117 EXIM_PERL=perl.o
2118 .endd
2119 must be defined in &_Local/Makefile_&. Details of this facility are given in
2120 chapter &<<CHAPperl>>&.
2121
2122 .cindex "X11 libraries, location of"
2123 The location of the X11 libraries is something that varies a lot between
2124 operating systems, and there may be different versions of X11 to cope
2125 with. Exim itself makes no use of X11, but if you are compiling the Exim
2126 monitor, the X11 libraries must be available.
2127 The following three variables are set in &_OS/Makefile-Default_&:
2128 .code
2129 X11=/usr/X11R6
2130 XINCLUDE=-I$(X11)/include
2131 XLFLAGS=-L$(X11)/lib
2132 .endd
2133 These are overridden in some of the operating-system configuration files. For
2134 example, in &_OS/Makefile-SunOS5_& there is
2135 .code
2136 X11=/usr/openwin
2137 XINCLUDE=-I$(X11)/include
2138 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2139 .endd
2140 If you need to override the default setting for your operating system, place a
2141 definition of all three of these variables into your
2142 &_Local/Makefile-<ostype>_& file.
2143
2144 .cindex "EXTRALIBS"
2145 If you need to add any extra libraries to the link steps, these can be put in a
2146 variable called EXTRALIBS, which appears in all the link commands, but by
2147 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2148 command for linking the main Exim binary, and not for any associated utilities.
2149
2150 .cindex "DBM libraries" "configuration for building"
2151 There is also DBMLIB, which appears in the link commands for binaries that
2152 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2153 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2154 binary, and which can be used, for example, to include additional X11
2155 libraries.
2156
2157 .cindex "configuration file" "editing"
2158 The make file copes with rebuilding Exim correctly if any of the configuration
2159 files are edited. However, if an optional configuration file is deleted, it is
2160 necessary to touch the associated non-optional file (that is,
2161 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2162
2163
2164 .section "OS-specific header files" "SECID30"
2165 .cindex "&_os.h_&"
2166 .cindex "building Exim" "OS-specific C header files"
2167 The &_OS_& directory contains a number of files with names of the form
2168 &_os.h-<ostype>_&. These are system-specific C header files that should not
2169 normally need to be changed. There is a list of macro settings that are
2170 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2171 are porting Exim to a new operating system.
2172
2173
2174
2175 .section "Overriding build-time options for the monitor" "SECID31"
2176 .cindex "building Eximon"
2177 A similar process is used for overriding things when building the Exim monitor,
2178 where the files that are involved are
2179 .display
2180 &_OS/eximon.conf-Default_&
2181 &_OS/eximon.conf-_&<&'ostype'&>
2182 &_Local/eximon.conf_&
2183 &_Local/eximon.conf-_&<&'ostype'&>
2184 &_Local/eximon.conf-_&<&'archtype'&>
2185 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2186 .endd
2187 .cindex "&_Local/eximon.conf_&"
2188 As with Exim itself, the final three files need not exist, and in this case the
2189 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2190 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2191 variables of the same name, preceded by EXIMON_. For example, setting
2192 EXIMON_LOG_DEPTH in the environment overrides the value of
2193 LOG_DEPTH at run time.
2194 .ecindex IIDbuex
2195
2196
2197 .section "Installing Exim binaries and scripts" "SECID32"
2198 .cindex "installing Exim"
2199 .cindex "BIN_DIRECTORY"
2200 The command &`make install`& runs the &(exim_install)& script with no
2201 arguments. The script copies binaries and utility scripts into the directory
2202 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2203 .cindex "setuid" "installing Exim with"
2204 The install script copies files only if they are newer than the files they are
2205 going to replace. The Exim binary is required to be owned by root and have the
2206 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2207 install`& as root so that it can set up the Exim binary in this way. However, in
2208 some special situations (for example, if a host is doing no local deliveries)
2209 it may be possible to run Exim without making the binary setuid root (see
2210 chapter &<<CHAPsecurity>>& for details).
2211
2212 .cindex "CONFIGURE_FILE"
2213 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2214 in &_Local/Makefile_&. If this names a single file, and the file does not
2215 exist, the default configuration file &_src/configure.default_& is copied there
2216 by the installation script. If a run time configuration file already exists, it
2217 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2218 alternative files, no default is installed.
2219
2220 .cindex "system aliases file"
2221 .cindex "&_/etc/aliases_&"
2222 One change is made to the default configuration file when it is installed: the
2223 default configuration contains a router that references a system aliases file.
2224 The path to this file is set to the value specified by
2225 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2226 If the system aliases file does not exist, the installation script creates it,
2227 and outputs a comment to the user.
2228
2229 The created file contains no aliases, but it does contain comments about the
2230 aliases a site should normally have. Mail aliases have traditionally been
2231 kept in &_/etc/aliases_&. However, some operating systems are now using
2232 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2233 Exim's configuration if necessary.
2234
2235 The default configuration uses the local host's name as the only local domain,
2236 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2237 running as the local user. System aliases and &_.forward_& files in users' home
2238 directories are supported, but no NIS or NIS+ support is configured. Domains
2239 other than the name of the local host are routed using the DNS, with delivery
2240 over SMTP.
2241
2242 It is possible to install Exim for special purposes (such as building a binary
2243 distribution) in a private part of the file system. You can do this by a
2244 command such as
2245 .code
2246 make DESTDIR=/some/directory/ install
2247 .endd
2248 This has the effect of pre-pending the specified directory to all the file
2249 paths, except the name of the system aliases file that appears in the default
2250 configuration. (If a default alias file is created, its name &'is'& modified.)
2251 For backwards compatibility, ROOT is used if DESTDIR is not set,
2252 but this usage is deprecated.
2253
2254 .cindex "installing Exim" "what is not installed"
2255 Running &'make install'& does not copy the Exim 4 conversion script
2256 &'convert4r4'&. You will probably run this only once if you are
2257 upgrading from Exim 3. None of the documentation files in the &_doc_&
2258 directory are copied, except for the info files when you have set
2259 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2260
2261 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2262 to their names. The Exim binary itself, however, is handled differently. It is
2263 installed under a name that includes the version number and the compile number,
2264 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2265 called &_exim_& to point to the binary. If you are updating a previous version
2266 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2267 from the directory (as seen by other processes).
2268
2269 .cindex "installing Exim" "testing the script"
2270 If you want to see what the &'make install'& will do before running it for
2271 real, you can pass the &%-n%& option to the installation script by this
2272 command:
2273 .code
2274 make INSTALL_ARG=-n install
2275 .endd
2276 The contents of the variable INSTALL_ARG are passed to the installation
2277 script. You do not need to be root to run this test. Alternatively, you can run
2278 the installation script directly, but this must be from within the build
2279 directory. For example, from the top-level Exim directory you could use this
2280 command:
2281 .code
2282 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2283 .endd
2284 .cindex "installing Exim" "install script options"
2285 There are two other options that can be supplied to the installation script.
2286
2287 .ilist
2288 &%-no_chown%& bypasses the call to change the owner of the installed binary
2289 to root, and the call to make it a setuid binary.
2290 .next
2291 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2292 installed binary.
2293 .endlist
2294
2295 INSTALL_ARG can be used to pass these options to the script. For example:
2296 .code
2297 make INSTALL_ARG=-no_symlink install
2298 .endd
2299 The installation script can also be given arguments specifying which files are
2300 to be copied. For example, to install just the Exim binary, and nothing else,
2301 without creating the symbolic link, you could use:
2302 .code
2303 make INSTALL_ARG='-no_symlink exim' install
2304 .endd
2305
2306
2307
2308 .section "Installing info documentation" "SECTinsinfdoc"
2309 .cindex "installing Exim" "&'info'& documentation"
2310 Not all systems use the GNU &'info'& system for documentation, and for this
2311 reason, the Texinfo source of Exim's documentation is not included in the main
2312 distribution. Instead it is available separately from the ftp site (see section
2313 &<<SECTavail>>&).
2314
2315 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2316 source of the documentation is found in the source tree, running &`make
2317 install`& automatically builds the info files and installs them.
2318
2319
2320
2321 .section "Setting up the spool directory" "SECID33"
2322 .cindex "spool directory" "creating"
2323 When it starts up, Exim tries to create its spool directory if it does not
2324 exist. The Exim uid and gid are used for the owner and group of the spool
2325 directory. Sub-directories are automatically created in the spool directory as
2326 necessary.
2327
2328
2329
2330
2331 .section "Testing" "SECID34"
2332 .cindex "testing" "installation"
2333 Having installed Exim, you can check that the run time configuration file is
2334 syntactically valid by running the following command, which assumes that the
2335 Exim binary directory is within your PATH environment variable:
2336 .code
2337 exim -bV
2338 .endd
2339 If there are any errors in the configuration file, Exim outputs error messages.
2340 Otherwise it outputs the version number and build date,
2341 the DBM library that is being used, and information about which drivers and
2342 other optional code modules are included in the binary.
2343 Some simple routing tests can be done by using the address testing option. For
2344 example,
2345 .display
2346 &`exim -bt`& <&'local username'&>
2347 .endd
2348 should verify that it recognizes a local mailbox, and
2349 .display
2350 &`exim -bt`& <&'remote address'&>
2351 .endd
2352 a remote one. Then try getting it to deliver mail, both locally and remotely.
2353 This can be done by passing messages directly to Exim, without going through a
2354 user agent. For example:
2355 .code
2356 exim -v postmaster@your.domain.example
2357 From: user@your.domain.example
2358 To: postmaster@your.domain.example
2359 Subject: Testing Exim
2360
2361 This is a test message.
2362 ^D
2363 .endd
2364 The &%-v%& option causes Exim to output some verification of what it is doing.
2365 In this case you should see copies of three log lines, one for the message's
2366 arrival, one for its delivery, and one containing &"Completed"&.
2367
2368 .cindex "delivery" "problems with"
2369 If you encounter problems, look at Exim's log files (&'mainlog'& and
2370 &'paniclog'&) to see if there is any relevant information there. Another source
2371 of information is running Exim with debugging turned on, by specifying the
2372 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2373 with debugging turned on by a command of the form
2374 .display
2375 &`exim -d -M`& <&'exim-message-id'&>
2376 .endd
2377 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2378 produces rather a lot of output, but you can cut this down to specific areas.
2379 For example, if you use &%-d-all+route%& only the debugging information
2380 relevant to routing is included. (See the &%-d%& option in chapter
2381 &<<CHAPcommandline>>& for more details.)
2382
2383 .cindex '&"sticky"& bit'
2384 .cindex "lock files"
2385 One specific problem that has shown up on some sites is the inability to do
2386 local deliveries into a shared mailbox directory, because it does not have the
2387 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2388 writing to a mailbox file, and if it cannot create the lock file, the delivery
2389 is deferred. You can get round this either by setting the &"sticky bit"& on the
2390 directory, or by setting a specific group for local deliveries and allowing
2391 that group to create files in the directory (see the comments above the
2392 &(local_delivery)& transport in the default configuration file). Another
2393 approach is to configure Exim not to use lock files, but just to rely on
2394 &[fcntl()]& locking instead. However, you should do this only if all user
2395 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2396 see chapter &<<CHAPappendfile>>&.
2397
2398 One thing that cannot be tested on a system that is already running an MTA is
2399 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2400 &%-oX%& option can be used to run an Exim daemon that listens on some other
2401 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2402 &'exim_checkaccess'& utility can be used to check out policy controls on
2403 incoming SMTP mail.
2404
2405 Testing a new version on a system that is already running Exim can most easily
2406 be done by building a binary with a different CONFIGURE_FILE setting. From
2407 within the run time configuration, all other file and directory names
2408 that Exim uses can be altered, in order to keep it entirely clear of the
2409 production version.
2410
2411
2412 .section "Replacing another MTA with Exim" "SECID35"
2413 .cindex "replacing another MTA"
2414 Building and installing Exim for the first time does not of itself put it in
2415 general use. The name by which the system's MTA is called by mail user agents
2416 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2417 operating system), and it is necessary to make this name point to the &'exim'&
2418 binary in order to get the user agents to pass messages to Exim. This is
2419 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2420 or &_/usr/lib/sendmail_&
2421 .cindex "symbolic link" "to &'exim'& binary"
2422 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2423 privilege and executable status from the old MTA. It is then necessary to stop
2424 and restart the mailer daemon, if one is running.
2425
2426 .cindex "FreeBSD, MTA indirection"
2427 .cindex "&_/etc/mail/mailer.conf_&"
2428 Some operating systems have introduced alternative ways of switching MTAs. For
2429 example, if you are running FreeBSD, you need to edit the file
2430 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2431 described. A typical example of the contents of this file for running Exim is
2432 as follows:
2433 .code
2434 sendmail            /usr/exim/bin/exim
2435 send-mail           /usr/exim/bin/exim
2436 mailq               /usr/exim/bin/exim -bp
2437 newaliases          /usr/bin/true
2438 .endd
2439 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2440 your Exim installation is &"live"&. Check it by sending a message from your
2441 favourite user agent.
2442
2443 You should consider what to tell your users about the change of MTA. Exim may
2444 have different capabilities to what was previously running, and there are
2445 various operational differences such as the text of messages produced by
2446 command line options and in bounce messages. If you allow your users to make
2447 use of Exim's filtering capabilities, you should make the document entitled
2448 &'Exim's interface to mail filtering'& available to them.
2449
2450
2451
2452 .section "Upgrading Exim" "SECID36"
2453 .cindex "upgrading Exim"
2454 If you are already running Exim on your host, building and installing a new
2455 version automatically makes it available to MUAs, or any other programs that
2456 call the MTA directly. However, if you are running an Exim daemon, you do need
2457 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2458 new binary. You do not need to stop processing mail in order to install a new
2459 version of Exim. The install script does not modify an existing runtime
2460 configuration file.
2461
2462
2463
2464
2465 .section "Stopping the Exim daemon on Solaris" "SECID37"
2466 .cindex "Solaris" "stopping Exim on"
2467 The standard command for stopping the mailer daemon on Solaris is
2468 .code
2469 /etc/init.d/sendmail stop
2470 .endd
2471 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2472 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2473 for the text &"sendmail"&; this is not present because the actual program name
2474 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2475 solution is to replace the line that finds the process id with something like
2476 .code
2477 pid=`cat /var/spool/exim/exim-daemon.pid`
2478 .endd
2479 to obtain the daemon's pid directly from the file that Exim saves it in.
2480
2481 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2482 still be received from local processes, and if automatic delivery is configured
2483 (the normal case), deliveries will still occur.
2484
2485
2486
2487
2488 . ////////////////////////////////////////////////////////////////////////////
2489 . ////////////////////////////////////////////////////////////////////////////
2490
2491 .chapter "The Exim command line" "CHAPcommandline"
2492 .scindex IIDclo1 "command line" "options"
2493 .scindex IIDclo2 "options" "command line"
2494 Exim's command line takes the standard Unix form of a sequence of options,
2495 each starting with a hyphen character, followed by a number of arguments. The
2496 options are compatible with the main options of Sendmail, and there are also
2497 some additional options, some of which are compatible with Smail 3. Certain
2498 combinations of options do not make sense, and provoke an error if used.
2499 The form of the arguments depends on which options are set.
2500
2501
2502 .section "Setting options by program name" "SECID38"
2503 .cindex "&'mailq'&"
2504 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2505 were present before any other options.
2506 The &%-bp%& option requests a listing of the contents of the mail queue on the
2507 standard output.
2508 This feature is for compatibility with some systems that contain a command of
2509 that name in one of the standard libraries, symbolically linked to
2510 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2511
2512 .cindex "&'rsmtp'&"
2513 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2514 were present before any other options, for compatibility with Smail. The
2515 &%-bS%& option is used for reading in a number of messages in batched SMTP
2516 format.
2517
2518 .cindex "&'rmail'&"
2519 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2520 &%-oee%& options were present before any other options, for compatibility with
2521 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2522
2523 .cindex "&'runq'&"
2524 .cindex "queue runner"
2525 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2526 were present before any other options, for compatibility with Smail. The &%-q%&
2527 option causes a single queue runner process to be started.
2528
2529 .cindex "&'newaliases'&"
2530 .cindex "alias file" "building"
2531 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2532 If Exim is called under the name &'newaliases'& it behaves as if the option
2533 &%-bi%& were present before any other options, for compatibility with Sendmail.
2534 This option is used for rebuilding Sendmail's alias file. Exim does not have
2535 the concept of a single alias file, but can be configured to run a given
2536 command if called with the &%-bi%& option.
2537
2538
2539 .section "Trusted and admin users" "SECTtrustedadmin"
2540 Some Exim options are available only to &'trusted users'& and others are
2541 available only to &'admin users'&. In the description below, the phrases &"Exim
2542 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2543 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2544 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2545
2546 .ilist
2547 .cindex "trusted users" "definition of"
2548 .cindex "user" "trusted definition of"
2549 The trusted users are root, the Exim user, any user listed in the
2550 &%trusted_users%& configuration option, and any user whose current group or any
2551 supplementary group is one of those listed in the &%trusted_groups%&
2552 configuration option. Note that the Exim group is not automatically trusted.
2553
2554 .cindex '&"From"& line'
2555 .cindex "envelope sender"
2556 Trusted users are always permitted to use the &%-f%& option or a leading
2557 &"From&~"& line to specify the envelope sender of a message that is passed to
2558 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2559 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2560 users to set envelope senders.
2561
2562 .cindex "&'From:'& header line"
2563 .cindex "&'Sender:'& header line"
2564 For a trusted user, there is never any check on the contents of the &'From:'&
2565 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2566 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2567
2568 Trusted users may also specify a host name, host address, interface address,
2569 protocol name, ident value, and authentication data when submitting a message
2570 locally. Thus, they are able to insert messages into Exim's queue locally that
2571 have the characteristics of messages received from a remote host. Untrusted
2572 users may in some circumstances use &%-f%&, but can never set the other values
2573 that are available to trusted users.
2574 .next
2575 .cindex "user" "admin definition of"
2576 .cindex "admin user" "definition of"
2577 The admin users are root, the Exim user, and any user that is a member of the
2578 Exim group or of any group listed in the &%admin_groups%& configuration option.
2579 The current group does not have to be one of these groups.
2580
2581 Admin users are permitted to list the queue, and to carry out certain
2582 operations on messages, for example, to force delivery failures. It is also
2583 necessary to be an admin user in order to see the full information provided by
2584 the Exim monitor, and full debugging output.
2585
2586 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2587 Exim to attempt delivery of messages on its queue is restricted to admin users.
2588 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2589 option false (that is, specifying &%no_prod_requires_admin%&).
2590
2591 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2592 is restricted to admin users unless &%queue_list_requires_admin%& is set
2593 false.
2594 .endlist
2595
2596
2597 &*Warning*&: If you configure your system so that admin users are able to
2598 edit Exim's configuration file, you are giving those users an easy way of
2599 getting root. There is further discussion of this issue at the start of chapter
2600 &<<CHAPconf>>&.
2601
2602
2603
2604
2605 .section "Command line options" "SECID39"
2606 Exim's command line options are described in alphabetical order below. If none
2607 of the options that specifies a specific action (such as starting the daemon or
2608 a queue runner, or testing an address, or receiving a message in a specific
2609 format, or listing the queue) are present, and there is at least one argument
2610 on the command line, &%-bm%& (accept a local message on the standard input,
2611 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2612 outputs a brief message about itself and exits.
2613
2614 . ////////////////////////////////////////////////////////////////////////////
2615 . Insert a stylized XML comment here, to identify the start of the command line
2616 . options. This is for the benefit of the Perl script that automatically
2617 . creates a man page for the options.
2618 . ////////////////////////////////////////////////////////////////////////////
2619
2620 .literal xml
2621 <!-- === Start of command line options === -->
2622 .literal off
2623
2624
2625 .vlist
2626 .vitem &%--%&
2627 .oindex "--"
2628 .cindex "options" "command line; terminating"
2629 This is a pseudo-option whose only purpose is to terminate the options and
2630 therefore to cause subsequent command line items to be treated as arguments
2631 rather than options, even if they begin with hyphens.
2632
2633 .vitem &%--help%&
2634 .oindex "&%--help%&"
2635 This option causes Exim to output a few sentences stating what it is.
2636 The same output is generated if the Exim binary is called with no options and
2637 no arguments.
2638
2639 .vitem &%--version%&
2640 .oindex "&%--version%&"
2641 This option is an alias for &%-bV%& and causes version information to be
2642 displayed.
2643
2644 .vitem &%-B%&<&'type'&>
2645 .oindex "&%-B%&"
2646 .cindex "8-bit characters"
2647 .cindex "Sendmail compatibility" "8-bit characters"
2648 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2649 clean; it ignores this option.
2650
2651 .vitem &%-bd%&
2652 .oindex "&%-bd%&"
2653 .cindex "daemon"
2654 .cindex "SMTP" "listener"
2655 .cindex "queue runner"
2656 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2657 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2658 that the daemon should also initiate periodic queue runs.
2659
2660 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2661 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2662 disconnect from the controlling terminal. When running this way, it can be
2663 stopped by pressing ctrl-C.
2664
2665 By default, Exim listens for incoming connections to the standard SMTP port on
2666 all the host's running interfaces. However, it is possible to listen on other
2667 ports, on multiple ports, and only on specific interfaces. Chapter
2668 &<<CHAPinterfaces>>& contains a description of the options that control this.
2669
2670 When a listening daemon
2671 .cindex "daemon" "process id (pid)"
2672 .cindex "pid (process id)" "of daemon"
2673 is started without the use of &%-oX%& (that is, without overriding the normal
2674 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2675 in Exim's spool directory. This location can be overridden by setting
2676 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2677 running as root.
2678
2679 When &%-oX%& is used on the command line to start a listening daemon, the
2680 process id is not written to the normal pid file path. However, &%-oP%& can be
2681 used to specify a path on the command line if a pid file is required.
2682
2683 The SIGHUP signal
2684 .cindex "SIGHUP"
2685 .cindex "daemon" "restarting"
2686 can be used to cause the daemon to re-execute itself. This should be done
2687 whenever Exim's configuration file, or any file that is incorporated into it by
2688 means of the &%.include%& facility, is changed, and also whenever a new version
2689 of Exim is installed. It is not necessary to do this when other files that are
2690 referenced from the configuration (for example, alias files) are changed,
2691 because these are reread each time they are used.
2692
2693 .vitem &%-bdf%&
2694 .oindex "&%-bdf%&"
2695 This option has the same effect as &%-bd%& except that it never disconnects
2696 from the controlling terminal, even when no debugging is specified.
2697
2698 .vitem &%-be%&
2699 .oindex "&%-be%&"
2700 .cindex "testing" "string expansion"
2701 .cindex "expansion" "testing"
2702 Run Exim in expansion testing mode. Exim discards its root privilege, to
2703 prevent ordinary users from using this mode to read otherwise inaccessible
2704 files. If no arguments are given, Exim runs interactively, prompting for lines
2705 of data. Otherwise, it processes each argument in turn.
2706
2707 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2708 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2709 used without command line arguments. If successful, it uses the &[readline()]&
2710 function, which provides extensive line-editing facilities, for reading the
2711 test data. A line history is supported.
2712
2713 Long expansion expressions can be split over several lines by using backslash
2714 continuations. As in Exim's run time configuration, white space at the start of
2715 continuation lines is ignored. Each argument or data line is passed through the
2716 string expansion mechanism, and the result is output. Variable values from the
2717 configuration file (for example, &$qualify_domain$&) are available, but no
2718 message-specific values (such as &$sender_domain$&) are set, because no message
2719 is being processed (but see &%-bem%& and &%-Mset%&).
2720
2721 &*Note*&: If you use this mechanism to test lookups, and you change the data
2722 files or databases you are using, you must exit and restart Exim before trying
2723 the same lookup again. Otherwise, because each Exim process caches the results
2724 of lookups, you will just get the same result as before.
2725
2726 .vitem &%-bem%&&~<&'filename'&>
2727 .oindex "&%-bem%&"
2728 .cindex "testing" "string expansion"
2729 .cindex "expansion" "testing"
2730 This option operates like &%-be%& except that it must be followed by the name
2731 of a file. For example:
2732 .code
2733 exim -bem /tmp/testmessage
2734 .endd
2735 The file is read as a message (as if receiving a locally-submitted non-SMTP
2736 message) before any of the test expansions are done. Thus, message-specific
2737 variables such as &$message_size$& and &$header_from:$& are available. However,
2738 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2739 recipients are read from the headers in the normal way, and are shown in the
2740 &$recipients$& variable. Note that recipients cannot be given on the command
2741 line, because further arguments are taken as strings to expand (just like
2742 &%-be%&).
2743
2744 .vitem &%-bF%&&~<&'filename'&>
2745 .oindex "&%-bF%&"
2746 .cindex "system filter" "testing"
2747 .cindex "testing" "system filter"
2748 This option is the same as &%-bf%& except that it assumes that the filter being
2749 tested is a system filter. The additional commands that are available only in
2750 system filters are recognized.
2751
2752 .vitem &%-bf%&&~<&'filename'&>
2753 .oindex "&%-bf%&"
2754 .cindex "filter" "testing"
2755 .cindex "testing" "filter file"
2756 .cindex "forward file" "testing"
2757 .cindex "testing" "forward file"
2758 .cindex "Sieve filter" "testing"
2759 This option runs Exim in user filter testing mode; the file is the filter file
2760 to be tested, and a test message must be supplied on the standard input. If
2761 there are no message-dependent tests in the filter, an empty file can be
2762 supplied.
2763
2764 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2765 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2766 filter and a user filter in the same run. For example:
2767 .code
2768 exim -bF /system/filter -bf /user/filter </test/message
2769 .endd
2770 This is helpful when the system filter adds header lines or sets filter
2771 variables that are used by the user filter.
2772
2773 If the test filter file does not begin with one of the special lines
2774 .code
2775 # Exim filter
2776 # Sieve filter
2777 .endd
2778 it is taken to be a normal &_.forward_& file, and is tested for validity under
2779 that interpretation. See sections &<<SECTitenonfilred>>& to
2780 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2781 redirection lists.
2782
2783 The result of an Exim command that uses &%-bf%&, provided no errors are
2784 detected, is a list of the actions that Exim would try to take if presented
2785 with the message for real. More details of filter testing are given in the
2786 separate document entitled &'Exim's interfaces to mail filtering'&.
2787
2788 When testing a filter file,
2789 .cindex "&""From""& line"
2790 .cindex "envelope sender"
2791 .oindex "&%-f%&" "for filter testing"
2792 the envelope sender can be set by the &%-f%& option,
2793 or by a &"From&~"& line at the start of the test message. Various parameters
2794 that would normally be taken from the envelope recipient address of the message
2795 can be set by means of additional command line options (see the next four
2796 options).
2797
2798 .vitem &%-bfd%&&~<&'domain'&>
2799 .oindex "&%-bfd%&"
2800 .vindex "&$qualify_domain$&"
2801 This sets the domain of the recipient address when a filter file is being
2802 tested by means of the &%-bf%& option. The default is the value of
2803 &$qualify_domain$&.
2804
2805 .vitem &%-bfl%&&~<&'local&~part'&>
2806 .oindex "&%-bfl%&"
2807 This sets the local part of the recipient address when a filter file is being
2808 tested by means of the &%-bf%& option. The default is the username of the
2809 process that calls Exim. A local part should be specified with any prefix or
2810 suffix stripped, because that is how it appears to the filter when a message is
2811 actually being delivered.
2812
2813 .vitem &%-bfp%&&~<&'prefix'&>
2814 .oindex "&%-bfp%&"
2815 This sets the prefix of the local part of the recipient address when a filter
2816 file is being tested by means of the &%-bf%& option. The default is an empty
2817 prefix.
2818
2819 .vitem &%-bfs%&&~<&'suffix'&>
2820 .oindex "&%-bfs%&"
2821 This sets the suffix of the local part of the recipient address when a filter
2822 file is being tested by means of the &%-bf%& option. The default is an empty
2823 suffix.
2824
2825 .vitem &%-bh%&&~<&'IP&~address'&>
2826 .oindex "&%-bh%&"
2827 .cindex "testing" "incoming SMTP"
2828 .cindex "SMTP" "testing incoming"
2829 .cindex "testing" "relay control"
2830 .cindex "relaying" "testing configuration"
2831 .cindex "policy control" "testing"
2832 .cindex "debugging" "&%-bh%& option"
2833 This option runs a fake SMTP session as if from the given IP address, using the
2834 standard input and output. The IP address may include a port number at the end,
2835 after a full stop. For example:
2836 .code
2837 exim -bh 10.9.8.7.1234
2838 exim -bh fe80::a00:20ff:fe86:a061.5678
2839 .endd
2840 When an IPv6 address is given, it is converted into canonical form. In the case
2841 of the second example above, the value of &$sender_host_address$& after
2842 conversion to the canonical form is
2843 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2844
2845 Comments as to what is going on are written to the standard error file. These
2846 include lines beginning with &"LOG"& for anything that would have been logged.
2847 This facility is provided for testing configuration options for incoming
2848 messages, to make sure they implement the required policy. For example, you can
2849 test your relay controls using &%-bh%&.
2850
2851 &*Warning 1*&:
2852 .cindex "RFC 1413"
2853 You can test features of the configuration that rely on ident (RFC 1413)
2854 information by using the &%-oMt%& option. However, Exim cannot actually perform
2855 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2856 connection.
2857
2858 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2859 are also skipped when testing using &%-bh%&. If you want these callouts to
2860 occur, use &%-bhc%& instead.
2861
2862 Messages supplied during the testing session are discarded, and nothing is
2863 written to any of the real log files. There may be pauses when DNS (and other)
2864 lookups are taking place, and of course these may time out. The &%-oMi%& option
2865 can be used to specify a specific IP interface and port if this is important,
2866 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2867 session were authenticated.
2868
2869 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2870 output just states whether a given recipient address from a given host is
2871 acceptable or not. See section &<<SECTcheckaccess>>&.
2872
2873 Features such as authentication and encryption, where the client input is not
2874 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2875 specialized SMTP test program such as
2876 &url(http://jetmore.org/john/code/#swaks,swaks).
2877
2878 .vitem &%-bhc%&&~<&'IP&~address'&>
2879 .oindex "&%-bhc%&"
2880 This option operates in the same way as &%-bh%&, except that address
2881 verification callouts are performed if required. This includes consulting and
2882 updating the callout cache database.
2883
2884 .vitem &%-bi%&
2885 .oindex "&%-bi%&"
2886 .cindex "alias file" "building"
2887 .cindex "building alias file"
2888 .cindex "Sendmail compatibility" "&%-bi%& option"
2889 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2890 Exim does not have the concept of a single alias file, and so it cannot mimic
2891 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2892 tend to appear in various scripts such as NIS make files, so the option must be
2893 recognized.
2894
2895 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2896 configuration option is run, under the uid and gid of the caller of Exim. If
2897 the &%-oA%& option is used, its value is passed to the command as an argument.
2898 The command set by &%bi_command%& may not contain arguments. The command can
2899 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2900 if this is required. If the &%bi_command%& option is not set, calling Exim with
2901 &%-bi%& is a no-op.
2902
2903 .vitem &%-bm%&
2904 .oindex "&%-bm%&"
2905 .cindex "local message reception"
2906 This option runs an Exim receiving process that accepts an incoming,
2907 locally-generated message on the current input. The recipients are given as the
2908 command arguments (except when &%-t%& is also present &-- see below). Each
2909 argument can be a comma-separated list of RFC 2822 addresses. This is the
2910 default option for selecting the overall action of an Exim call; it is assumed
2911 if no other conflicting option is present.
2912
2913 If any addresses in the message are unqualified (have no domain), they are
2914 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2915 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2916 suppressing this for special cases.
2917
2918 Policy checks on the contents of local messages can be enforced by means of
2919 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2920
2921 .cindex "return code" "for &%-bm%&"
2922 The return code is zero if the message is successfully accepted. Otherwise, the
2923 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2924
2925 The format
2926 .cindex "message" "format"
2927 .cindex "format" "message"
2928 .cindex "&""From""& line"
2929 .cindex "UUCP" "&""From""& line"
2930 .cindex "Sendmail compatibility" "&""From""& line"
2931 of the message must be as defined in RFC 2822, except that, for
2932 compatibility with Sendmail and Smail, a line in one of the forms
2933 .code
2934 From sender Fri Jan  5 12:55 GMT 1997
2935 From sender Fri, 5 Jan 97 12:55:01
2936 .endd
2937 (with the weekday optional, and possibly with additional text after the date)
2938 is permitted to appear at the start of the message. There appears to be no
2939 authoritative specification of the format of this line. Exim recognizes it by
2940 matching against the regular expression defined by the &%uucp_from_pattern%&
2941 option, which can be changed if necessary.
2942
2943 .oindex "&%-f%&" "overriding &""From""& line"
2944 The specified sender is treated as if it were given as the argument to the
2945 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
2946 preference to the address taken from the message. The caller of Exim must be a
2947 trusted user for the sender of a message to be set in this way.
2948
2949 .vitem &%-bnq%&
2950 .oindex "&%-bnq%&"
2951 .cindex "address qualification, suppressing"
2952 By default, Exim automatically qualifies unqualified addresses (those
2953 without domains) that appear in messages that are submitted locally (that
2954 is, not over TCP/IP). This qualification applies both to addresses in
2955 envelopes, and addresses in header lines. Sender addresses are qualified using
2956 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
2957 defaults to the value of &%qualify_domain%&).
2958
2959 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
2960 being used to re-submit messages that originally came from remote hosts after
2961 content scanning, you probably do not want to qualify unqualified addresses in
2962 header lines. (Such lines will be present only if you have not enabled a header
2963 syntax check in the appropriate ACL.)
2964
2965 The &%-bnq%& option suppresses all qualification of unqualified addresses in
2966 messages that originate on the local host. When this is used, unqualified
2967 addresses in the envelope provoke errors (causing message rejection) and
2968 unqualified addresses in header lines are left alone.
2969
2970
2971 .vitem &%-bP%&
2972 .oindex "&%-bP%&"
2973 .cindex "configuration options" "extracting"
2974 .cindex "options" "configuration &-- extracting"
2975 If this option is given with no arguments, it causes the values of all Exim's
2976 main configuration options to be written to the standard output. The values
2977 of one or more specific options can be requested by giving their names as
2978 arguments, for example:
2979 .code
2980 exim -bP qualify_domain hold_domains
2981 .endd
2982 .cindex "hiding configuration option values"
2983 .cindex "configuration options" "hiding value of"
2984 .cindex "options" "hiding value of"
2985 However, any option setting that is preceded by the word &"hide"& in the
2986 configuration file is not shown in full, except to an admin user. For other
2987 users, the output is as in this example:
2988 .code
2989 mysql_servers = <value not displayable>
2990 .endd
2991 If &%configure_file%& is given as an argument, the name of the run time
2992 configuration file is output.
2993 If a list of configuration files was supplied, the value that is output here
2994 is the name of the file that was actually used.
2995
2996 .cindex "daemon" "process id (pid)"
2997 .cindex "pid (process id)" "of daemon"
2998 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
2999 directories where log files and daemon pid files are written are output,
3000 respectively. If these values are unset, log files are written in a
3001 sub-directory of the spool directory called &%log%&, and the pid file is
3002 written directly into the spool directory.
3003
3004 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3005 .code
3006 exim -bP +local_domains
3007 .endd
3008 it searches for a matching named list of any type (domain, host, address, or
3009 local part) and outputs what it finds.
3010
3011 .cindex "options" "router &-- extracting"
3012 .cindex "options" "transport &-- extracting"
3013 .cindex "options" "authenticator &-- extracting"
3014 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3015 followed by the name of an appropriate driver instance, the option settings for
3016 that driver are output. For example:
3017 .code
3018 exim -bP transport local_delivery
3019 .endd
3020 The generic driver options are output first, followed by the driver's private
3021 options. A list of the names of drivers of a particular type can be obtained by
3022 using one of the words &%router_list%&, &%transport_list%&, or
3023 &%authenticator_list%&, and a complete list of all drivers with their option
3024 settings can be obtained by using &%routers%&, &%transports%&, or
3025 &%authenticators%&.
3026
3027 .cindex "options" "macro &-- extracting"
3028 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3029 are available, similarly to the drivers.  Because macros are sometimes used
3030 for storing passwords, this option is restricted.
3031 The output format is one item per line.
3032
3033 .vitem &%-bp%&
3034 .oindex "&%-bp%&"
3035 .cindex "queue" "listing messages on"
3036 .cindex "listing" "messages on the queue"
3037 This option requests a listing of the contents of the mail queue on the
3038 standard output. If the &%-bp%& option is followed by a list of message ids,
3039 just those messages are listed. By default, this option can be used only by an
3040 admin user. However, the &%queue_list_requires_admin%& option can be set false
3041 to allow any user to see the queue.
3042
3043 Each message on the queue is displayed as in the following example:
3044 .code
3045 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3046           red.king@looking-glass.fict.example
3047           <other addresses>
3048 .endd
3049 .cindex "message" "size in queue listing"
3050 .cindex "size" "of message"
3051 The first line contains the length of time the message has been on the queue
3052 (in this case 25 minutes), the size of the message (2.9K), the unique local
3053 identifier for the message, and the message sender, as contained in the
3054 envelope. For bounce messages, the sender address is empty, and appears as
3055 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3056 the default sender address, the user's login name is shown in parentheses
3057 before the sender address.
3058
3059 .cindex "frozen messages" "in queue listing"
3060 If the message is frozen (attempts to deliver it are suspended) then the text
3061 &"*** frozen ***"& is displayed at the end of this line.
3062
3063 The recipients of the message (taken from the envelope, not the headers) are
3064 displayed on subsequent lines. Those addresses to which the message has already
3065 been delivered are marked with the letter D. If an original address gets
3066 expanded into several addresses via an alias or forward file, the original is
3067 displayed with a D only when deliveries for all of its child addresses are
3068 complete.
3069
3070
3071 .vitem &%-bpa%&
3072 .oindex "&%-bpa%&"
3073 This option operates like &%-bp%&, but in addition it shows delivered addresses
3074 that were generated from the original top level address(es) in each message by
3075 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3076 of just &"D"&.
3077
3078
3079 .vitem &%-bpc%&
3080 .oindex "&%-bpc%&"
3081 .cindex "queue" "count of messages on"
3082 This option counts the number of messages on the queue, and writes the total
3083 to the standard output. It is restricted to admin users, unless
3084 &%queue_list_requires_admin%& is set false.
3085
3086
3087 .vitem &%-bpr%&
3088 .oindex "&%-bpr%&"
3089 This option operates like &%-bp%&, but the output is not sorted into
3090 chronological order of message arrival. This can speed it up when there are
3091 lots of messages on the queue, and is particularly useful if the output is
3092 going to be post-processed in a way that doesn't need the sorting.
3093
3094 .vitem &%-bpra%&
3095 .oindex "&%-bpra%&"
3096 This option is a combination of &%-bpr%& and &%-bpa%&.
3097
3098 .vitem &%-bpru%&
3099 .oindex "&%-bpru%&"
3100 This option is a combination of &%-bpr%& and &%-bpu%&.
3101
3102
3103 .vitem &%-bpu%&
3104 .oindex "&%-bpu%&"
3105 This option operates like &%-bp%& but shows only undelivered top-level
3106 addresses for each message displayed. Addresses generated by aliasing or
3107 forwarding are not shown, unless the message was deferred after processing by a
3108 router with the &%one_time%& option set.
3109
3110
3111 .vitem &%-brt%&
3112 .oindex "&%-brt%&"
3113 .cindex "testing" "retry configuration"
3114 .cindex "retry" "configuration testing"
3115 This option is for testing retry rules, and it must be followed by up to three
3116 arguments. It causes Exim to look for a retry rule that matches the values
3117 and to write it to the standard output. For example:
3118 .code
3119 exim -brt bach.comp.mus.example
3120 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3121 .endd
3122 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3123 argument, which is required, can be a complete address in the form
3124 &'local_part@domain'&, or it can be just a domain name. If the second argument
3125 contains a dot, it is interpreted as an optional second domain name; if no
3126 retry rule is found for the first argument, the second is tried. This ties in
3127 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3128 rule is found that matches the host, one that matches the mail domain is
3129 sought. Finally, an argument that is the name of a specific delivery error, as
3130 used in setting up retry rules, can be given. For example:
3131 .code
3132 exim -brt haydn.comp.mus.example quota_3d
3133 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3134 .endd
3135
3136 .vitem &%-brw%&
3137 .oindex "&%-brw%&"
3138 .cindex "testing" "rewriting"
3139 .cindex "rewriting" "testing"
3140 This option is for testing address rewriting rules, and it must be followed by
3141 a single argument, consisting of either a local part without a domain, or a
3142 complete address with a fully qualified domain. Exim outputs how this address
3143 would be rewritten for each possible place it might appear. See chapter
3144 &<<CHAPrewrite>>& for further details.
3145
3146 .vitem &%-bS%&
3147 .oindex "&%-bS%&"
3148 .cindex "SMTP" "batched incoming"
3149 .cindex "batched SMTP input"
3150 This option is used for batched SMTP input, which is an alternative interface
3151 for non-interactive local message submission. A number of messages can be
3152 submitted in a single run. However, despite its name, this is not really SMTP
3153 input. Exim reads each message's envelope from SMTP commands on the standard
3154 input, but generates no responses. If the caller is trusted, or
3155 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3156 believed; otherwise the sender is always the caller of Exim.
3157
3158 The message itself is read from the standard input, in SMTP format (leading
3159 dots doubled), terminated by a line containing just a single dot. An error is
3160 provoked if the terminating dot is missing. A further message may then follow.
3161
3162 As for other local message submissions, the contents of incoming batch SMTP
3163 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3164 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3165 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3166
3167 Some other SMTP commands are recognized in the input. HELO and EHLO act
3168 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3169 QUIT quits, ignoring the rest of the standard input.
3170
3171 .cindex "return code" "for &%-bS%&"
3172 If any error is encountered, reports are written to the standard output and
3173 error streams, and Exim gives up immediately. The return code is 0 if no error
3174 was detected; it is 1 if one or more messages were accepted before the error
3175 was detected; otherwise it is 2.
3176
3177 More details of input using batched SMTP are given in section
3178 &<<SECTincomingbatchedSMTP>>&.
3179
3180 .vitem &%-bs%&
3181 .oindex "&%-bs%&"
3182 .cindex "SMTP" "local input"
3183 .cindex "local SMTP input"
3184 This option causes Exim to accept one or more messages by reading SMTP commands
3185 on the standard input, and producing SMTP replies on the standard output. SMTP
3186 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3187 Some user agents use this interface as a way of passing locally-generated
3188 messages to the MTA.
3189
3190 In
3191 .cindex "sender" "source of"
3192 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3193 set, the senders of messages are taken from the SMTP MAIL commands.
3194 Otherwise the content of these commands is ignored and the sender is set up as
3195 the calling user. Unqualified addresses are automatically qualified using
3196 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3197 &%-bnq%& option is used.
3198
3199 .cindex "inetd"
3200 The
3201 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3202 using a listening daemon. Exim can distinguish the two cases by checking
3203 whether the standard input is a TCP/IP socket. When Exim is called from
3204 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3205 above concerning senders and qualification do not apply. In this situation,
3206 Exim behaves in exactly the same way as it does when receiving a message via
3207 the listening daemon.
3208
3209 .vitem &%-bmalware%&&~<&'filename'&>
3210 .oindex "&%-bmalware%&"
3211 .cindex "testing", "malware"
3212 .cindex "malware scan test"
3213 This debugging option causes Exim to scan the given file,
3214 using the malware scanning framework.  The option of &%av_scanner%& influences
3215 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3216 the expansion should have defaults which apply to this invocation.  ACLs are
3217 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3218 will never be populated and &%-bmalware%& will fail.
3219
3220 Exim will have changed working directory before resolving the filename, so
3221 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3222 user when it tries to open the file, rather than as the invoking user.
3223 This option requires admin privileges.
3224
3225 The &%-bmalware%& option will not be extended to be more generally useful,
3226 there are better tools for file-scanning.  This option exists to help
3227 administrators verify their Exim and AV scanner configuration.
3228
3229 .vitem &%-bt%&
3230 .oindex "&%-bt%&"
3231 .cindex "testing" "addresses"
3232 .cindex "address" "testing"
3233 This option runs Exim in address testing mode, in which each argument is taken
3234 as a recipient address to be tested for deliverability. The results are
3235 written to the standard output. If a test fails, and the caller is not an admin
3236 user, no details of the failure are output, because these might contain
3237 sensitive information such as usernames and passwords for database lookups.
3238
3239 If no arguments are given, Exim runs in an interactive manner, prompting with a
3240 right angle bracket for addresses to be tested.
3241
3242 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3243 &[readline()]& function, because it is running as &'root'& and there are
3244 security issues.
3245
3246 Each address is handled as if it were the recipient address of a message
3247 (compare the &%-bv%& option). It is passed to the routers and the result is
3248 written to the standard output. However, any router that has
3249 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3250 genuine routing tests if your first router passes everything to a scanner
3251 program.
3252
3253 .cindex "return code" "for &%-bt%&"
3254 The return code is 2 if any address failed outright; it is 1 if no address
3255 failed outright but at least one could not be resolved for some reason. Return
3256 code 0 is given only when all addresses succeed.
3257
3258 .cindex "duplicate addresses"
3259 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3260 addresses after routing is complete, so that only one delivery takes place.
3261 This does not happen when testing with &%-bt%&; the full results of routing are
3262 always shown.
3263
3264 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3265 routers in the configuration makes any tests on the sender address of a
3266 message,
3267 .oindex "&%-f%&" "for address testing"
3268 you can use the &%-f%& option to set an appropriate sender when running
3269 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3270 default qualifying domain. However, if you have set up (for example) routers
3271 whose behaviour depends on the contents of an incoming message, you cannot test
3272 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3273 doing such tests.
3274
3275 .vitem &%-bV%&
3276 .oindex "&%-bV%&"
3277 .cindex "version number of Exim"
3278 This option causes Exim to write the current version number, compilation
3279 number, and compilation date of the &'exim'& binary to the standard output.
3280 It also lists the DBM library that is being used, the optional modules (such as
3281 specific lookup types), the drivers that are included in the binary, and the
3282 name of the run time configuration file that is in use.
3283
3284 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3285 configuration file. However, this is a static check only. It cannot check
3286 values that are to be expanded. For example, although a misspelt ACL verb is
3287 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3288 alone to discover (for example) all the typos in the configuration; some
3289 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3290 dynamic testing facilities.
3291
3292 .vitem &%-bv%&
3293 .oindex "&%-bv%&"
3294 .cindex "verifying address" "using &%-bv%&"
3295 .cindex "address" "verification"
3296 This option runs Exim in address verification mode, in which each argument is
3297 taken as a recipient address to be verified by the routers. (This does
3298 not involve any verification callouts). During normal operation, verification
3299 happens mostly as a consequence processing a &%verify%& condition in an ACL
3300 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3301 including callouts, see the &%-bh%& and &%-bhc%& options.
3302
3303 If verification fails, and the caller is not an admin user, no details of the
3304 failure are output, because these might contain sensitive information such as
3305 usernames and passwords for database lookups.
3306
3307 If no arguments are given, Exim runs in an interactive manner, prompting with a
3308 right angle bracket for addresses to be verified.
3309
3310 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3311 &[readline()]& function, because it is running as &'exim'& and there are
3312 security issues.
3313
3314 Verification differs from address testing (the &%-bt%& option) in that routers
3315 that have &%no_verify%& set are skipped, and if the address is accepted by a
3316 router that has &%fail_verify%& set, verification fails. The address is
3317 verified as a recipient if &%-bv%& is used; to test verification for a sender
3318 address, &%-bvs%& should be used.
3319
3320 If the &%-v%& option is not set, the output consists of a single line for each
3321 address, stating whether it was verified or not, and giving a reason in the
3322 latter case. Without &%-v%&, generating more than one address by redirection
3323 causes verification to end successfully, without considering the generated
3324 addresses. However, if just one address is generated, processing continues,
3325 and the generated address must verify successfully for the overall verification
3326 to succeed.
3327
3328 When &%-v%& is set, more details are given of how the address has been handled,
3329 and in the case of address redirection, all the generated addresses are also
3330 considered. Verification may succeed for some and fail for others.
3331
3332 The
3333 .cindex "return code" "for &%-bv%&"
3334 return code is 2 if any address failed outright; it is 1 if no address
3335 failed outright but at least one could not be resolved for some reason. Return
3336 code 0 is given only when all addresses succeed.
3337
3338 If any of the routers in the configuration makes any tests on the sender
3339 address of a message, you should use the &%-f%& option to set an appropriate
3340 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3341 calling user at the default qualifying domain.
3342
3343 .vitem &%-bvs%&
3344 .oindex "&%-bvs%&"
3345 This option acts like &%-bv%&, but verifies the address as a sender rather
3346 than a recipient address. This affects any rewriting and qualification that
3347 might happen.
3348
3349 .vitem &%-C%&&~<&'filelist'&>
3350 .oindex "&%-C%&"
3351 .cindex "configuration file" "alternate"
3352 .cindex "CONFIGURE_FILE"
3353 .cindex "alternate configuration file"
3354 This option causes Exim to find the run time configuration file from the given
3355 list instead of from the list specified by the CONFIGURE_FILE
3356 compile-time setting. Usually, the list will consist of just a single file
3357 name, but it can be a colon-separated list of names. In this case, the first
3358 file that exists is used. Failure to open an existing file stops Exim from
3359 proceeding any further along the list, and an error is generated.
3360
3361 When this option is used by a caller other than root, and the list is different
3362 from the compiled-in list, Exim gives up its root privilege immediately, and
3363 runs with the real and effective uid and gid set to those of the caller.
3364 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3365 file contains a list of full pathnames, one per line, for configuration files
3366 which are trusted. Root privilege is retained for any configuration file so
3367 listed, as long as the caller is the Exim user (or the user specified in the
3368 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3369 not writeable by inappropriate users or groups.
3370
3371 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3372 configuration using &%-C%& right through message reception and delivery,
3373 even if the caller is root. The reception works, but by that time, Exim is
3374 running as the Exim user, so when it re-executes to regain privilege for the
3375 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3376 test reception and delivery using two separate commands (one to put a message
3377 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3378
3379 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3380 prefix string with which any file named in a &%-C%& command line option
3381 must start. In addition, the file name must not contain the sequence &`/../`&.
3382 However, if the value of the &%-C%& option is identical to the value of
3383 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3384 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3385 unset, any file name can be used with &%-C%&.
3386
3387 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3388 to a directory to which only root has access. This prevents someone who has
3389 broken into the Exim account from running a privileged Exim with an arbitrary
3390 configuration file.
3391
3392 The &%-C%& facility is useful for ensuring that configuration files are
3393 syntactically correct, but cannot be used for test deliveries, unless the
3394 caller is privileged, or unless it is an exotic configuration that does not
3395 require privilege. No check is made on the owner or group of the files
3396 specified by this option.
3397
3398
3399 .vitem &%-D%&<&'macro'&>=<&'value'&>
3400 .oindex "&%-D%&"
3401 .cindex "macro" "setting on command line"
3402 This option can be used to override macro definitions in the configuration file
3403 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3404 unprivileged caller, it causes Exim to give up its root privilege.
3405 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3406 completely disabled, and its use causes an immediate error exit.
3407
3408 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3409 colon-separated list of macros which are considered safe and, if &%-D%& only
3410 supplies macros from this list, and the values are acceptable, then Exim will
3411 not give up root privilege if the caller is root, the Exim run-time user, or
3412 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3413 to be removed in the future.  Acceptable values for the macros satisfy the
3414 regexp: &`^[A-Za-z0-9_/.-]*$`&
3415
3416 The entire option (including equals sign if present) must all be within one
3417 command line item. &%-D%& can be used to set the value of a macro to the empty
3418 string, in which case the equals sign is optional. These two commands are
3419 synonymous:
3420 .code
3421 exim -DABC  ...
3422 exim -DABC= ...
3423 .endd
3424 To include spaces in a macro definition item, quotes must be used. If you use
3425 quotes, spaces are permitted around the macro name and the equals sign. For
3426 example:
3427 .code
3428 exim '-D ABC = something' ...
3429 .endd
3430 &%-D%& may be repeated up to 10 times on a command line.
3431
3432
3433 .vitem &%-d%&<&'debug&~options'&>
3434 .oindex "&%-d%&"
3435 .cindex "debugging" "list of selectors"
3436 .cindex "debugging" "&%-d%& option"
3437 This option causes debugging information to be written to the standard
3438 error stream. It is restricted to admin users because debugging output may show
3439 database queries that contain password information. Also, the details of users'
3440 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3441 writes an error message to the standard error stream and exits with a non-zero
3442 return code.
3443
3444 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3445 standard debugging data is output. This can be reduced, or increased to include
3446 some more rarely needed information, by directly following &%-d%& with a string
3447 made up of names preceded by plus or minus characters. These add or remove sets
3448 of debugging data, respectively. For example, &%-d+filter%& adds filter
3449 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3450 no spaces are allowed in the debug setting. The available debugging categories
3451 are:
3452 .display
3453 &`acl            `& ACL interpretation
3454 &`auth           `& authenticators
3455 &`deliver        `& general delivery logic
3456 &`dns            `& DNS lookups (see also resolver)
3457 &`dnsbl          `& DNS black list (aka RBL) code
3458 &`exec           `& arguments for &[execv()]& calls
3459 &`expand         `& detailed debugging for string expansions
3460 &`filter         `& filter handling
3461 &`hints_lookup   `& hints data lookups
3462 &`host_lookup    `& all types of name-to-IP address handling
3463 &`ident          `& ident lookup
3464 &`interface      `& lists of local interfaces
3465 &`lists          `& matching things in lists
3466 &`load           `& system load checks
3467 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3468                     &<<CHAPlocalscan>>&)
3469 &`lookup         `& general lookup code and all lookups
3470 &`memory         `& memory handling
3471 &`pid            `& add pid to debug output lines
3472 &`process_info   `& setting info for the process log
3473 &`queue_run      `& queue runs
3474 &`receive        `& general message reception logic
3475 &`resolver       `& turn on the DNS resolver's debugging output
3476 &`retry          `& retry handling
3477 &`rewrite        `& address rewriting
3478 &`route          `& address routing
3479 &`timestamp      `& add timestamp to debug output lines
3480 &`tls            `& TLS logic
3481 &`transport      `& transports
3482 &`uid            `& changes of uid/gid and looking up uid/gid
3483 &`verify         `& address verification logic
3484 &`all            `& almost all of the above (see below), and also &%-v%&
3485 .endd
3486 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3487 for &`-all`&. The reason for this is that &`+all`& is something that people
3488 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3489 is included, an awful lot of output that is very rarely of interest is
3490 generated, so it now has to be explicitly requested. However, &`-all`& does
3491 turn everything off.
3492
3493 .cindex "resolver, debugging output"
3494 .cindex "DNS resolver, debugging output"
3495 The &`resolver`& option produces output only if the DNS resolver was compiled
3496 with DEBUG enabled. This is not the case in some operating systems. Also,
3497 unfortunately, debugging output from the DNS resolver is written to stdout
3498 rather than stderr.
3499
3500 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3501 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3502 However, the &`pid`& selector is forced when debugging is turned on for a
3503 daemon, which then passes it on to any re-executed Exims. Exim also
3504 automatically adds the pid to debug lines when several remote deliveries are
3505 run in parallel.
3506
3507 The &`timestamp`& selector causes the current time to be inserted at the start
3508 of all debug output lines. This can be useful when trying to track down delays
3509 in processing.
3510
3511 If the &%debug_print%& option is set in any driver, it produces output whenever
3512 any debugging is selected, or if &%-v%& is used.
3513
3514 .vitem &%-dd%&<&'debug&~options'&>
3515 .oindex "&%-dd%&"
3516 This option behaves exactly like &%-d%& except when used on a command that
3517 starts a daemon process. In that case, debugging is turned off for the
3518 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3519 behaviour of the daemon without creating as much output as full debugging does.
3520
3521 .vitem &%-dropcr%&
3522 .oindex "&%-dropcr%&"
3523 This is an obsolete option that is now a no-op. It used to affect the way Exim
3524 handled CR and LF characters in incoming messages. What happens now is
3525 described in section &<<SECTlineendings>>&.
3526
3527 .vitem &%-E%&
3528 .oindex "&%-E%&"
3529 .cindex "bounce message" "generating"
3530 This option specifies that an incoming message is a locally-generated delivery
3531 failure report. It is used internally by Exim when handling delivery failures
3532 and is not intended for external use. Its only effect is to stop Exim
3533 generating certain messages to the postmaster, as otherwise message cascades
3534 could occur in some situations. As part of the same option, a message id may
3535 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3536 new message contains the id, following &"R="&, as a cross-reference.
3537
3538 .vitem &%-e%&&'x'&
3539 .oindex "&%-e%&&'x'&"
3540 There are a number of Sendmail options starting with &%-oe%& which seem to be
3541 called by various programs without the leading &%o%& in the option. For
3542 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3543 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3544
3545 .vitem &%-F%&&~<&'string'&>
3546 .oindex "&%-F%&"
3547 .cindex "sender" "name"
3548 .cindex "name" "of sender"
3549 This option sets the sender's full name for use when a locally-generated
3550 message is being accepted. In the absence of this option, the user's &'gecos'&
3551 entry from the password data is used. As users are generally permitted to alter
3552 their &'gecos'& entries, no security considerations are involved. White space
3553 between &%-F%& and the <&'string'&> is optional.
3554
3555 .vitem &%-f%&&~<&'address'&>
3556 .oindex "&%-f%&"
3557 .cindex "sender" "address"
3558 .cindex "address" "sender"
3559 .cindex "trusted users"
3560 .cindex "envelope sender"
3561 .cindex "user" "trusted"
3562 This option sets the address of the envelope sender of a locally-generated
3563 message (also known as the return path). The option can normally be used only
3564 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3565 users to use it.
3566
3567 Processes running as root or the Exim user are always trusted. Other
3568 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3569 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3570 of a local message is set to the caller's login name at the default qualify
3571 domain.
3572
3573 There is one exception to the restriction on the use of &%-f%&: an empty sender
3574 can be specified by any user, trusted or not, to create a message that can
3575 never provoke a bounce. An empty sender can be specified either as an empty
3576 string, or as a pair of angle brackets with nothing between them, as in these
3577 examples of shell commands:
3578 .code
3579 exim -f '<>' user@domain
3580 exim -f "" user@domain
3581 .endd
3582 In addition, the use of &%-f%& is not restricted when testing a filter file
3583 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3584 &%-bv%& options.
3585
3586 Allowing untrusted users to change the sender address does not of itself make
3587 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3588 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3589 though this can be overridden by setting &%no_local_from_check%&.
3590
3591 White
3592 .cindex "&""From""& line"
3593 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3594 given as two arguments or one combined argument). The sender of a
3595 locally-generated message can also be set (when permitted) by an initial
3596 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3597 if &%-f%& is also present, it overrides &"From&~"&.
3598
3599 .vitem &%-G%&
3600 .oindex "&%-G%&"
3601 .cindex "Sendmail compatibility" "&%-G%& option ignored"
3602 This is a Sendmail option which is ignored by Exim.
3603
3604 .vitem &%-h%&&~<&'number'&>
3605 .oindex "&%-h%&"
3606 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3607 This option is accepted for compatibility with Sendmail, but has no effect. (In
3608 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3609 headers.)
3610
3611 .vitem &%-i%&
3612 .oindex "&%-i%&"
3613 .cindex "Solaris" "&'mail'& command"
3614 .cindex "dot" "in incoming non-SMTP message"
3615 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3616 line by itself should not terminate an incoming, non-SMTP message. I can find
3617 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3618 command in Solaris 2.4 uses it. See also &%-ti%&.
3619
3620 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3621 .oindex "&%-M%&"
3622 .cindex "forcing delivery"
3623 .cindex "delivery" "forcing attempt"
3624 .cindex "frozen messages" "forcing delivery"
3625 This option requests Exim to run a delivery attempt on each message in turn. If
3626 any of the messages are frozen, they are automatically thawed before the
3627 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3628 and &%hold_domains%& are ignored.
3629
3630 Retry
3631 .cindex "hints database" "overriding retry hints"
3632 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3633 the normal retry time has not yet been reached. This option requires the caller
3634 to be an admin user. However, there is an option called &%prod_requires_admin%&
3635 which can be set false to relax this restriction (and also the same requirement
3636 for the &%-q%&, &%-R%&, and &%-S%& options).
3637
3638 The deliveries happen synchronously, that is, the original Exim process does
3639 not terminate until all the delivery attempts have finished. No output is
3640 produced unless there is a serious error. If you want to see what is happening,
3641 use the &%-v%& option as well, or inspect Exim's main log.
3642
3643 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3644 .oindex "&%-Mar%&"
3645 .cindex "message" "adding recipients"
3646 .cindex "recipient" "adding"
3647 This option requests Exim to add the addresses to the list of recipients of the
3648 message (&"ar"& for &"add recipients"&). The first argument must be a message
3649 id, and the remaining ones must be email addresses. However, if the message is
3650 active (in the middle of a delivery attempt), it is not altered. This option
3651 can be used only by an admin user.
3652
3653 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3654         &~<&'message&~id'&>"
3655 .oindex "&%-MC%&"
3656 .cindex "SMTP" "passed connection"
3657 .cindex "SMTP" "multiple deliveries"
3658 .cindex "multiple SMTP deliveries"
3659 This option is not intended for use by external callers. It is used internally
3660 by Exim to invoke another instance of itself to deliver a waiting message using
3661 an existing SMTP connection, which is passed as the standard input. Details are
3662 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3663 must be root or the Exim user in order to use it.
3664
3665 .vitem &%-MCA%&
3666 .oindex "&%-MCA%&"
3667 This option is not intended for use by external callers. It is used internally
3668 by Exim in conjunction with the &%-MC%& option. It signifies that the
3669 connection to the remote host has been authenticated.
3670
3671 .vitem &%-MCP%&
3672 .oindex "&%-MCP%&"
3673 This option is not intended for use by external callers. It is used internally
3674 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3675 which Exim is connected supports pipelining.
3676
3677 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3678 .oindex "&%-MCQ%&"
3679 This option is not intended for use by external callers. It is used internally
3680 by Exim in conjunction with the &%-MC%& option when the original delivery was
3681 started by a queue runner. It passes on the process id of the queue runner,
3682 together with the file descriptor number of an open pipe. Closure of the pipe
3683 signals the final completion of the sequence of processes that are passing
3684 messages through the same SMTP connection.
3685
3686 .vitem &%-MCS%&
3687 .oindex "&%-MCS%&"
3688 This option is not intended for use by external callers. It is used internally
3689 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3690 SMTP SIZE option should be used on messages delivered down the existing
3691 connection.
3692
3693 .vitem &%-MCT%&
3694 .oindex "&%-MCT%&"
3695 This option is not intended for use by external callers. It is used internally
3696 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3697 host to which Exim is connected supports TLS encryption.
3698
3699 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3700 .oindex "&%-Mc%&"
3701 .cindex "hints database" "not overridden by &%-Mc%&"
3702 .cindex "delivery" "manually started &-- not forced"
3703 This option requests Exim to run a delivery attempt on each message in turn,
3704 but unlike the &%-M%& option, it does check for retry hints, and respects any
3705 that are found. This option is not very useful to external callers. It is
3706 provided mainly for internal use by Exim when it needs to re-invoke itself in
3707 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3708 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3709 respects retry times and other options such as &%hold_domains%& that are
3710 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3711 If you want to run a specific delivery as if in a queue run, you should use
3712 &%-q%& with a message id argument. A distinction between queue run deliveries
3713 and other deliveries is made in one or two places.
3714
3715 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3716 .oindex "&%-Mes%&"
3717 .cindex "message" "changing sender"
3718 .cindex "sender" "changing"
3719 This option requests Exim to change the sender address in the message to the
3720 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3721 &"edit sender"&). There must be exactly two arguments. The first argument must
3722 be a message id, and the second one an email address. However, if the message
3723 is active (in the middle of a delivery attempt), its status is not altered.
3724 This option can be used only by an admin user.
3725
3726 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3727 .oindex "&%-Mf%&"
3728 .cindex "freezing messages"
3729 .cindex "message" "manually freezing"
3730 This option requests Exim to mark each listed message as &"frozen"&. This
3731 prevents any delivery attempts taking place until the message is &"thawed"&,
3732 either manually or as a result of the &%auto_thaw%& configuration option.
3733 However, if any of the messages are active (in the middle of a delivery
3734 attempt), their status is not altered. This option can be used only by an admin
3735 user.
3736
3737 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3738 .oindex "&%-Mg%&"
3739 .cindex "giving up on messages"
3740 .cindex "message" "abandoning delivery attempts"
3741 .cindex "delivery" "abandoning further attempts"
3742 This option requests Exim to give up trying to deliver the listed messages,
3743 including any that are frozen. However, if any of the messages are active,
3744 their status is not altered. For non-bounce messages, a delivery error message
3745 is sent to the sender, containing the text &"cancelled by administrator"&.
3746 Bounce messages are just discarded. This option can be used only by an admin
3747 user.
3748
3749 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3750 .oindex "&%-Mmad%&"
3751 .cindex "delivery" "cancelling all"
3752 This option requests Exim to mark all the recipient addresses in the messages
3753 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3754 message is active (in the middle of a delivery attempt), its status is not
3755 altered. This option can be used only by an admin user.
3756
3757 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3758 .oindex "&%-Mmd%&"
3759 .cindex "delivery" "cancelling by address"
3760 .cindex "recipient" "removing"
3761 .cindex "removing recipients"
3762 This option requests Exim to mark the given addresses as already delivered
3763 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3764 the remaining ones must be email addresses. These are matched to recipient
3765 addresses in the message in a case-sensitive manner. If the message is active
3766 (in the middle of a delivery attempt), its status is not altered. This option
3767 can be used only by an admin user.
3768
3769 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3770 .oindex "&%-Mrm%&"
3771 .cindex "removing messages"
3772 .cindex "abandoning mail"
3773 .cindex "message" "manually discarding"
3774 This option requests Exim to remove the given messages from the queue. No
3775 bounce messages are sent; each message is simply forgotten. However, if any of
3776 the messages are active, their status is not altered. This option can be used
3777 only by an admin user or by the user who originally caused the message to be
3778 placed on the queue.
3779
3780 .vitem &%-Mset%&&~<&'message&~id'&>
3781 .oindex "&%-Mset%&
3782 .cindex "testing" "string expansion"
3783 .cindex "expansion" "testing"
3784 This option is useful only in conjunction with &%-be%& (that is, when testing
3785 string expansions). Exim loads the given message from its spool before doing
3786 the test expansions, thus setting message-specific variables such as
3787 &$message_size$& and the header variables. The &$recipients$& variable is made
3788 available. This feature is provided to make it easier to test expansions that
3789 make use of these variables. However, this option can be used only by an admin
3790 user. See also &%-bem%&.
3791
3792 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3793 .oindex "&%-Mt%&"
3794 .cindex "thawing messages"
3795 .cindex "unfreezing messages"
3796 .cindex "frozen messages" "thawing"
3797 .cindex "message" "thawing frozen"
3798 This option requests Exim to &"thaw"& any of the listed messages that are
3799 &"frozen"&, so that delivery attempts can resume. However, if any of the
3800 messages are active, their status is not altered. This option can be used only
3801 by an admin user.
3802
3803 .vitem &%-Mvb%&&~<&'message&~id'&>
3804 .oindex "&%-Mvb%&"
3805 .cindex "listing" "message body"
3806 .cindex "message" "listing body of"
3807 This option causes the contents of the message body (-D) spool file to be
3808 written to the standard output. This option can be used only by an admin user.
3809
3810 .vitem &%-Mvc%&&~<&'message&~id'&>
3811 .oindex "&%-Mvc%&"
3812 .cindex "message" "listing in RFC 2822 format"
3813 .cindex "listing" "message in RFC 2822 format"
3814 This option causes a copy of the complete message (header lines plus body) to
3815 be written to the standard output in RFC 2822 format. This option can be used
3816 only by an admin user.
3817
3818 .vitem &%-Mvh%&&~<&'message&~id'&>
3819 .oindex "&%-Mvh%&"
3820 .cindex "listing" "message headers"
3821 .cindex "header lines" "listing"
3822 .cindex "message" "listing header lines"
3823 This option causes the contents of the message headers (-H) spool file to be
3824 written to the standard output. This option can be used only by an admin user.
3825
3826 .vitem &%-Mvl%&&~<&'message&~id'&>
3827 .oindex "&%-Mvl%&"
3828 .cindex "listing" "message log"
3829 .cindex "message" "listing message log"
3830 This option causes the contents of the message log spool file to be written to
3831 the standard output. This option can be used only by an admin user.
3832
3833 .vitem &%-m%&
3834 .oindex "&%-m%&"
3835 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3836 treats it that way too.
3837
3838 .vitem &%-N%&
3839 .oindex "&%-N%&"
3840 .cindex "debugging" "&%-N%& option"
3841 .cindex "debugging" "suppressing delivery"
3842 This is a debugging option that inhibits delivery of a message at the transport
3843 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3844 it just doesn't actually transport the message, but instead behaves as if it
3845 had successfully done so. However, it does not make any updates to the retry
3846 database, and the log entries for deliveries are flagged with &"*>"& rather
3847 than &"=>"&.
3848
3849 Because &%-N%& discards any message to which it applies, only root or the Exim
3850 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3851 words, an ordinary user can use it only when supplying an incoming message to
3852 which it will apply. Although transportation never fails when &%-N%& is set, an
3853 address may be deferred because of a configuration problem on a transport, or a
3854 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3855 the message, and applies to any subsequent delivery attempts that may happen
3856 for that message.
3857
3858 .vitem &%-n%&
3859 .oindex "&%-n%&"
3860 .cindex "Sendmail compatibility" "&%-n%& option ignored"
3861 This option is interpreted by Sendmail to mean &"no aliasing"&. It is ignored
3862 by Exim.
3863
3864 .vitem &%-O%&&~<&'data'&>
3865 .oindex "&%-O%&"
3866 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3867 Exim.
3868
3869 .vitem &%-oA%&&~<&'file&~name'&>
3870 .oindex "&%-oA%&"
3871 .cindex "Sendmail compatibility" "&%-oA%& option"
3872 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3873 alternative alias file name. Exim handles &%-bi%& differently; see the
3874 description above.
3875
3876 .vitem &%-oB%&&~<&'n'&>
3877 .oindex "&%-oB%&"
3878 .cindex "SMTP" "passed connection"
3879 .cindex "SMTP" "multiple deliveries"
3880 .cindex "multiple SMTP deliveries"
3881 This is a debugging option which limits the maximum number of messages that can
3882 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
3883 transport. If <&'n'&> is omitted, the limit is set to 1.
3884
3885 .vitem &%-odb%&
3886 .oindex "&%-odb%&"
3887 .cindex "background delivery"
3888 .cindex "delivery" "in the background"
3889 This option applies to all modes in which Exim accepts incoming messages,
3890 including the listening daemon. It requests &"background"& delivery of such
3891 messages, which means that the accepting process automatically starts a
3892 delivery process for each message received, but does not wait for the delivery
3893 processes to finish.
3894
3895 When all the messages have been received, the reception process exits,
3896 leaving the delivery processes to finish in their own time. The standard output
3897 and error streams are closed at the start of each delivery process.
3898 This is the default action if none of the &%-od%& options are present.
3899
3900 If one of the queueing options in the configuration file
3901 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
3902 overrides it if &%queue_only_override%& is set true, which is the default
3903 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
3904
3905 .vitem &%-odf%&
3906 .oindex "&%-odf%&"
3907 .cindex "foreground delivery"
3908 .cindex "delivery" "in the foreground"
3909 This option requests &"foreground"& (synchronous) delivery when Exim has
3910 accepted a locally-generated message. (For the daemon it is exactly the same as
3911 &%-odb%&.) A delivery process is automatically started to deliver the message,
3912 and Exim waits for it to complete before proceeding.
3913
3914 The original Exim reception process does not finish until the delivery
3915 process for the final message has ended. The standard error stream is left open
3916 during deliveries.
3917
3918 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
3919 false and one of the queueing options in the configuration file is in effect.
3920
3921 If there is a temporary delivery error during foreground delivery, the
3922 message is left on the queue for later delivery, and the original reception
3923 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
3924 restricted configuration that never queues messages.
3925
3926
3927 .vitem &%-odi%&
3928 .oindex "&%-odi%&"
3929 This option is synonymous with &%-odf%&. It is provided for compatibility with
3930 Sendmail.
3931
3932 .vitem &%-odq%&
3933 .oindex "&%-odq%&"
3934 .cindex "non-immediate delivery"
3935 .cindex "delivery" "suppressing immediate"
3936 .cindex "queueing incoming messages"
3937 This option applies to all modes in which Exim accepts incoming messages,
3938 including the listening daemon. It specifies that the accepting process should
3939 not automatically start a delivery process for each message received. Messages
3940 are placed on the queue, and remain there until a subsequent queue runner
3941 process encounters them. There are several configuration options (such as
3942 &%queue_only%&) that can be used to queue incoming messages under certain
3943 conditions. This option overrides all of them and also &%-odqs%&. It always
3944 forces queueing.
3945
3946 .vitem &%-odqs%&
3947 .oindex "&%-odqs%&"
3948 .cindex "SMTP" "delaying delivery"
3949 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
3950 However, like &%-odb%& and &%-odi%&, this option has no effect if
3951 &%queue_only_override%& is false and one of the queueing options in the
3952 configuration file is in effect.
3953
3954 When &%-odqs%& does operate, a delivery process is started for each incoming
3955 message, in the background by default, but in the foreground if &%-odi%& is
3956 also present. The recipient addresses are routed, and local deliveries are done
3957 in the normal way. However, if any SMTP deliveries are required, they are not
3958 done at this time, so the message remains on the queue until a subsequent queue
3959 runner process encounters it. Because routing was done, Exim knows which
3960 messages are waiting for which hosts, and so a number of messages for the same
3961 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
3962 configuration option has the same effect for specific domains. See also the
3963 &%-qq%& option.
3964
3965 .vitem &%-oee%&
3966 .oindex "&%-oee%&"
3967 .cindex "error" "reporting"
3968 If an error is detected while a non-SMTP message is being received (for
3969 example, a malformed address), the error is reported to the sender in a mail
3970 message.
3971
3972 .cindex "return code" "for &%-oee%&"
3973 Provided
3974 this error message is successfully sent, the Exim receiving process
3975 exits with a return code of zero. If not, the return code is 2 if the problem
3976 is that the original message has no recipients, or 1 any other error. This is
3977 the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
3978
3979 .vitem &%-oem%&
3980 .oindex "&%-oem%&"
3981 .cindex "error" "reporting"
3982 .cindex "return code" "for &%-oem%&"
3983 This is the same as &%-oee%&, except that Exim always exits with a non-zero
3984 return code, whether or not the error message was successfully sent.
3985 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
3986
3987 .vitem &%-oep%&
3988 .oindex "&%-oep%&"
3989 .cindex "error" "reporting"
3990 If an error is detected while a non-SMTP message is being received, the
3991 error is reported by writing a message to the standard error file (stderr).
3992 .cindex "return code" "for &%-oep%&"
3993 The return code is 1 for all errors.
3994
3995 .vitem &%-oeq%&
3996 .oindex "&%-oeq%&"
3997 .cindex "error" "reporting"
3998 This option is supported for compatibility with Sendmail, but has the same
3999 effect as &%-oep%&.
4000
4001 .vitem &%-oew%&
4002 .oindex "&%-oew%&"
4003 .cindex "error" "reporting"
4004 This option is supported for compatibility with Sendmail, but has the same
4005 effect as &%-oem%&.
4006
4007 .vitem &%-oi%&
4008 .oindex "&%-oi%&"
4009 .cindex "dot" "in incoming non-SMTP message"
4010 This option, which has the same effect as &%-i%&, specifies that a dot on a
4011 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4012 single dot does terminate, though Exim does no special processing for other
4013 lines that start with a dot. This option is set by default if Exim is called as
4014 &'rmail'&. See also &%-ti%&.
4015
4016 .vitem &%-oitrue%&
4017 .oindex "&%-oitrue%&"
4018 This option is treated as synonymous with &%-oi%&.
4019
4020 .vitem &%-oMa%&&~<&'host&~address'&>
4021 .oindex "&%-oMa%&"
4022 .cindex "sender" "host address, specifying for local message"
4023 A number of options starting with &%-oM%& can be used to set values associated
4024 with remote hosts on locally-submitted messages (that is, messages not received
4025 over TCP/IP). These options can be used by any caller in conjunction with the
4026 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4027 other circumstances, they are ignored unless the caller is trusted.
4028
4029 The &%-oMa%& option sets the sender host address. This may include a port
4030 number at the end, after a full stop (period). For example:
4031 .code
4032 exim -bs -oMa 10.9.8.7.1234
4033 .endd
4034 An alternative syntax is to enclose the IP address in square brackets,
4035 followed by a colon and the port number:
4036 .code
4037 exim -bs -oMa [10.9.8.7]:1234
4038 .endd
4039 The IP address is placed in the &$sender_host_address$& variable, and the
4040 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4041 are present on the command line, the sender host IP address is taken from
4042 whichever one is last.
4043
4044 .vitem &%-oMaa%&&~<&'name'&>
4045 .oindex "&%-oMaa%&"
4046 .cindex "authentication" "name, specifying for local message"
4047 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4048 option sets the value of &$sender_host_authenticated$& (the authenticator
4049 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4050 This option can be used with &%-bh%& and &%-bs%& to set up an
4051 authenticated SMTP session without actually using the SMTP AUTH command.
4052
4053 .vitem &%-oMai%&&~<&'string'&>
4054 .oindex "&%-oMai%&"
4055 .cindex "authentication" "id, specifying for local message"
4056 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4057 option sets the value of &$authenticated_id$& (the id that was authenticated).
4058 This overrides the default value (the caller's login id, except with &%-bh%&,
4059 where there is no default) for messages from local sources. See chapter
4060 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4061
4062 .vitem &%-oMas%&&~<&'address'&>
4063 .oindex "&%-oMas%&"
4064 .cindex "authentication" "sender, specifying for local message"
4065 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4066 option sets the authenticated sender value in &$authenticated_sender$&. It
4067 overrides the sender address that is created from the caller's login id for
4068 messages from local sources, except when &%-bh%& is used, when there is no
4069 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4070 specified on a MAIL command overrides this value. See chapter
4071 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4072
4073 .vitem &%-oMi%&&~<&'interface&~address'&>
4074 .oindex "&%-oMi%&"
4075 .cindex "interface" "address, specifying for local message"
4076 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4077 option sets the IP interface address value. A port number may be included,
4078 using the same syntax as for &%-oMa%&. The interface address is placed in
4079 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4080
4081 .vitem &%-oMr%&&~<&'protocol&~name'&>
4082 .oindex "&%-oMr%&"
4083 .cindex "protocol, specifying for local message"
4084 .vindex "&$received_protocol$&"
4085 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4086 option sets the received protocol value that is stored in
4087 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4088 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4089 SMTP protocol names (see the description of &$received_protocol$& in section
4090 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4091 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4092 be set by &%-oMr%&.
4093
4094 .vitem &%-oMs%&&~<&'host&~name'&>
4095 .oindex "&%-oMs%&"
4096 .cindex "sender" "host name, specifying for local message"
4097 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4098 option sets the sender host name in &$sender_host_name$&. When this option is
4099 present, Exim does not attempt to look up a host name from an IP address; it
4100 uses the name it is given.
4101
4102 .vitem &%-oMt%&&~<&'ident&~string'&>
4103 .oindex "&%-oMt%&"
4104 .cindex "sender" "ident string, specifying for local message"
4105 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4106 option sets the sender ident value in &$sender_ident$&. The default setting for
4107 local callers is the login id of the calling process, except when &%-bh%& is
4108 used, when there is no default.
4109
4110 .vitem &%-om%&
4111 .oindex "&%-om%&"
4112 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4113 In Sendmail, this option means &"me too"&, indicating that the sender of a
4114 message should receive a copy of the message if the sender appears in an alias
4115 expansion. Exim always does this, so the option does nothing.
4116
4117 .vitem &%-oo%&
4118 .oindex "&%-oo%&"
4119 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4120 This option is ignored. In Sendmail it specifies &"old style headers"&,
4121 whatever that means.
4122
4123 .vitem &%-oP%&&~<&'path'&>
4124 .oindex "&%-oP%&"
4125 .cindex "pid (process id)" "of daemon"
4126 .cindex "daemon" "process id (pid)"
4127 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4128 value. The option specifies the file to which the process id of the daemon is
4129 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4130 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4131 because in those cases, the normal pid file is not used.
4132
4133 .vitem &%-or%&&~<&'time'&>
4134 .oindex "&%-or%&"
4135 .cindex "timeout" "for non-SMTP input"
4136 This option sets a timeout value for incoming non-SMTP messages. If it is not
4137 set, Exim will wait forever for the standard input. The value can also be set
4138 by the &%receive_timeout%& option. The format used for specifying times is
4139 described in section &<<SECTtimeformat>>&.
4140
4141 .vitem &%-os%&&~<&'time'&>
4142 .oindex "&%-os%&"
4143 .cindex "timeout" "for SMTP input"
4144 .cindex "SMTP" "input timeout"
4145 This option sets a timeout value for incoming SMTP messages. The timeout
4146 applies to each SMTP command and block of data. The value can also be set by
4147 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4148 for specifying times is described in section &<<SECTtimeformat>>&.
4149
4150 .vitem &%-ov%&
4151 .oindex "&%-ov%&"
4152 This option has exactly the same effect as &%-v%&.
4153
4154 .vitem &%-oX%&&~<&'number&~or&~string'&>
4155 .oindex "&%-oX%&"
4156 .cindex "TCP/IP" "setting listening ports"
4157 .cindex "TCP/IP" "setting listening interfaces"
4158 .cindex "port" "receiving TCP/IP"
4159 This option is relevant only when the &%-bd%& (start listening daemon) option
4160 is also given. It controls which ports and interfaces the daemon uses. Details
4161 of the syntax, and how it interacts with configuration file options, are given
4162 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4163 file is written unless &%-oP%& is also present to specify a pid file name.
4164
4165 .vitem &%-pd%&
4166 .oindex "&%-pd%&"
4167 .cindex "Perl" "starting the interpreter"
4168 This option applies when an embedded Perl interpreter is linked with Exim (see
4169 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4170 option, forcing the starting of the interpreter to be delayed until it is
4171 needed.
4172
4173 .vitem &%-ps%&
4174 .oindex "&%-ps%&"
4175 .cindex "Perl" "starting the interpreter"
4176 This option applies when an embedded Perl interpreter is linked with Exim (see
4177 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4178 option, forcing the starting of the interpreter to occur as soon as Exim is
4179 started.
4180
4181 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4182 .oindex "&%-p%&"
4183 For compatibility with Sendmail, this option is equivalent to
4184 .display
4185 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4186 .endd
4187 It sets the incoming protocol and host name (for trusted callers). The
4188 host name and its colon can be omitted when only the protocol is to be set.
4189 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4190 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4191 or &`s`& using this option (but that does not seem a real limitation).
4192
4193 .vitem &%-q%&
4194 .oindex "&%-q%&"
4195 .cindex "queue runner" "starting manually"
4196 This option is normally restricted to admin users. However, there is a
4197 configuration option called &%prod_requires_admin%& which can be set false to
4198 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4199 and &%-S%& options).
4200
4201 .cindex "queue runner" "description of operation"
4202 The &%-q%& option starts one queue runner process. This scans the queue of
4203 waiting messages, and runs a delivery process for each one in turn. It waits
4204 for each delivery process to finish before starting the next one. A delivery
4205 process may not actually do any deliveries if the retry times for the addresses
4206 have not been reached. Use &%-qf%& (see below) if you want to override this.
4207
4208 If
4209 .cindex "SMTP" "passed connection"
4210 .cindex "SMTP" "multiple deliveries"
4211 .cindex "multiple SMTP deliveries"
4212 the delivery process spawns other processes to deliver other messages down
4213 passed SMTP connections, the queue runner waits for these to finish before
4214 proceeding.
4215
4216 When all the queued messages have been considered, the original queue runner
4217 process terminates. In other words, a single pass is made over the waiting
4218 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4219 this to be repeated periodically.
4220
4221 Exim processes the waiting messages in an unpredictable order. It isn't very
4222 random, but it is likely to be different each time, which is all that matters.
4223 If one particular message screws up a remote MTA, other messages to the same
4224 MTA have a chance of getting through if they get tried first.
4225
4226 It is possible to cause the messages to be processed in lexical message id
4227 order, which is essentially the order in which they arrived, by setting the
4228 &%queue_run_in_order%& option, but this is not recommended for normal use.
4229
4230 .vitem &%-q%&<&'qflags'&>
4231 The &%-q%& option may be followed by one or more flag letters that change its
4232 behaviour. They are all optional, but if more than one is present, they must
4233 appear in the correct order. Each flag is described in a separate item below.
4234
4235 .vitem &%-qq...%&
4236 .oindex "&%-qq%&"
4237 .cindex "queue" "double scanning"
4238 .cindex "queue" "routing"
4239 .cindex "routing" "whole queue before delivery"
4240 An option starting with &%-qq%& requests a two-stage queue run. In the first
4241 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4242 every domain. Addresses are routed, local deliveries happen, but no remote
4243 transports are run.
4244
4245 .cindex "hints database" "remembering routing"
4246 The hints database that remembers which messages are waiting for specific hosts
4247 is updated, as if delivery to those hosts had been deferred. After this is
4248 complete, a second, normal queue scan happens, with routing and delivery taking
4249 place as normal. Messages that are routed to the same host should mostly be
4250 delivered down a single SMTP
4251 .cindex "SMTP" "passed connection"
4252 .cindex "SMTP" "multiple deliveries"
4253 .cindex "multiple SMTP deliveries"
4254 connection because of the hints that were set up during the first queue scan.
4255 This option may be useful for hosts that are connected to the Internet
4256 intermittently.
4257
4258 .vitem &%-q[q]i...%&
4259 .oindex "&%-qi%&"
4260 .cindex "queue" "initial delivery"
4261 If the &'i'& flag is present, the queue runner runs delivery processes only for
4262 those messages that haven't previously been tried. (&'i'& stands for &"initial
4263 delivery"&.) This can be helpful if you are putting messages on the queue using
4264 &%-odq%& and want a queue runner just to process the new messages.
4265
4266 .vitem &%-q[q][i]f...%&
4267 .oindex "&%-qf%&"
4268 .cindex "queue" "forcing delivery"
4269 .cindex "delivery" "forcing in queue run"
4270 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4271 message, whereas without &'f'& only those non-frozen addresses that have passed
4272 their retry times are tried.
4273
4274 .vitem &%-q[q][i]ff...%&
4275 .oindex "&%-qff%&"
4276 .cindex "frozen messages" "forcing delivery"
4277 If &'ff'& is present, a delivery attempt is forced for every message, whether
4278 frozen or not.
4279
4280 .vitem &%-q[q][i][f[f]]l%&
4281 .oindex "&%-ql%&"
4282 .cindex "queue" "local deliveries only"
4283 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4284 be done. If a message requires any remote deliveries, it remains on the queue
4285 for later delivery.
4286
4287 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4288 .cindex "queue" "delivering specific messages"
4289 When scanning the queue, Exim can be made to skip over messages whose ids are
4290 lexically less than a given value by following the &%-q%& option with a
4291 starting message id. For example:
4292 .code
4293 exim -q 0t5C6f-0000c8-00
4294 .endd
4295 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4296 second message id is given, messages whose ids are lexically greater than it
4297 are also skipped. If the same id is given twice, for example,
4298 .code
4299 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4300 .endd
4301 just one delivery process is started, for that message. This differs from
4302 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4303 that it counts as a delivery from a queue run. Note that the selection
4304 mechanism does not affect the order in which the messages are scanned. There
4305 are also other ways of selecting specific sets of messages for delivery in a
4306 queue run &-- see &%-R%& and &%-S%&.
4307
4308 .vitem &%-q%&<&'qflags'&><&'time'&>
4309 .cindex "queue runner" "starting periodically"
4310 .cindex "periodic queue running"
4311 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4312 starting a queue runner process at intervals specified by the given time value
4313 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4314 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4315 single daemon process handles both functions. A common way of starting up a
4316 combined daemon at system boot time is to use a command such as
4317 .code
4318 /usr/exim/bin/exim -bd -q30m
4319 .endd
4320 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4321 process every 30 minutes.
4322
4323 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4324 pid file is written unless one is explicitly requested by the &%-oP%& option.
4325
4326 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4327 .oindex "&%-qR%&"
4328 This option is synonymous with &%-R%&. It is provided for Sendmail
4329 compatibility.
4330
4331 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4332 .oindex "&%-qS%&"
4333 This option is synonymous with &%-S%&.
4334
4335 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4336 .oindex "&%-R%&"
4337 .cindex "queue runner" "for specific recipients"
4338 .cindex "delivery" "to given domain"
4339 .cindex "domain" "delivery to"
4340 The <&'rsflags'&> may be empty, in which case the white space before the string
4341 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4342 which are the possible values for <&'rsflags'&>. White space is required if
4343 <&'rsflags'&> is not empty.
4344
4345 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4346 perform a single queue run, except that, when scanning the messages on the
4347 queue, Exim processes only those that have at least one undelivered recipient
4348 address containing the given string, which is checked in a case-independent
4349 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4350 regular expression; otherwise it is a literal string.
4351
4352 If you want to do periodic queue runs for messages with specific recipients,
4353 you can combine &%-R%& with &%-q%& and a time value. For example:
4354 .code
4355 exim -q25m -R @special.domain.example
4356 .endd
4357 This example does a queue run for messages with recipients in the given domain
4358 every 25 minutes. Any additional flags that are specified with &%-q%& are
4359 applied to each queue run.
4360
4361 Once a message is selected for delivery by this mechanism, all its addresses
4362 are processed. For the first selected message, Exim overrides any retry
4363 information and forces a delivery attempt for each undelivered address. This
4364 means that if delivery of any address in the first message is successful, any
4365 existing retry information is deleted, and so delivery attempts for that
4366 address in subsequently selected messages (which are processed without forcing)
4367 will run. However, if delivery of any address does not succeed, the retry
4368 information is updated, and in subsequently selected messages, the failing
4369 address will be skipped.
4370
4371 .cindex "frozen messages" "forcing delivery"
4372 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4373 all selected messages, not just the first; frozen messages are included when
4374 &'ff'& is present.
4375
4376 The &%-R%& option makes it straightforward to initiate delivery of all messages
4377 to a given domain after a host has been down for some time. When the SMTP
4378 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4379 effect is to run Exim with the &%-R%& option, but it can be configured to run
4380 an arbitrary command instead.
4381
4382 .vitem &%-r%&
4383 .oindex "&%-r%&"
4384 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4385
4386 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4387 .oindex "&%-S%&"
4388 .cindex "delivery" "from given sender"
4389 .cindex "queue runner" "for specific senders"
4390 This option acts like &%-R%& except that it checks the string against each
4391 message's sender instead of against the recipients. If &%-R%& is also set, both
4392 conditions must be met for a message to be selected. If either of the options
4393 has &'f'& or &'ff'& in its flags, the associated action is taken.
4394
4395 .vitem &%-Tqt%&&~<&'times'&>
4396 .oindex "&%-Tqt%&"
4397 This an option that is exclusively for use by the Exim testing suite. It is not
4398 recognized when Exim is run normally. It allows for the setting up of explicit
4399 &"queue times"& so that various warning/retry features can be tested.
4400
4401 .vitem &%-t%&
4402 .oindex "&%-t%&"
4403 .cindex "recipient" "extracting from header lines"
4404 .cindex "&'Bcc:'& header line"
4405 .cindex "&'Cc:'& header line"
4406 .cindex "&'To:'& header line"
4407 When Exim is receiving a locally-generated, non-SMTP message on its standard
4408 input, the &%-t%& option causes the recipients of the message to be obtained
4409 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4410 from the command arguments. The addresses are extracted before any rewriting
4411 takes place and the &'Bcc:'& header line, if present, is then removed.
4412
4413 .cindex "Sendmail compatibility" "&%-t%& option"
4414 If the command has any arguments, they specify addresses to which the message
4415 is &'not'& to be delivered. That is, the argument addresses are removed from
4416 the recipients list obtained from the headers. This is compatible with Smail 3
4417 and in accordance with the documented behaviour of several versions of
4418 Sendmail, as described in man pages on a number of operating systems (e.g.
4419 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4420 argument addresses to those obtained from the headers, and the O'Reilly
4421 Sendmail book documents it that way. Exim can be made to add argument addresses
4422 instead of subtracting them by setting the option
4423 &%extract_addresses_remove_arguments%& false.
4424
4425 .cindex "&%Resent-%& header lines" "with &%-t%&"
4426 If there are any &%Resent-%& header lines in the message, Exim extracts
4427 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4428 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4429 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4430 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4431
4432 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4433 message is resent several times). The RFC also specifies that they should be
4434 added at the front of the message, and separated by &'Received:'& lines. It is
4435 not at all clear how &%-t%& should operate in the present of multiple sets,
4436 nor indeed exactly what constitutes a &"set"&.
4437 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4438 are often added at the end of the header, and if a message is resent more than
4439 once, it is common for the original set of &%Resent-%& headers to be renamed as
4440 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4441
4442 .vitem &%-ti%&
4443 .oindex "&%-ti%&"
4444 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4445 compatibility with Sendmail.
4446
4447 .vitem &%-tls-on-connect%&
4448 .oindex "&%-tls-on-connect%&"
4449 .cindex "TLS" "use without STARTTLS"
4450 .cindex "TLS" "automatic start"
4451 This option is available when Exim is compiled with TLS support. It forces all
4452 incoming SMTP connections to behave as if the incoming port is listed in the
4453 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4454 &<<CHAPTLS>>& for further details.
4455
4456
4457 .vitem &%-U%&
4458 .oindex "&%-U%&"
4459 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4460 Sendmail uses this option for &"initial message submission"&, and its
4461 documentation states that in future releases, it may complain about
4462 syntactically invalid messages rather than fixing them when this flag is not
4463 set. Exim ignores this option.
4464
4465 .vitem &%-v%&
4466 .oindex "&%-v%&"
4467 This option causes Exim to write information to the standard error stream,
4468 describing what it is doing. In particular, it shows the log lines for
4469 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4470 dialogue is shown. Some of the log lines shown may not actually be written to
4471 the log if the setting of &%log_selector%& discards them. Any relevant
4472 selectors are shown with each log line. If none are shown, the logging is
4473 unconditional.
4474
4475 .vitem &%-x%&
4476 .oindex "&%-x%&"
4477 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4478 National Language Support extended characters in the body of the mail item"&).
4479 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4480 this option.
4481 .endlist
4482
4483 .ecindex IIDclo1
4484 .ecindex IIDclo2
4485
4486
4487 . ////////////////////////////////////////////////////////////////////////////
4488 . Insert a stylized DocBook comment here, to identify the end of the command
4489 . line options. This is for the benefit of the Perl script that automatically
4490 . creates a man page for the options.
4491 . ////////////////////////////////////////////////////////////////////////////
4492
4493 .literal xml
4494 <!-- === End of command line options === -->
4495 .literal off
4496
4497
4498
4499
4500
4501 . ////////////////////////////////////////////////////////////////////////////
4502 . ////////////////////////////////////////////////////////////////////////////
4503
4504
4505 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4506          "The runtime configuration file"
4507
4508 .cindex "run time configuration"
4509 .cindex "configuration file" "general description"
4510 .cindex "CONFIGURE_FILE"
4511 .cindex "configuration file" "errors in"
4512 .cindex "error" "in configuration file"
4513 .cindex "return code" "for bad configuration"
4514 Exim uses a single run time configuration file that is read whenever an Exim
4515 binary is executed. Note that in normal operation, this happens frequently,
4516 because Exim is designed to operate in a distributed manner, without central
4517 control.
4518
4519 If a syntax error is detected while reading the configuration file, Exim
4520 writes a message on the standard error, and exits with a non-zero return code.
4521 The message is also written to the panic log. &*Note*&: Only simple syntax
4522 errors can be detected at this time. The values of any expanded options are
4523 not checked until the expansion happens, even when the expansion does not
4524 actually alter the string.
4525
4526 The name of the configuration file is compiled into the binary for security
4527 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4528 most configurations, this specifies a single file. However, it is permitted to
4529 give a colon-separated list of file names, in which case Exim uses the first
4530 existing file in the list.
4531
4532 .cindex "EXIM_USER"
4533 .cindex "EXIM_GROUP"
4534 .cindex "CONFIGURE_OWNER"
4535 .cindex "CONFIGURE_GROUP"
4536 .cindex "configuration file" "ownership"
4537 .cindex "ownership" "configuration file"
4538 The run time configuration file must be owned by root or by the user that is
4539 specified at compile time by the CONFIGURE_OWNER option (if set). The
4540 configuration file must not be world-writeable, or group-writeable unless its
4541 group is the root group or the one specified at compile time by the
4542 CONFIGURE_GROUP option.
4543
4544 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4545 to root, anybody who is able to edit the run time configuration file has an
4546 easy way to run commands as root. If you specify a user or group in the
4547 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4548 who are members of that group will trivially be able to obtain root privileges.
4549
4550 Up to Exim version 4.72, the run time configuration file was also permitted to
4551 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4552 since it offered a simple privilege escalation for any attacker who managed to
4553 compromise the Exim user account.
4554
4555 A default configuration file, which will work correctly in simple situations,
4556 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4557 defines just one file name, the installation process copies the default
4558 configuration to a new file of that name if it did not previously exist. If
4559 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4560 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4561 configuration.
4562
4563
4564
4565 .section "Using a different configuration file" "SECID40"
4566 .cindex "configuration file" "alternate"
4567 A one-off alternate configuration can be specified by the &%-C%& command line
4568 option, which may specify a single file or a list of files. However, when
4569 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4570 unless the argument for &%-C%& is identical to the built-in value from
4571 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4572 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4573 is useful mainly for checking the syntax of configuration files before
4574 installing them. No owner or group checks are done on a configuration file
4575 specified by &%-C%&, if root privilege has been dropped.
4576
4577 Even the Exim user is not trusted to specify an arbitrary configuration file
4578 with the &%-C%& option to be used with root privileges, unless that file is
4579 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4580 testing a configuration using &%-C%& right through message reception and
4581 delivery, even if the caller is root. The reception works, but by that time,
4582 Exim is running as the Exim user, so when it re-execs to regain privilege for
4583 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4584 can test reception and delivery using two separate commands (one to put a
4585 message on the queue, using &%-odq%&, and another to do the delivery, using
4586 &%-M%&).
4587
4588 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4589 prefix string with which any file named in a &%-C%& command line option must
4590 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4591 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4592 name can be used with &%-C%&.
4593
4594 One-off changes to a configuration can be specified by the &%-D%& command line
4595 option, which defines and overrides values for macros used inside the
4596 configuration file. However, like &%-C%&, the use of this option by a
4597 non-privileged user causes Exim to discard its root privilege.
4598 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4599 completely disabled, and its use causes an immediate error exit.
4600
4601 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4602 to declare certain macro names trusted, such that root privilege will not
4603 necessarily be discarded.
4604 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4605 considered safe and, if &%-D%& only supplies macros from this list, and the
4606 values are acceptable, then Exim will not give up root privilege if the caller
4607 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4608 transition mechanism and is expected to be removed in the future.  Acceptable
4609 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4610
4611 Some sites may wish to use the same Exim binary on different machines that
4612 share a file system, but to use different configuration files on each machine.
4613 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4614 looks for a file whose name is the configuration file name followed by a dot
4615 and the machine's node name, as obtained from the &[uname()]& function. If this
4616 file does not exist, the standard name is tried. This processing occurs for
4617 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4618
4619 In some esoteric situations different versions of Exim may be run under
4620 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4621 help with this. See the comments in &_src/EDITME_& for details.
4622
4623
4624
4625 .section "Configuration file format" "SECTconffilfor"
4626 .cindex "configuration file" "format of"
4627 .cindex "format" "configuration file"
4628 Exim's configuration file is divided into a number of different parts. General
4629 option settings must always appear at the start of the file. The other parts
4630 are all optional, and may appear in any order. Each part other than the first
4631 is introduced by the word &"begin"& followed by the name of the part. The
4632 optional parts are:
4633
4634 .ilist
4635 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4636 &<<CHAPACL>>&).
4637 .next
4638 .cindex "AUTH" "configuration"
4639 &'authenticators'&: Configuration settings for the authenticator drivers. These
4640 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4641 .next
4642 &'routers'&: Configuration settings for the router drivers. Routers process
4643 addresses and determine how the message is to be delivered (see chapters
4644 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4645 .next
4646 &'transports'&: Configuration settings for the transport drivers. Transports
4647 define mechanisms for copying messages to destinations (see chapters
4648 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4649 .next
4650 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4651 If there is no retry section, or if it is empty (that is, no retry rules are
4652 defined), Exim will not retry deliveries. In this situation, temporary errors
4653 are treated the same as permanent errors. Retry rules are discussed in chapter
4654 &<<CHAPretry>>&.
4655 .next
4656 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4657 when new addresses are generated during delivery. Rewriting is discussed in
4658 chapter &<<CHAPrewrite>>&.
4659 .next
4660 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4661 want to use this feature, you must set
4662 .code
4663 LOCAL_SCAN_HAS_OPTIONS=yes
4664 .endd
4665 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4666 facility are given in chapter &<<CHAPlocalscan>>&.
4667 .endlist
4668
4669 .cindex "configuration file" "leading white space in"
4670 .cindex "configuration file" "trailing white space in"
4671 .cindex "white space" "in configuration file"
4672 Leading and trailing white space in configuration lines is always ignored.
4673
4674 Blank lines in the file, and lines starting with a # character (ignoring
4675 leading white space) are treated as comments and are ignored. &*Note*&: A
4676 # character other than at the beginning of a line is not treated specially,
4677 and does not introduce a comment.
4678
4679 Any non-comment line can be continued by ending it with a backslash. Note that
4680 the general rule for white space means that trailing white space after the
4681 backslash and leading white space at the start of continuation
4682 lines is ignored. Comment lines beginning with # (but not empty lines) may
4683 appear in the middle of a sequence of continuation lines.
4684
4685 A convenient way to create a configuration file is to start from the
4686 default, which is supplied in &_src/configure.default_&, and add, delete, or
4687 change settings as required.
4688
4689 The ACLs, retry rules, and rewriting rules have their own syntax which is
4690 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4691 respectively. The other parts of the configuration file have some syntactic
4692 items in common, and these are described below, from section &<<SECTcos>>&
4693 onwards. Before that, the inclusion, macro, and conditional facilities are
4694 described.
4695
4696
4697
4698 .section "File inclusions in the configuration file" "SECID41"
4699 .cindex "inclusions in configuration file"
4700 .cindex "configuration file" "including other files"
4701 .cindex "&`.include`& in configuration file"
4702 .cindex "&`.include_if_exists`& in configuration file"
4703 You can include other files inside Exim's run time configuration file by
4704 using this syntax:
4705 .display
4706 &`.include`& <&'file name'&>
4707 &`.include_if_exists`& <&'file name'&>
4708 .endd
4709 on a line by itself. Double quotes round the file name are optional. If you use
4710 the first form, a configuration error occurs if the file does not exist; the
4711 second form does nothing for non-existent files. In all cases, an absolute file
4712 name is required.
4713
4714 Includes may be nested to any depth, but remember that Exim reads its
4715 configuration file often, so it is a good idea to keep them to a minimum.
4716 If you change the contents of an included file, you must HUP the daemon,
4717 because an included file is read only when the configuration itself is read.
4718
4719 The processing of inclusions happens early, at a physical line level, so, like
4720 comment lines, an inclusion can be used in the middle of an option setting,
4721 for example:
4722 .code
4723 hosts_lookup = a.b.c \
4724                .include /some/file
4725 .endd
4726 Include processing happens after macro processing (see below). Its effect is to
4727 process the lines of the included file as if they occurred inline where the
4728 inclusion appears.
4729
4730
4731
4732 .section "Macros in the configuration file" "SECTmacrodefs"
4733 .cindex "macro" "description of"
4734 .cindex "configuration file" "macros"
4735 If a line in the main part of the configuration (that is, before the first
4736 &"begin"& line) begins with an upper case letter, it is taken as a macro
4737 definition, and must be of the form
4738 .display
4739 <&'name'&> = <&'rest of line'&>
4740 .endd
4741 The name must consist of letters, digits, and underscores, and need not all be
4742 in upper case, though that is recommended. The rest of the line, including any
4743 continuations, is the replacement text, and has leading and trailing white
4744 space removed. Quotes are not removed. The replacement text can never end with
4745 a backslash character, but this doesn't seem to be a serious limitation.
4746
4747 Macros may also be defined between router, transport, authenticator, or ACL
4748 definitions. They may not, however, be defined within an individual driver or
4749 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4750
4751 .section "Macro substitution" "SECID42"
4752 Once a macro is defined, all subsequent lines in the file (and any included
4753 files) are scanned for the macro name; if there are several macros, the line is
4754 scanned for each in turn, in the order in which the macros are defined. The
4755 replacement text is not re-scanned for the current macro, though it is scanned
4756 for subsequently defined macros. For this reason, a macro name may not contain
4757 the name of a previously defined macro as a substring. You could, for example,
4758 define
4759 .display
4760 &`ABCD_XYZ = `&<&'something'&>
4761 &`ABCD = `&<&'something else'&>
4762 .endd
4763 but putting the definitions in the opposite order would provoke a configuration
4764 error. Macro expansion is applied to individual physical lines from the file,
4765 before checking for line continuation or file inclusion (see above). If a line
4766 consists solely of a macro name, and the expansion of the macro is empty, the
4767 line is ignored. A macro at the start of a line may turn the line into a
4768 comment line or a &`.include`& line.
4769
4770
4771 .section "Redefining macros" "SECID43"
4772 Once defined, the value of a macro can be redefined later in the configuration
4773 (or in an included file). Redefinition is specified by using &'=='& instead of
4774 &'='&. For example:
4775 .code
4776 MAC =  initial value
4777 ...
4778 MAC == updated value
4779 .endd
4780 Redefinition does not alter the order in which the macros are applied to the
4781 subsequent lines of the configuration file. It is still the same order in which
4782 the macros were originally defined. All that changes is the macro's value.
4783 Redefinition makes it possible to accumulate values. For example:
4784 .code
4785 MAC =  initial value
4786 ...
4787 MAC == MAC and something added
4788 .endd
4789 This can be helpful in situations where the configuration file is built
4790 from a number of other files.
4791
4792 .section "Overriding macro values" "SECID44"
4793 The values set for macros in the configuration file can be overridden by the
4794 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4795 used, unless called by root or the Exim user. A definition on the command line
4796 using the &%-D%& option causes all definitions and redefinitions within the
4797 file to be ignored.
4798
4799
4800
4801 .section "Example of macro usage" "SECID45"
4802 As an example of macro usage, consider a configuration where aliases are looked
4803 up in a MySQL database. It helps to keep the file less cluttered if long
4804 strings such as SQL statements are defined separately as macros, for example:
4805 .code
4806 ALIAS_QUERY = select mailbox from user where \
4807               login='${quote_mysql:$local_part}';
4808 .endd
4809 This can then be used in a &(redirect)& router setting like this:
4810 .code
4811 data = ${lookup mysql{ALIAS_QUERY}}
4812 .endd
4813 In earlier versions of Exim macros were sometimes used for domain, host, or
4814 address lists. In Exim 4 these are handled better by named lists &-- see
4815 section &<<SECTnamedlists>>&.
4816
4817
4818 .section "Conditional skips in the configuration file" "SECID46"
4819 .cindex "configuration file" "conditional skips"
4820 .cindex "&`.ifdef`&"
4821 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4822 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4823 portions of the configuration file. The processing happens whenever the file is
4824 read (that is, when an Exim binary starts to run).
4825
4826 The implementation is very simple. Instances of the first four directives must
4827 be followed by text that includes the names of one or macros. The condition
4828 that is tested is whether or not any macro substitution has taken place in the
4829 line. Thus:
4830 .code
4831 .ifdef AAA
4832 message_size_limit = 50M
4833 .else
4834 message_size_limit = 100M
4835 .endif
4836 .endd
4837 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4838 otherwise. If there is more than one macro named on the line, the condition
4839 is true if any of them are defined. That is, it is an &"or"& condition. To
4840 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4841
4842 Although you can use a macro expansion to generate one of these directives,
4843 it is not very useful, because the condition &"there was a macro substitution
4844 in this line"& will always be true.
4845
4846 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4847 to clarify complicated nestings.
4848
4849
4850
4851 .section "Common option syntax" "SECTcos"
4852 .cindex "common option syntax"
4853 .cindex "syntax of common options"
4854 .cindex "configuration file" "common option syntax"
4855 For the main set of options, driver options, and &[local_scan()]& options,
4856 each setting is on a line by itself, and starts with a name consisting of
4857 lower-case letters and underscores. Many options require a data value, and in
4858 these cases the name must be followed by an equals sign (with optional white
4859 space) and then the value. For example:
4860 .code
4861 qualify_domain = mydomain.example.com
4862 .endd
4863 .cindex "hiding configuration option values"
4864 .cindex "configuration options" "hiding value of"
4865 .cindex "options" "hiding value of"
4866 Some option settings may contain sensitive data, for example, passwords for
4867 accessing databases. To stop non-admin users from using the &%-bP%& command
4868 line option to read these values, you can precede the option settings with the
4869 word &"hide"&. For example:
4870 .code
4871 hide mysql_servers = localhost/users/admin/secret-password
4872 .endd
4873 For non-admin users, such options are displayed like this:
4874 .code
4875 mysql_servers = <value not displayable>
4876 .endd
4877 If &"hide"& is used on a driver option, it hides the value of that option on
4878 all instances of the same driver.
4879
4880 The following sections describe the syntax used for the different data types
4881 that are found in option settings.
4882
4883
4884 .section "Boolean options" "SECID47"
4885 .cindex "format" "boolean"
4886 .cindex "boolean configuration values"
4887 .oindex "&%no_%&&'xxx'&"
4888 .oindex "&%not_%&&'xxx'&"
4889 Options whose type is given as boolean are on/off switches. There are two
4890 different ways of specifying such options: with and without a data value. If
4891 the option name is specified on its own without data, the switch is turned on;
4892 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
4893 boolean options may be followed by an equals sign and one of the words
4894 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
4895 the following two settings have exactly the same effect:
4896 .code
4897 queue_only
4898 queue_only = true
4899 .endd
4900 The following two lines also have the same (opposite) effect:
4901 .code
4902 no_queue_only
4903 queue_only = false
4904 .endd
4905 You can use whichever syntax you prefer.
4906
4907
4908
4909
4910 .section "Integer values" "SECID48"
4911 .cindex "integer configuration values"
4912 .cindex "format" "integer"
4913 If an option's type is given as &"integer"&, the value can be given in decimal,
4914 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
4915 number is assumed. Otherwise, it is treated as an octal number unless it starts
4916 with the characters &"0x"&, in which case the remainder is interpreted as a
4917 hexadecimal number.
4918
4919 If an integer value is followed by the letter K, it is multiplied by 1024; if
4920 it is followed by the letter M, it is multiplied by 1024x1024. When the values
4921 of integer option settings are output, values which are an exact multiple of
4922 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
4923 and M. The printing style is independent of the actual input format that was
4924 used.
4925
4926
4927 .section "Octal integer values" "SECID49"
4928 .cindex "integer format"
4929 .cindex "format" "octal integer"
4930 If an option's type is given as &"octal integer"&, its value is always
4931 interpreted as an octal number, whether or not it starts with the digit zero.
4932 Such options are always output in octal.
4933
4934
4935 .section "Fixed point numbers" "SECID50"
4936 .cindex "fixed point configuration values"
4937 .cindex "format" "fixed point"
4938 If an option's type is given as &"fixed-point"&, its value must be a decimal
4939 integer, optionally followed by a decimal point and up to three further digits.
4940
4941
4942
4943 .section "Time intervals" "SECTtimeformat"
4944 .cindex "time interval" "specifying in configuration"
4945 .cindex "format" "time interval"
4946 A time interval is specified as a sequence of numbers, each followed by one of
4947 the following letters, with no intervening white space:
4948
4949 .table2 30pt
4950 .irow &%s%& seconds
4951 .irow &%m%& minutes
4952 .irow &%h%& hours
4953 .irow &%d%& days
4954 .irow &%w%& weeks
4955 .endtable
4956
4957 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
4958 intervals are output in the same format. Exim does not restrict the values; it
4959 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
4960
4961
4962
4963 .section "String values" "SECTstrings"
4964 .cindex "string" "format of configuration values"
4965 .cindex "format" "string"
4966 If an option's type is specified as &"string"&, the value can be specified with
4967 or without double-quotes. If it does not start with a double-quote, the value
4968 consists of the remainder of the line plus any continuation lines, starting at
4969 the first character after any leading white space, with trailing white space
4970 removed, and with no interpretation of the characters in the string. Because
4971 Exim removes comment lines (those beginning with #) at an early stage, they can
4972 appear in the middle of a multi-line string. The following two settings are
4973 therefore equivalent:
4974 .code
4975 trusted_users = uucp:mail
4976 trusted_users = uucp:\
4977                 # This comment line is ignored
4978                 mail
4979 .endd
4980 .cindex "string" "quoted"
4981 .cindex "escape characters in quoted strings"
4982 If a string does start with a double-quote, it must end with a closing
4983 double-quote, and any backslash characters other than those used for line
4984 continuation are interpreted as escape characters, as follows:
4985
4986 .table2 100pt
4987 .irow &`\\`&                     "single backslash"
4988 .irow &`\n`&                     "newline"
4989 .irow &`\r`&                     "carriage return"
4990 .irow &`\t`&                     "tab"
4991 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
4992 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
4993                                    character"
4994 .endtable
4995
4996 If a backslash is followed by some other character, including a double-quote
4997 character, that character replaces the pair.
4998
4999 Quoting is necessary only if you want to make use of the backslash escapes to
5000 insert special characters, or if you need to specify a value with leading or
5001 trailing spaces. These cases are rare, so quoting is almost never needed in
5002 current versions of Exim. In versions of Exim before 3.14, quoting was required
5003 in order to continue lines, so you may come across older configuration files
5004 and examples that apparently quote unnecessarily.
5005
5006
5007 .section "Expanded strings" "SECID51"
5008 .cindex "expansion" "definition of"
5009 Some strings in the configuration file are subjected to &'string expansion'&,
5010 by which means various parts of the string may be changed according to the
5011 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5012 is as just described; in particular, the handling of backslashes in quoted
5013 strings is done as part of the input process, before expansion takes place.
5014 However, backslash is also an escape character for the expander, so any
5015 backslashes that are required for that reason must be doubled if they are
5016 within a quoted configuration string.
5017
5018
5019 .section "User and group names" "SECID52"
5020 .cindex "user name" "format of"
5021 .cindex "format" "user name"
5022 .cindex "groups" "name format"
5023 .cindex "format" "group name"
5024 User and group names are specified as strings, using the syntax described
5025 above, but the strings are interpreted specially. A user or group name must
5026 either consist entirely of digits, or be a name that can be looked up using the
5027 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5028
5029
5030 .section "List construction" "SECTlistconstruct"
5031 .cindex "list" "syntax of in configuration"
5032 .cindex "format" "list item in configuration"
5033 .cindex "string" "list, definition of"
5034 The data for some configuration options is a list of items, with colon as the
5035 default separator. Many of these options are shown with type &"string list"& in
5036 the descriptions later in this document. Others are listed as &"domain list"&,
5037 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5038 are all the same; however, those other than &"string list"& are subject to
5039 particular kinds of interpretation, as described in chapter
5040 &<<CHAPdomhosaddlists>>&.
5041
5042 In all these cases, the entire list is treated as a single string as far as the
5043 input syntax is concerned. The &%trusted_users%& setting in section
5044 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5045 in a list, it must be entered as two colons. Leading and trailing white space
5046 on each item in a list is ignored. This makes it possible to include items that
5047 start with a colon, and in particular, certain forms of IPv6 address. For
5048 example, the list
5049 .code
5050 local_interfaces = 127.0.0.1 : ::::1
5051 .endd
5052 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5053
5054 &*Note*&: Although leading and trailing white space is ignored in individual
5055 list items, it is not ignored when parsing the list. The space after the first
5056 colon in the example above is necessary. If it were not there, the list would
5057 be interpreted as the two items 127.0.0.1:: and 1.
5058
5059 .section "Changing list separators" "SECID53"
5060 .cindex "list separator" "changing"
5061 .cindex "IPv6" "addresses in lists"
5062 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5063 introduced to allow the separator character to be changed. If a list begins
5064 with a left angle bracket, followed by any punctuation character, that
5065 character is used instead of colon as the list separator. For example, the list
5066 above can be rewritten to use a semicolon separator like this:
5067 .code
5068 local_interfaces = <; 127.0.0.1 ; ::1
5069 .endd
5070 This facility applies to all lists, with the exception of the list in
5071 &%log_file_path%&. It is recommended that the use of non-colon separators be
5072 confined to circumstances where they really are needed.
5073
5074 .cindex "list separator" "newline as"
5075 .cindex "newline" "as list separator"
5076 It is also possible to use newline and other control characters (those with
5077 code values less than 32, plus DEL) as separators in lists. Such separators
5078 must be provided literally at the time the list is processed. For options that
5079 are string-expanded, you can write the separator using a normal escape
5080 sequence. This will be processed by the expander before the string is
5081 interpreted as a list. For example, if a newline-separated list of domains is
5082 generated by a lookup, you can process it directly by a line such as this:
5083 .code
5084 domains = <\n ${lookup mysql{.....}}
5085 .endd
5086 This avoids having to change the list separator in such data. You are unlikely
5087 to want to use a control character as a separator in an option that is not
5088 expanded, because the value is literal text. However, it can be done by giving
5089 the value in quotes. For example:
5090 .code
5091 local_interfaces = "<\n 127.0.0.1 \n ::1"
5092 .endd
5093 Unlike printing character separators, which can be included in list items by
5094 doubling, it is not possible to include a control character as data when it is
5095 set as the separator. Two such characters in succession are interpreted as
5096 enclosing an empty list item.
5097
5098
5099
5100 .section "Empty items in lists" "SECTempitelis"
5101 .cindex "list" "empty item in"
5102 An empty item at the end of a list is always ignored. In other words, trailing
5103 separator characters are ignored. Thus, the list in
5104 .code
5105 senders = user@domain :
5106 .endd
5107 contains only a single item. If you want to include an empty string as one item
5108 in a list, it must not be the last item. For example, this list contains three
5109 items, the second of which is empty:
5110 .code
5111 senders = user1@domain : : user2@domain
5112 .endd
5113 &*Note*&: There must be white space between the two colons, as otherwise they
5114 are interpreted as representing a single colon data character (and the list
5115 would then contain just one item). If you want to specify a list that contains
5116 just one, empty item, you can do it as in this example:
5117 .code
5118 senders = :
5119 .endd
5120 In this case, the first item is empty, and the second is discarded because it
5121 is at the end of the list.
5122
5123
5124
5125
5126 .section "Format of driver configurations" "SECTfordricon"
5127 .cindex "drivers" "configuration format"
5128 There are separate parts in the configuration for defining routers, transports,
5129 and authenticators. In each part, you are defining a number of driver
5130 instances, each with its own set of options. Each driver instance is defined by
5131 a sequence of lines like this:
5132 .display
5133 <&'instance name'&>:
5134   <&'option'&>
5135   ...
5136   <&'option'&>
5137 .endd
5138 In the following example, the instance name is &(localuser)&, and it is
5139 followed by three options settings:
5140 .code
5141 localuser:
5142   driver = accept
5143   check_local_user
5144   transport = local_delivery
5145 .endd
5146 For each driver instance, you specify which Exim code module it uses &-- by the
5147 setting of the &%driver%& option &-- and (optionally) some configuration
5148 settings. For example, in the case of transports, if you want a transport to
5149 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5150 a local file you would use the &(appendfile)& driver. Each of the drivers is
5151 described in detail in its own separate chapter later in this manual.
5152
5153 You can have several routers, transports, or authenticators that are based on
5154 the same underlying driver (each must have a different instance name).
5155
5156 The order in which routers are defined is important, because addresses are
5157 passed to individual routers one by one, in order. The order in which
5158 transports are defined does not matter at all. The order in which
5159 authenticators are defined is used only when Exim, as a client, is searching
5160 them to find one that matches an authentication mechanism offered by the
5161 server.
5162
5163 .cindex "generic options"
5164 .cindex "options" "generic &-- definition of"
5165 Within a driver instance definition, there are two kinds of option: &'generic'&
5166 and &'private'&. The generic options are those that apply to all drivers of the
5167 same type (that is, all routers, all transports or all authenticators). The
5168 &%driver%& option is a generic option that must appear in every definition.
5169 .cindex "private options"
5170 The private options are special for each driver, and none need appear, because
5171 they all have default values.
5172
5173 The options may appear in any order, except that the &%driver%& option must
5174 precede any private options, since these depend on the particular driver. For
5175 this reason, it is recommended that &%driver%& always be the first option.
5176
5177 Driver instance names, which are used for reference in log entries and
5178 elsewhere, can be any sequence of letters, digits, and underscores (starting
5179 with a letter) and must be unique among drivers of the same type. A router and
5180 a transport (for example) can each have the same name, but no two router
5181 instances can have the same name. The name of a driver instance should not be
5182 confused with the name of the underlying driver module. For example, the
5183 configuration lines:
5184 .code
5185 remote_smtp:
5186   driver = smtp
5187 .endd
5188 create an instance of the &(smtp)& transport driver whose name is
5189 &(remote_smtp)&. The same driver code can be used more than once, with
5190 different instance names and different option settings each time. A second
5191 instance of the &(smtp)& transport, with different options, might be defined
5192 thus:
5193 .code
5194 special_smtp:
5195   driver = smtp
5196   port = 1234
5197   command_timeout = 10s
5198 .endd
5199 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5200 these transport instances from routers, and these names would appear in log
5201 lines.
5202
5203 Comment lines may be present in the middle of driver specifications. The full
5204 list of option settings for any particular driver instance, including all the
5205 defaulted values, can be extracted by making use of the &%-bP%& command line
5206 option.
5207
5208
5209
5210
5211
5212
5213 . ////////////////////////////////////////////////////////////////////////////
5214 . ////////////////////////////////////////////////////////////////////////////
5215
5216 .chapter "The default configuration file" "CHAPdefconfil"
5217 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5218 .cindex "default" "configuration file &""walk through""&"
5219 The default configuration file supplied with Exim as &_src/configure.default_&
5220 is sufficient for a host with simple mail requirements. As an introduction to
5221 the way Exim is configured, this chapter &"walks through"& the default
5222 configuration, giving brief explanations of the settings. Detailed descriptions
5223 of the options are given in subsequent chapters. The default configuration file
5224 itself contains extensive comments about ways you might want to modify the
5225 initial settings. However, note that there are many options that are not
5226 mentioned at all in the default configuration.
5227
5228
5229
5230 .section "Main configuration settings" "SECTdefconfmain"
5231 The main (global) configuration option settings must always come first in the
5232 file. The first thing you'll see in the file, after some initial comments, is
5233 the line
5234 .code
5235 # primary_hostname =
5236 .endd
5237 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5238 to know the official, fully qualified name of your host, and this is where you
5239 can specify it. However, in most cases you do not need to set this option. When
5240 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5241
5242 The first three non-comment configuration lines are as follows:
5243 .code
5244 domainlist local_domains = @
5245 domainlist relay_to_domains =
5246 hostlist   relay_from_hosts = 127.0.0.1
5247 .endd
5248 These are not, in fact, option settings. They are definitions of two named
5249 domain lists and one named host list. Exim allows you to give names to lists of
5250 domains, hosts, and email addresses, in order to make it easier to manage the
5251 configuration file (see section &<<SECTnamedlists>>&).
5252
5253 The first line defines a domain list called &'local_domains'&; this is used
5254 later in the configuration to identify domains that are to be delivered
5255 on the local host.
5256
5257 .cindex "@ in a domain list"
5258 There is just one item in this list, the string &"@"&. This is a special form
5259 of entry which means &"the name of the local host"&. Thus, if the local host is
5260 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5261 be delivered locally. Because the local host's name is referenced indirectly,
5262 the same configuration file can be used on different hosts.
5263
5264 The second line defines a domain list called &'relay_to_domains'&, but the
5265 list itself is empty. Later in the configuration we will come to the part that
5266 controls mail relaying through the local host; it allows relaying to any
5267 domains in this list. By default, therefore, no relaying on the basis of a mail
5268 domain is permitted.
5269
5270 The third line defines a host list called &'relay_from_hosts'&. This list is
5271 used later in the configuration to permit relaying from any host or IP address
5272 that matches the list. The default contains just the IP address of the IPv4
5273 loopback interface, which means that processes on the local host are able to
5274 submit mail for relaying by sending it over TCP/IP to that interface. No other
5275 hosts are permitted to submit messages for relaying.
5276
5277 Just to be sure there's no misunderstanding: at this point in the configuration
5278 we aren't actually setting up any controls. We are just defining some domains
5279 and hosts that will be used in the controls that are specified later.
5280
5281 The next two configuration lines are genuine option settings:
5282 .code
5283 acl_smtp_rcpt = acl_check_rcpt
5284 acl_smtp_data = acl_check_data
5285 .endd
5286 These options specify &'Access Control Lists'& (ACLs) that are to be used
5287 during an incoming SMTP session for every recipient of a message (every RCPT
5288 command), and after the contents of the message have been received,
5289 respectively. The names of the lists are &'acl_check_rcpt'& and
5290 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5291 section of the configuration. The RCPT ACL controls which recipients are
5292 accepted for an incoming message &-- if a configuration does not provide an ACL
5293 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5294 contents of a message to be checked.
5295
5296 Two commented-out option settings are next:
5297 .code
5298 # av_scanner = clamd:/tmp/clamd
5299 # spamd_address = 127.0.0.1 783
5300 .endd
5301 These are example settings that can be used when Exim is compiled with the
5302 content-scanning extension. The first specifies the interface to the virus
5303 scanner, and the second specifies the interface to SpamAssassin. Further
5304 details are given in chapter &<<CHAPexiscan>>&.
5305
5306 Three more commented-out option settings follow:
5307 .code
5308 # tls_advertise_hosts = *
5309 # tls_certificate = /etc/ssl/exim.crt
5310 # tls_privatekey = /etc/ssl/exim.pem
5311 .endd
5312 These are example settings that can be used when Exim is compiled with
5313 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5314 first one specifies the list of clients that are allowed to use TLS when
5315 connecting to this server; in this case the wildcard means all clients. The
5316 other options specify where Exim should find its TLS certificate and private
5317 key, which together prove the server's identity to any clients that connect.
5318 More details are given in chapter &<<CHAPTLS>>&.
5319
5320 Another two commented-out option settings follow:
5321 .code
5322 # daemon_smtp_ports = 25 : 465 : 587
5323 # tls_on_connect_ports = 465
5324 .endd
5325 .cindex "port" "465 and 587"
5326 .cindex "port" "for message submission"
5327 .cindex "message" "submission, ports for"
5328 .cindex "ssmtp protocol"
5329 .cindex "smtps protocol"
5330 .cindex "SMTP" "ssmtp protocol"
5331 .cindex "SMTP" "smtps protocol"
5332 These options provide better support for roaming users who wish to use this
5333 server for message submission. They are not much use unless you have turned on
5334 TLS (as described in the previous paragraph) and authentication (about which
5335 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5336 on end-user networks, so RFC 4409 specifies that message submission should use
5337 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5338 configured to use port 587 correctly, so these settings also enable the
5339 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5340 &<<SECTsupobssmt>>&).
5341
5342 Two more commented-out options settings follow:
5343 .code
5344 # qualify_domain =
5345 # qualify_recipient =
5346 .endd
5347 The first of these specifies a domain that Exim uses when it constructs a
5348 complete email address from a local login name. This is often needed when Exim
5349 receives a message from a local process. If you do not set &%qualify_domain%&,
5350 the value of &%primary_hostname%& is used. If you set both of these options,
5351 you can have different qualification domains for sender and recipient
5352 addresses. If you set only the first one, its value is used in both cases.
5353
5354 .cindex "domain literal" "recognizing format"
5355 The following line must be uncommented if you want Exim to recognize
5356 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5357 (an IP address within square brackets) instead of a named domain.
5358 .code
5359 # allow_domain_literals
5360 .endd
5361 The RFCs still require this form, but many people think that in the modern
5362 Internet it makes little sense to permit mail to be sent to specific hosts by
5363 quoting their IP addresses. This ancient format has been used by people who
5364 try to abuse hosts by using them for unwanted relaying. However, some
5365 people believe there are circumstances (for example, messages addressed to
5366 &'postmaster'&) where domain literals are still useful.
5367
5368 The next configuration line is a kind of trigger guard:
5369 .code
5370 never_users = root
5371 .endd
5372 It specifies that no delivery must ever be run as the root user. The normal
5373 convention is to set up &'root'& as an alias for the system administrator. This
5374 setting is a guard against slips in the configuration.
5375 The list of users specified by &%never_users%& is not, however, the complete
5376 list; the build-time configuration in &_Local/Makefile_& has an option called
5377 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5378 contents of &%never_users%& are added to this list. By default
5379 FIXED_NEVER_USERS also specifies root.
5380
5381 When a remote host connects to Exim in order to send mail, the only information
5382 Exim has about the host's identity is its IP address. The next configuration
5383 line,
5384 .code
5385 host_lookup = *
5386 .endd
5387 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5388 in order to get a host name. This improves the quality of the logging
5389 information, but if you feel it is too expensive, you can remove it entirely,
5390 or restrict the lookup to hosts on &"nearby"& networks.
5391 Note that it is not always possible to find a host name from an IP address,
5392 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5393 unreachable.
5394
5395 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5396 1413 (hence their names):
5397 .code
5398 rfc1413_hosts = *
5399 rfc1413_query_timeout = 5s
5400 .endd
5401 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5402 You can limit the hosts to which these calls are made, or change the timeout
5403 that is used. If you set the timeout to zero, all ident calls are disabled.
5404 Although they are cheap and can provide useful information for tracing problem
5405 messages, some hosts and firewalls have problems with ident calls. This can
5406 result in a timeout instead of an immediate refused connection, leading to
5407 delays on starting up an incoming SMTP session.
5408
5409 When Exim receives messages over SMTP connections, it expects all addresses to
5410 be fully qualified with a domain, as required by the SMTP definition. However,
5411 if you are running a server to which simple clients submit messages, you may
5412 find that they send unqualified addresses. The two commented-out options:
5413 .code
5414 # sender_unqualified_hosts =
5415 # recipient_unqualified_hosts =
5416 .endd
5417 show how you can specify hosts that are permitted to send unqualified sender
5418 and recipient addresses, respectively.
5419
5420 The &%percent_hack_domains%& option is also commented out:
5421 .code
5422 # percent_hack_domains =
5423 .endd
5424 It provides a list of domains for which the &"percent hack"& is to operate.
5425 This is an almost obsolete form of explicit email routing. If you do not know
5426 anything about it, you can safely ignore this topic.
5427
5428 The last two settings in the main part of the default configuration are
5429 concerned with messages that have been &"frozen"& on Exim's queue. When a
5430 message is frozen, Exim no longer continues to try to deliver it. Freezing
5431 occurs when a bounce message encounters a permanent failure because the sender
5432 address of the original message that caused the bounce is invalid, so the
5433 bounce cannot be delivered. This is probably the most common case, but there
5434 are also other conditions that cause freezing, and frozen messages are not
5435 always bounce messages.
5436 .code
5437 ignore_bounce_errors_after = 2d
5438 timeout_frozen_after = 7d
5439 .endd
5440 The first of these options specifies that failing bounce messages are to be
5441 discarded after 2 days on the queue. The second specifies that any frozen
5442 message (whether a bounce message or not) is to be timed out (and discarded)
5443 after a week. In this configuration, the first setting ensures that no failing
5444 bounce message ever lasts a week.
5445
5446
5447
5448 .section "ACL configuration" "SECID54"
5449 .cindex "default" "ACLs"
5450 .cindex "&ACL;" "default configuration"
5451 In the default configuration, the ACL section follows the main configuration.
5452 It starts with the line
5453 .code
5454 begin acl
5455 .endd
5456 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5457 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5458 and &%acl_smtp_data%& above.
5459
5460 .cindex "RCPT" "ACL for"
5461 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5462 RCPT command specifies one of the message's recipients. The ACL statements
5463 are considered in order, until the recipient address is either accepted or
5464 rejected. The RCPT command is then accepted or rejected, according to the
5465 result of the ACL processing.
5466 .code
5467 acl_check_rcpt:
5468 .endd
5469 This line, consisting of a name terminated by a colon, marks the start of the
5470 ACL, and names it.
5471 .code
5472 accept  hosts = :
5473 .endd
5474 This ACL statement accepts the recipient if the sending host matches the list.
5475 But what does that strange list mean? It doesn't actually contain any host
5476 names or IP addresses. The presence of the colon puts an empty item in the
5477 list; Exim matches this only if the incoming message did not come from a remote
5478 host, because in that case, the remote hostname is empty. The colon is
5479 important. Without it, the list itself is empty, and can never match anything.
5480
5481 What this statement is doing is to accept unconditionally all recipients in
5482 messages that are submitted by SMTP from local processes using the standard
5483 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5484 manner.
5485 .code
5486 deny    message       = Restricted characters in address
5487         domains       = +local_domains
5488         local_parts   = ^[.] : ^.*[@%!/|]
5489
5490 deny    message       = Restricted characters in address
5491         domains       = !+local_domains
5492         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5493 .endd
5494 These statements are concerned with local parts that contain any of the
5495 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5496 Although these characters are entirely legal in local parts (in the case of
5497 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5498 in Internet mail addresses.
5499
5500 The first three have in the past been associated with explicitly routed
5501 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5502 option). Addresses containing these characters are regularly tried by spammers
5503 in an attempt to bypass relaying restrictions, and also by open relay testing
5504 programs. Unless you really need them it is safest to reject these characters
5505 at this early stage. This configuration is heavy-handed in rejecting these
5506 characters for all messages it accepts from remote hosts. This is a deliberate
5507 policy of being as safe as possible.
5508
5509 The first rule above is stricter, and is applied to messages that are addressed
5510 to one of the local domains handled by this host. This is implemented by the
5511 first condition, which restricts it to domains that are listed in the
5512 &'local_domains'& domain list. The &"+"& character is used to indicate a
5513 reference to a named list. In this configuration, there is just one domain in
5514 &'local_domains'&, but in general there may be many.
5515
5516 The second condition on the first statement uses two regular expressions to
5517 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5518 or &"|"&. If you have local accounts that include these characters, you will
5519 have to modify this rule.
5520
5521 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5522 allows them because they have been encountered in practice. (Consider the
5523 common convention of local parts constructed as
5524 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5525 the author of Exim, who has no second initial.) However, a local part starting
5526 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5527 file name (for example, for a mailing list). This is also true for local parts
5528 that contain slashes. A pipe symbol can also be troublesome if the local part
5529 is incorporated unthinkingly into a shell command line.
5530
5531 The second rule above applies to all other domains, and is less strict. This
5532 allows your own users to send outgoing messages to sites that use slashes
5533 and vertical bars in their local parts. It blocks local parts that begin
5534 with a dot, slash, or vertical bar, but allows these characters within the
5535 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5536 and &"!"& is blocked, as before. The motivation here is to prevent your users
5537 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5538 .code
5539 accept  local_parts   = postmaster
5540         domains       = +local_domains
5541 .endd
5542 This statement, which has two conditions, accepts an incoming address if the
5543 local part is &'postmaster'& and the domain is one of those listed in the
5544 &'local_domains'& domain list. The &"+"& character is used to indicate a
5545 reference to a named list. In this configuration, there is just one domain in
5546 &'local_domains'&, but in general there may be many.
5547
5548 The presence of this statement means that mail to postmaster is never blocked
5549 by any of the subsequent tests. This can be helpful while sorting out problems
5550 in cases where the subsequent tests are incorrectly denying access.
5551 .code
5552 require verify        = sender
5553 .endd
5554 This statement requires the sender address to be verified before any subsequent
5555 ACL statement can be used. If verification fails, the incoming recipient
5556 address is refused. Verification consists of trying to route the address, to
5557 see if a bounce message could be delivered to it. In the case of remote
5558 addresses, basic verification checks only the domain, but &'callouts'& can be
5559 used for more verification if required. Section &<<SECTaddressverification>>&
5560 discusses the details of address verification.
5561 .code
5562 accept  hosts         = +relay_from_hosts
5563         control       = submission
5564 .endd
5565 This statement accepts the address if the message is coming from one of the
5566 hosts that are defined as being allowed to relay through this host. Recipient
5567 verification is omitted here, because in many cases the clients are dumb MUAs
5568 that do not cope well with SMTP error responses. For the same reason, the
5569 second line specifies &"submission mode"& for messages that are accepted. This
5570 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5571 messages that are deficient in some way, for example, because they lack a
5572 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5573 probably add recipient verification here, and disable submission mode.
5574 .code
5575 accept  authenticated = *
5576         control       = submission
5577 .endd
5578 This statement accepts the address if the client host has authenticated itself.
5579 Submission mode is again specified, on the grounds that such messages are most
5580 likely to come from MUAs. The default configuration does not define any
5581 authenticators, though it does include some nearly complete commented-out
5582 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5583 fact authenticate until you complete the authenticator definitions.
5584 .code
5585 require message = relay not permitted
5586         domains = +local_domains : +relay_domains
5587 .endd
5588 This statement rejects the address if its domain is neither a local domain nor
5589 one of the domains for which this host is a relay.
5590 .code
5591 require verify = recipient
5592 .endd
5593 This statement requires the recipient address to be verified; if verification
5594 fails, the address is rejected.
5595 .code
5596 # deny    message     = rejected because $sender_host_address \
5597 #                       is in a black list at $dnslist_domain\n\
5598 #                       $dnslist_text
5599 #         dnslists    = black.list.example
5600 #
5601 # warn    dnslists    = black.list.example
5602 #         add_header  = X-Warning: $sender_host_address is in \
5603 #                       a black list at $dnslist_domain
5604 #         log_message = found in $dnslist_domain
5605 .endd
5606 These commented-out lines are examples of how you could configure Exim to check
5607 sending hosts against a DNS black list. The first statement rejects messages
5608 from blacklisted hosts, whereas the second just inserts a warning header
5609 line.
5610 .code
5611 # require verify = csa
5612 .endd
5613 This commented-out line is an example of how you could turn on client SMTP
5614 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5615 records.
5616 .code
5617 accept
5618 .endd
5619 The final statement in the first ACL unconditionally accepts any recipient
5620 address that has successfully passed all the previous tests.
5621 .code
5622 acl_check_data:
5623 .endd
5624 This line marks the start of the second ACL, and names it. Most of the contents
5625 of this ACL are commented out:
5626 .code
5627 # deny    malware   = *
5628 #         message   = This message contains a virus \
5629 #                     ($malware_name).
5630 .endd
5631 These lines are examples of how to arrange for messages to be scanned for
5632 viruses when Exim has been compiled with the content-scanning extension, and a
5633 suitable virus scanner is installed. If the message is found to contain a
5634 virus, it is rejected with the given custom error message.
5635 .code
5636 # warn    spam      = nobody
5637 #         message   = X-Spam_score: $spam_score\n\
5638 #                     X-Spam_score_int: $spam_score_int\n\
5639 #                     X-Spam_bar: $spam_bar\n\
5640 #                     X-Spam_report: $spam_report
5641 .endd
5642 These lines are an example of how to arrange for messages to be scanned by
5643 SpamAssassin when Exim has been compiled with the content-scanning extension,
5644 and SpamAssassin has been installed. The SpamAssassin check is run with
5645 &`nobody`& as its user parameter, and the results are added to the message as a
5646 series of extra header line. In this case, the message is not rejected,
5647 whatever the spam score.
5648 .code
5649 accept
5650 .endd
5651 This final line in the DATA ACL accepts the message unconditionally.
5652
5653
5654 .section "Router configuration" "SECID55"
5655 .cindex "default" "routers"
5656 .cindex "routers" "default"
5657 The router configuration comes next in the default configuration, introduced
5658 by the line
5659 .code
5660 begin routers
5661 .endd
5662 Routers are the modules in Exim that make decisions about where to send
5663 messages. An address is passed to each router in turn, until it is either
5664 accepted, or failed. This means that the order in which you define the routers
5665 matters. Each router is fully described in its own chapter later in this
5666 manual. Here we give only brief overviews.
5667 .code
5668 # domain_literal:
5669 #   driver = ipliteral
5670 #   domains = !+local_domains
5671 #   transport = remote_smtp
5672 .endd
5673 .cindex "domain literal" "default router"
5674 This router is commented out because the majority of sites do not want to
5675 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5676 you uncomment this router, you also need to uncomment the setting of
5677 &%allow_domain_literals%& in the main part of the configuration.
5678 .code
5679 dnslookup:
5680   driver = dnslookup
5681   domains = ! +local_domains
5682   transport = remote_smtp
5683   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5684   no_more
5685 .endd
5686 The first uncommented router handles addresses that do not involve any local
5687 domains. This is specified by the line
5688 .code
5689 domains = ! +local_domains
5690 .endd
5691 The &%domains%& option lists the domains to which this router applies, but the
5692 exclamation mark is a negation sign, so the router is used only for domains
5693 that are not in the domain list called &'local_domains'& (which was defined at
5694 the start of the configuration). The plus sign before &'local_domains'&
5695 indicates that it is referring to a named list. Addresses in other domains are
5696 passed on to the following routers.
5697
5698 The name of the router driver is &(dnslookup)&,
5699 and is specified by the &%driver%& option. Do not be confused by the fact that
5700 the name of this router instance is the same as the name of the driver. The
5701 instance name is arbitrary, but the name set in the &%driver%& option must be
5702 one of the driver modules that is in the Exim binary.
5703
5704 The &(dnslookup)& router routes addresses by looking up their domains in the
5705 DNS in order to obtain a list of hosts to which the address is routed. If the
5706 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5707 specified by the &%transport%& option. If the router does not find the domain
5708 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5709 the address fails and is bounced.
5710
5711 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5712 be entirely ignored. This option is present because a number of cases have been
5713 encountered where MX records in the DNS point to host names
5714 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5715 Completely ignoring these IP addresses causes Exim to fail to route the
5716 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5717 continue to try to deliver the message periodically until the address timed
5718 out.
5719 .code
5720 system_aliases:
5721   driver = redirect
5722   allow_fail
5723   allow_defer
5724   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5725 # user = exim
5726   file_transport = address_file
5727   pipe_transport = address_pipe
5728 .endd
5729 Control reaches this and subsequent routers only for addresses in the local
5730 domains. This router checks to see whether the local part is defined as an
5731 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5732 data that it looks up from that file. If no data is found for the local part,
5733 the value of the &%data%& option is empty, causing the address to be passed to
5734 the next router.
5735
5736 &_/etc/aliases_& is a conventional name for the system aliases file that is
5737 often used. That is why it is referenced by from the default configuration
5738 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5739 &_Local/Makefile_& before building Exim.
5740 .code
5741 userforward:
5742   driver = redirect
5743   check_local_user
5744 # local_part_suffix = +* : -*
5745 # local_part_suffix_optional
5746   file = $home/.forward
5747 # allow_filter
5748   no_verify
5749   no_expn
5750   check_ancestor
5751   file_transport = address_file
5752   pipe_transport = address_pipe
5753   reply_transport = address_reply
5754 .endd
5755 This is the most complicated router in the default configuration. It is another
5756 redirection router, but this time it is looking for forwarding data set up by
5757 individual users. The &%check_local_user%& setting specifies a check that the
5758 local part of the address is the login name of a local user. If it is not, the
5759 router is skipped. The two commented options that follow &%check_local_user%&,
5760 namely:
5761 .code
5762 # local_part_suffix = +* : -*
5763 # local_part_suffix_optional
5764 .endd
5765 .vindex "&$local_part_suffix$&"
5766 show how you can specify the recognition of local part suffixes. If the first
5767 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5768 by any sequence of characters, is removed from the local part and placed in the
5769 variable &$local_part_suffix$&. The second suffix option specifies that the
5770 presence of a suffix in the local part is optional. When a suffix is present,
5771 the check for a local login uses the local part with the suffix removed.
5772
5773 When a local user account is found, the file called &_.forward_& in the user's
5774 home directory is consulted. If it does not exist, or is empty, the router
5775 declines. Otherwise, the contents of &_.forward_& are interpreted as
5776 redirection data (see chapter &<<CHAPredirect>>& for more details).
5777
5778 .cindex "Sieve filter" "enabling in default router"
5779 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5780 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5781 is commented out by default), the contents of the file are interpreted as a set
5782 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5783 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5784 separate document entitled &'Exim's interfaces to mail filtering'&.
5785
5786 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5787 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5788 There are two reasons for doing this:
5789
5790 .olist
5791 Whether or not a local user has a &_.forward_& file is not really relevant when
5792 checking an address for validity; it makes sense not to waste resources doing
5793 unnecessary work.
5794 .next
5795 More importantly, when Exim is verifying addresses or handling an EXPN
5796 command during an SMTP session, it is running as the Exim user, not as root.
5797 The group is the Exim group, and no additional groups are set up.
5798 It may therefore not be possible for Exim to read users' &_.forward_& files at
5799 this time.
5800 .endlist
5801
5802 The setting of &%check_ancestor%& prevents the router from generating a new
5803 address that is the same as any previous address that was redirected. (This
5804 works round a problem concerning a bad interaction between aliasing and
5805 forwarding &-- see section &<<SECTredlocmai>>&).
5806
5807 The final three option settings specify the transports that are to be used when
5808 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5809 auto-reply, respectively. For example, if a &_.forward_& file contains
5810 .code
5811 a.nother@elsewhere.example, /home/spqr/archive
5812 .endd
5813 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5814 transport.
5815 .code
5816 localuser:
5817   driver = accept
5818   check_local_user
5819 # local_part_suffix = +* : -*
5820 # local_part_suffix_optional
5821   transport = local_delivery
5822 .endd
5823 The final router sets up delivery into local mailboxes, provided that the local
5824 part is the name of a local login, by accepting the address and assigning it to
5825 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5826 routers, so the address is bounced. The commented suffix settings fulfil the
5827 same purpose as they do for the &(userforward)& router.
5828
5829
5830 .section "Transport configuration" "SECID56"
5831 .cindex "default" "transports"
5832 .cindex "transports" "default"
5833 Transports define mechanisms for actually delivering messages. They operate
5834 only when referenced from routers, so the order in which they are defined does
5835 not matter. The transports section of the configuration starts with
5836 .code
5837 begin transports
5838 .endd
5839 One remote transport and four local transports are defined.
5840 .code
5841 remote_smtp:
5842   driver = smtp
5843 .endd
5844 This transport is used for delivering messages over SMTP connections. All its
5845 options are defaulted. The list of remote hosts comes from the router.
5846 .code
5847 local_delivery:
5848   driver = appendfile
5849   file = /var/mail/$local_part
5850   delivery_date_add
5851   envelope_to_add
5852   return_path_add
5853 # group = mail
5854 # mode = 0660
5855 .endd
5856 This &(appendfile)& transport is used for local delivery to user mailboxes in
5857 traditional BSD mailbox format. By default it runs under the uid and gid of the
5858 local user, which requires the sticky bit to be set on the &_/var/mail_&
5859 directory. Some systems use the alternative approach of running mail deliveries
5860 under a particular group instead of using the sticky bit. The commented options
5861 show how this can be done.
5862
5863 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5864 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5865 similarly-named options above.
5866 .code
5867 address_pipe:
5868   driver = pipe
5869   return_output
5870 .endd
5871 This transport is used for handling deliveries to pipes that are generated by
5872 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
5873 option specifies that any output generated by the pipe is to be returned to the
5874 sender.
5875 .code
5876 address_file:
5877   driver = appendfile
5878   delivery_date_add
5879   envelope_to_add
5880   return_path_add
5881 .endd
5882 This transport is used for handling deliveries to files that are generated by
5883 redirection. The name of the file is not specified in this instance of
5884 &(appendfile)&, because it comes from the &(redirect)& router.
5885 .code
5886 address_reply:
5887   driver = autoreply
5888 .endd
5889 This transport is used for handling automatic replies generated by users'
5890 filter files.
5891
5892
5893
5894 .section "Default retry rule" "SECID57"
5895 .cindex "retry" "default rule"
5896 .cindex "default" "retry rule"
5897 The retry section of the configuration file contains rules which affect the way
5898 Exim retries deliveries that cannot be completed at the first attempt. It is
5899 introduced by the line
5900 .code
5901 begin retry
5902 .endd
5903 In the default configuration, there is just one rule, which applies to all
5904 errors:
5905 .code
5906 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
5907 .endd
5908 This causes any temporarily failing address to be retried every 15 minutes for
5909 2 hours, then at intervals starting at one hour and increasing by a factor of
5910 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
5911 is not delivered after 4 days of temporary failure, it is bounced.
5912
5913 If the retry section is removed from the configuration, or is empty (that is,
5914 if no retry rules are defined), Exim will not retry deliveries. This turns
5915 temporary errors into permanent errors.
5916
5917
5918 .section "Rewriting configuration" "SECID58"
5919 The rewriting section of the configuration, introduced by
5920 .code
5921 begin rewrite
5922 .endd
5923 contains rules for rewriting addresses in messages as they arrive. There are no
5924 rewriting rules in the default configuration file.
5925
5926
5927
5928 .section "Authenticators configuration" "SECTdefconfauth"
5929 .cindex "AUTH" "configuration"
5930 The authenticators section of the configuration, introduced by
5931 .code
5932 begin authenticators
5933 .endd
5934 defines mechanisms for the use of the SMTP AUTH command. The default
5935 configuration file contains two commented-out example authenticators
5936 which support plaintext username/password authentication using the
5937 standard PLAIN mechanism and the traditional but non-standard LOGIN
5938 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
5939 to support most MUA software.
5940
5941 The example PLAIN authenticator looks like this:
5942 .code
5943 #PLAIN:
5944 #  driver                  = plaintext
5945 #  server_set_id           = $auth2
5946 #  server_prompts          = :
5947 #  server_condition        = Authentication is not yet configured
5948 #  server_advertise_condition = ${if def:tls_cipher }
5949 .endd
5950 And the example LOGIN authenticator looks like this:
5951 .code
5952 #LOGIN:
5953 #  driver                  = plaintext
5954 #  server_set_id           = $auth1
5955 #  server_prompts          = <| Username: | Password:
5956 #  server_condition        = Authentication is not yet configured
5957 #  server_advertise_condition = ${if def:tls_cipher }
5958 .endd
5959
5960 The &%server_set_id%& option makes Exim remember the authenticated username
5961 in &$authenticated_id$&, which can be used later in ACLs or routers. The
5962 &%server_prompts%& option configures the &(plaintext)& authenticator so
5963 that it implements the details of the specific authentication mechanism,
5964 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
5965 when Exim offers authentication to clients; in the examples, this is only
5966 when TLS or SSL has been started, so to enable the authenticators you also
5967 need to add support for TLS as described in &<<SECTdefconfmain>>&.
5968
5969 The &%server_condition%& setting defines how to verify that the username and
5970 password are correct. In the examples it just produces an error message.
5971 To make the authenticators work, you can use a string expansion
5972 expression like one of the examples in &<<CHAPplaintext>>&.
5973
5974 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
5975 usercode and password are in different positions.  &<<CHAPplaintext>>&
5976 covers both.
5977
5978 .ecindex IIDconfiwal
5979
5980
5981
5982 . ////////////////////////////////////////////////////////////////////////////
5983 . ////////////////////////////////////////////////////////////////////////////
5984
5985 .chapter "Regular expressions" "CHAPregexp"
5986
5987 .cindex "regular expressions" "library"
5988 .cindex "PCRE"
5989 Exim supports the use of regular expressions in many of its options. It
5990 uses the PCRE regular expression library; this provides regular expression
5991 matching that is compatible with Perl 5. The syntax and semantics of
5992 regular expressions is discussed in many Perl reference books, and also in
5993 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
5994 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
5995
5996 The documentation for the syntax and semantics of the regular expressions that
5997 are supported by PCRE is included in the PCRE distribution, and no further
5998 description is included here. The PCRE functions are called from Exim using
5999 the default option settings (that is, with no PCRE options set), except that
6000 the PCRE_CASELESS option is set when the matching is required to be
6001 case-insensitive.
6002
6003 In most cases, when a regular expression is required in an Exim configuration,
6004 it has to start with a circumflex, in order to distinguish it from plain text
6005 or an &"ends with"& wildcard. In this example of a configuration setting, the
6006 second item in the colon-separated list is a regular expression.
6007 .code
6008 domains = a.b.c : ^\\d{3} : *.y.z : ...
6009 .endd
6010 The doubling of the backslash is required because of string expansion that
6011 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6012 of this issue, and a way of avoiding the need for doubling backslashes. The
6013 regular expression that is eventually used in this example contains just one
6014 backslash. The circumflex is included in the regular expression, and has the
6015 normal effect of &"anchoring"& it to the start of the string that is being
6016 matched.
6017
6018 There are, however, two cases where a circumflex is not required for the
6019 recognition of a regular expression: these are the &%match%& condition in a
6020 string expansion, and the &%matches%& condition in an Exim filter file. In
6021 these cases, the relevant string is always treated as a regular expression; if
6022 it does not start with a circumflex, the expression is not anchored, and can
6023 match anywhere in the subject string.
6024
6025 In all cases, if you want a regular expression to match at the end of a string,
6026 you must code the $ metacharacter to indicate this. For example:
6027 .code
6028 domains = ^\\d{3}\\.example
6029 .endd
6030 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6031 You need to use:
6032 .code
6033 domains = ^\\d{3}\\.example\$
6034 .endd
6035 if you want &'example'& to be the top-level domain. The backslash before the
6036 $ is needed because string expansion also interprets dollar characters.
6037
6038
6039
6040 . ////////////////////////////////////////////////////////////////////////////
6041 . ////////////////////////////////////////////////////////////////////////////
6042
6043 .chapter "File and database lookups" "CHAPfdlookup"
6044 .scindex IIDfidalo1 "file" "lookups"
6045 .scindex IIDfidalo2 "database" "lookups"
6046 .cindex "lookup" "description of"
6047 Exim can be configured to look up data in files or databases as it processes
6048 messages. Two different kinds of syntax are used:
6049
6050 .olist
6051 A string that is to be expanded may contain explicit lookup requests. These
6052 cause parts of the string to be replaced by data that is obtained from the
6053 lookup. Lookups of this type are conditional expansion items. Different results
6054 can be defined for the cases of lookup success and failure. See chapter
6055 &<<CHAPexpand>>&, where string expansions are described in detail.
6056 .next
6057 Lists of domains, hosts, and email addresses can contain lookup requests as a
6058 way of avoiding excessively long linear lists. In this case, the data that is
6059 returned by the lookup is often (but not always) discarded; whether the lookup
6060 succeeds or fails is what really counts. These kinds of list are described in
6061 chapter &<<CHAPdomhosaddlists>>&.
6062 .endlist
6063
6064 String expansions, lists, and lookups interact with each other in such a way
6065 that there is no order in which to describe any one of them that does not
6066 involve references to the others. Each of these three chapters makes more sense
6067 if you have read the other two first. If you are reading this for the first
6068 time, be aware that some of it will make a lot more sense after you have read
6069 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6070
6071 .section "Examples of different lookup syntax" "SECID60"
6072 It is easy to confuse the two different kinds of lookup, especially as the
6073 lists that may contain the second kind are always expanded before being
6074 processed as lists. Therefore, they may also contain lookups of the first kind.
6075 Be careful to distinguish between the following two examples:
6076 .code
6077 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6078 domains = lsearch;/some/file
6079 .endd
6080 The first uses a string expansion, the result of which must be a domain list.
6081 No strings have been specified for a successful or a failing lookup; the
6082 defaults in this case are the looked-up data and an empty string, respectively.
6083 The expansion takes place before the string is processed as a list, and the
6084 file that is searched could contain lines like this:
6085 .code
6086 192.168.3.4: domain1:domain2:...
6087 192.168.1.9: domain3:domain4:...
6088 .endd
6089 When the lookup succeeds, the result of the expansion is a list of domains (and
6090 possibly other types of item that are allowed in domain lists).
6091
6092 In the second example, the lookup is a single item in a domain list. It causes
6093 Exim to use a lookup to see if the domain that is being processed can be found
6094 in the file. The file could contains lines like this:
6095 .code
6096 domain1:
6097 domain2:
6098 .endd
6099 Any data that follows the keys is not relevant when checking that the domain
6100 matches the list item.
6101
6102 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6103 Consider a file containing lines like this:
6104 .code
6105 192.168.5.6: lsearch;/another/file
6106 .endd
6107 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6108 first &%domains%& setting above generates the second setting, which therefore
6109 causes a second lookup to occur.
6110
6111 The rest of this chapter describes the different lookup types that are
6112 available. Any of them can be used in any part of the configuration where a
6113 lookup is permitted.
6114
6115
6116 .section "Lookup types" "SECID61"
6117 .cindex "lookup" "types of"
6118 .cindex "single-key lookup" "definition of"
6119 Two different types of data lookup are implemented:
6120
6121 .ilist
6122 The &'single-key'& type requires the specification of a file in which to look,
6123 and a single key to search for. The key must be a non-empty string for the
6124 lookup to succeed. The lookup type determines how the file is searched.
6125 .next
6126 .cindex "query-style lookup" "definition of"
6127 The &'query-style'& type accepts a generalized database query. No particular
6128 key value is assumed by Exim for query-style lookups. You can use whichever
6129 Exim variables you need to construct the database query.
6130 .endlist
6131
6132 The code for each lookup type is in a separate source file that is included in
6133 the binary of Exim only if the corresponding compile-time option is set. The
6134 default settings in &_src/EDITME_& are:
6135 .code
6136 LOOKUP_DBM=yes
6137 LOOKUP_LSEARCH=yes
6138 .endd
6139 which means that only linear searching and DBM lookups are included by default.
6140 For some types of lookup (e.g. SQL databases), you need to install appropriate
6141 libraries and header files before building Exim.
6142
6143
6144
6145
6146 .section "Single-key lookup types" "SECTsinglekeylookups"
6147 .cindex "lookup" "single-key types"
6148 .cindex "single-key lookup" "list of types"
6149 The following single-key lookup types are implemented:
6150
6151 .ilist
6152 .cindex "cdb" "description of"
6153 .cindex "lookup" "cdb"
6154 .cindex "binary zero" "in lookup key"
6155 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6156 string without a terminating binary zero. The cdb format is designed for
6157 indexed files that are read frequently and never updated, except by total
6158 re-creation. As such, it is particularly suitable for large files containing
6159 aliases or other indexed data referenced by an MTA. Information about cdb can
6160 be found in several places:
6161 .display
6162 &url(http://www.pobox.com/~djb/cdb.html)
6163 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6164 &url(http://packages.debian.org/stable/utils/freecdb.html)
6165 .endd
6166 A cdb distribution is not needed in order to build Exim with cdb support,
6167 because the code for reading cdb files is included directly in Exim itself.
6168 However, no means of building or testing cdb files is provided with Exim, so
6169 you need to obtain a cdb distribution in order to do this.
6170 .next
6171 .cindex "DBM" "lookup type"
6172 .cindex "lookup" "dbm"
6173 .cindex "binary zero" "in lookup key"
6174 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6175 DBM file by looking up the record with the given key. A terminating binary
6176 zero is included in the key that is passed to the DBM library. See section
6177 &<<SECTdb>>& for a discussion of DBM libraries.
6178
6179 .cindex "Berkeley DB library" "file format"
6180 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6181 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6182 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6183 the DB_UNKNOWN option. This enables it to handle any of the types of database
6184 that the library supports, and can be useful for accessing DBM files created by
6185 other applications. (For earlier DB versions, DB_HASH is always used.)
6186 .next
6187 .cindex "lookup" "dbmnz"
6188 .cindex "lookup" "dbm &-- terminating zero"
6189 .cindex "binary zero" "in lookup key"
6190 .cindex "Courier"
6191 .cindex "&_/etc/userdbshadow.dat_&"
6192 .cindex "dmbnz lookup type"
6193 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6194 is not included in the key that is passed to the DBM library. You may need this
6195 if you want to look up data in files that are created by or shared with some
6196 other application that does not use terminating zeros. For example, you need to
6197 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6198 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6199 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6200 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6201 .next
6202 .cindex "lookup" "dsearch"
6203 .cindex "dsearch lookup type"
6204 &(dsearch)&: The given file must be a directory; this is searched for an entry
6205 whose name is the key by calling the &[lstat()]& function. The key may not
6206 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6207 the lookup is the name of the entry, which may be a file, directory,
6208 symbolic link, or any other kind of directory entry. An example of how this
6209 lookup can be used to support virtual domains is given in section
6210 &<<SECTvirtualdomains>>&.
6211 .next
6212 .cindex "lookup" "iplsearch"
6213 .cindex "iplsearch lookup type"
6214 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6215 terminated by a colon or white space or the end of the line. The keys in the
6216 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6217 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6218 being interpreted as a key terminator. For example:
6219 .code
6220 1.2.3.4:           data for 1.2.3.4
6221 192.168.0.0/16:    data for 192.168.0.0/16
6222 "abcd::cdab":      data for abcd::cdab
6223 "abcd:abcd::/32"   data for abcd:abcd::/32
6224 .endd
6225 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6226 file is searched linearly, using the CIDR masks where present, until a matching
6227 key is found. The first key that matches is used; there is no attempt to find a
6228 &"best"& match. Apart from the way the keys are matched, the processing for
6229 &(iplsearch)& is the same as for &(lsearch)&.
6230
6231 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6232 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6233 lookup types support only literal keys.
6234
6235 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6236 the implicit key is the host's IP address rather than its name (see section
6237 &<<SECThoslispatsikey>>&).
6238 .next
6239 .cindex "linear search"
6240 .cindex "lookup" "lsearch"
6241 .cindex "lsearch lookup type"
6242 .cindex "case sensitivity" "in lsearch lookup"
6243 &(lsearch)&: The given file is a text file that is searched linearly for a
6244 line beginning with the search key, terminated by a colon or white space or the
6245 end of the line. The search is case-insensitive; that is, upper and lower case
6246 letters are treated as the same. The first occurrence of the key that is found
6247 in the file is used.
6248
6249 White space between the key and the colon is permitted. The remainder of the
6250 line, with leading and trailing white space removed, is the data. This can be
6251 continued onto subsequent lines by starting them with any amount of white
6252 space, but only a single space character is included in the data at such a
6253 junction. If the data begins with a colon, the key must be terminated by a
6254 colon, for example:
6255 .code
6256 baduser:  :fail:
6257 .endd
6258 Empty lines and lines beginning with # are ignored, even if they occur in the
6259 middle of an item. This is the traditional textual format of alias files. Note
6260 that the keys in an &(lsearch)& file are literal strings. There is no
6261 wildcarding of any kind.
6262
6263 .cindex "lookup" "lsearch &-- colons in keys"
6264 .cindex "white space" "in lsearch key"
6265 In most &(lsearch)& files, keys are not required to contain colons or #
6266 characters, or white space. However, if you need this feature, it is available.
6267 If a key begins with a doublequote character, it is terminated only by a
6268 matching quote (or end of line), and the normal escaping rules apply to its
6269 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6270 quoted keys (exactly as for unquoted keys). There is no special handling of
6271 quotes for the data part of an &(lsearch)& line.
6272
6273 .next
6274 .cindex "NIS lookup type"
6275 .cindex "lookup" "NIS"
6276 .cindex "binary zero" "in lookup key"
6277 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6278 the given key, without a terminating binary zero. There is a variant called
6279 &(nis0)& which does include the terminating binary zero in the key. This is
6280 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6281 aliases; the full map names must be used.
6282
6283 .next
6284 .cindex "wildlsearch lookup type"
6285 .cindex "lookup" "wildlsearch"
6286 .cindex "nwildlsearch lookup type"
6287 .cindex "lookup" "nwildlsearch"
6288 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6289 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6290 the file may be wildcarded. The difference between these two lookup types is
6291 that for &(wildlsearch)&, each key in the file is string-expanded before being
6292 used, whereas for &(nwildlsearch)&, no expansion takes place.
6293
6294 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6295 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6296 file that are regular expressions can be made case-sensitive by the use of
6297 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6298
6299 . ==== As this is a nested list, any displays it contains must be indented
6300 . ==== as otherwise they are too far to the left.
6301
6302 .olist
6303 The string may begin with an asterisk to mean &"ends with"&. For example:
6304 .code
6305     *.a.b.c       data for anything.a.b.c
6306     *fish         data for anythingfish
6307 .endd
6308 .next
6309 The string may begin with a circumflex to indicate a regular expression. For
6310 example, for &(wildlsearch)&:
6311 .code
6312     ^\N\d+\.a\.b\N    data for <digits>.a.b
6313 .endd
6314 Note the use of &`\N`& to disable expansion of the contents of the regular
6315 expression. If you are using &(nwildlsearch)&, where the keys are not
6316 string-expanded, the equivalent entry is:
6317 .code
6318     ^\d+\.a\.b        data for <digits>.a.b
6319 .endd
6320 The case-insensitive flag is set at the start of compiling the regular
6321 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6322 For example, to make the entire pattern case-sensitive:
6323 .code
6324     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6325 .endd
6326
6327 If the regular expression contains white space or colon characters, you must
6328 either quote it (see &(lsearch)& above), or represent these characters in other
6329 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6330 colon. This may be easier than quoting, because if you quote, you have to
6331 escape all the backslashes inside the quotes.
6332
6333 &*Note*&: It is not possible to capture substrings in a regular expression
6334 match for later use, because the results of all lookups are cached. If a lookup
6335 is repeated, the result is taken from the cache, and no actual pattern matching
6336 takes place. The values of all the numeric variables are unset after a
6337 &((n)wildlsearch)& match.
6338
6339 .next
6340 Although I cannot see it being of much use, the general matching function that
6341 is used to implement &((n)wildlsearch)& means that the string may begin with a
6342 lookup name terminated by a semicolon, and followed by lookup data. For
6343 example:
6344 .code
6345     cdb;/some/file  data for keys that match the file
6346 .endd
6347 The data that is obtained from the nested lookup is discarded.
6348 .endlist olist
6349
6350 Keys that do not match any of these patterns are interpreted literally. The
6351 continuation rules for the data are the same as for &(lsearch)&, and keys may
6352 be followed by optional colons.
6353
6354 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6355 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6356 lookup types support only literal keys.
6357 .endlist ilist
6358
6359
6360 .section "Query-style lookup types" "SECID62"
6361 .cindex "lookup" "query-style types"
6362 .cindex "query-style lookup" "list of types"
6363 The supported query-style lookup types are listed below. Further details about
6364 many of them are given in later sections.
6365
6366 .ilist
6367 .cindex "DNS" "as a lookup type"
6368 .cindex "lookup" "DNS"
6369 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6370 are given in the supplied query. The resulting data is the contents of the
6371 records. See section &<<SECTdnsdb>>&.
6372 .next
6373 .cindex "InterBase lookup type"
6374 .cindex "lookup" "InterBase"
6375 &(ibase)&: This does a lookup in an InterBase database.
6376 .next
6377 .cindex "LDAP" "lookup type"
6378 .cindex "lookup" "LDAP"
6379 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6380 returns attributes from a single entry. There is a variant called &(ldapm)&
6381 that permits values from multiple entries to be returned. A third variant
6382 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6383 any attribute values. See section &<<SECTldap>>&.
6384 .next
6385 .cindex "MySQL" "lookup type"
6386 .cindex "lookup" "MySQL"
6387 &(mysql)&: The format of the query is an SQL statement that is passed to a
6388 MySQL database. See section &<<SECTsql>>&.
6389 .next
6390 .cindex "NIS+ lookup type"
6391 .cindex "lookup" "NIS+"
6392 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6393 the field to be returned. See section &<<SECTnisplus>>&.
6394 .next
6395 .cindex "Oracle" "lookup type"
6396 .cindex "lookup" "Oracle"
6397 &(oracle)&: The format of the query is an SQL statement that is passed to an
6398 Oracle database. See section &<<SECTsql>>&.
6399 .next
6400 .cindex "lookup" "passwd"
6401 .cindex "passwd lookup type"
6402 .cindex "&_/etc/passwd_&"
6403 &(passwd)& is a query-style lookup with queries that are just user names. The
6404 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6405 success, the result string is the same as you would get from an &(lsearch)&
6406 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6407 password value. For example:
6408 .code
6409 *:42:42:King Rat:/home/kr:/bin/bash
6410 .endd
6411 .next
6412 .cindex "PostgreSQL lookup type"
6413 .cindex "lookup" "PostgreSQL"
6414 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6415 PostgreSQL database. See section &<<SECTsql>>&.
6416
6417 .next
6418 .cindex "sqlite lookup type"
6419 .cindex "lookup" "sqlite"
6420 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6421 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6422
6423 .next
6424 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6425 not likely to be useful in normal operation.
6426 .next
6427 .cindex "whoson lookup type"
6428 .cindex "lookup" "whoson"
6429 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6430 allows a server to check whether a particular (dynamically allocated) IP
6431 address is currently allocated to a known (trusted) user and, optionally, to
6432 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6433 at one time for &"POP before SMTP"& authentication, but that approach has been
6434 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6435 &"POP before SMTP"& checking using ACL statements such as
6436 .code
6437 require condition = \
6438   ${lookup whoson {$sender_host_address}{yes}{no}}
6439 .endd
6440 The query consists of a single IP address. The value returned is the name of
6441 the authenticated user, which is stored in the variable &$value$&. However, in
6442 this example, the data in &$value$& is not used; the result of the lookup is
6443 one of the fixed strings &"yes"& or &"no"&.
6444 .endlist
6445
6446
6447
6448 .section "Temporary errors in lookups" "SECID63"
6449 .cindex "lookup" "temporary error in"
6450 Lookup functions can return temporary error codes if the lookup cannot be
6451 completed. For example, an SQL or LDAP database might be unavailable. For this
6452 reason, it is not advisable to use a lookup that might do this for critical
6453 options such as a list of local domains.
6454
6455 When a lookup cannot be completed in a router or transport, delivery
6456 of the message (to the relevant address) is deferred, as for any other
6457 temporary error. In other circumstances Exim may assume the lookup has failed,
6458 or may give up altogether.
6459
6460
6461
6462 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6463 .cindex "wildcard lookups"
6464 .cindex "lookup" "default values"
6465 .cindex "lookup" "wildcard"
6466 .cindex "lookup" "* added to type"
6467 .cindex "default" "in single-key lookups"
6468 In this context, a &"default value"& is a value specified by the administrator
6469 that is to be used if a lookup fails.
6470
6471 &*Note:*& This section applies only to single-key lookups. For query-style
6472 lookups, the facilities of the query language must be used. An attempt to
6473 specify a default for a query-style lookup provokes an error.
6474
6475 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6476 and the initial lookup fails, the key &"*"& is looked up in the file to
6477 provide a default value. See also the section on partial matching below.
6478
6479 .cindex "*@ with single-key lookup"
6480 .cindex "lookup" "*@ added to type"
6481 .cindex "alias file" "per-domain default"
6482 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6483 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6484 character, a second lookup is done with everything before the last @ replaced
6485 by *. This makes it possible to provide per-domain defaults in alias files
6486 that include the domains in the keys. If the second lookup fails (or doesn't
6487 take place because there is no @ in the key), &"*"& is looked up.
6488 For example, a &(redirect)& router might contain:
6489 .code
6490 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6491 .endd
6492 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6493 looks up these keys, in this order:
6494 .code
6495 jane@eyre.example
6496 *@eyre.example
6497 *
6498 .endd
6499 The data is taken from whichever key it finds first. &*Note*&: In an
6500 &(lsearch)& file, this does not mean the first of these keys in the file. A
6501 complete scan is done for each key, and only if it is not found at all does
6502 Exim move on to try the next key.
6503
6504
6505
6506 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6507 .cindex "partial matching"
6508 .cindex "wildcard lookups"
6509 .cindex "lookup" "partial matching"
6510 .cindex "lookup" "wildcard"
6511 .cindex "asterisk" "in search type"
6512 The normal operation of a single-key lookup is to search the file for an exact
6513 match with the given key. However, in a number of situations where domains are
6514 being looked up, it is useful to be able to do partial matching. In this case,
6515 information in the file that has a key starting with &"*."& is matched by any
6516 domain that ends with the components that follow the full stop. For example, if
6517 a key in a DBM file is
6518 .code
6519 *.dates.fict.example
6520 .endd
6521 then when partial matching is enabled this is matched by (amongst others)
6522 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6523 by &'dates.fict.example'&, if that does not appear as a separate key in the
6524 file.
6525
6526 &*Note*&: Partial matching is not available for query-style lookups. It is
6527 also not available for any lookup items in address lists (see section
6528 &<<SECTaddresslist>>&).
6529
6530 Partial matching is implemented by doing a series of separate lookups using
6531 keys constructed by modifying the original subject key. This means that it can
6532 be used with any of the single-key lookup types, provided that
6533 partial matching keys
6534 beginning with a special prefix (default &"*."&) are included in the data file.
6535 Keys in the file that do not begin with the prefix are matched only by
6536 unmodified subject keys when partial matching is in use.
6537
6538 Partial matching is requested by adding the string &"partial-"& to the front of
6539 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6540 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6541 is added at the start of the subject key, and it is looked up again. If that
6542 fails, further lookups are tried with dot-separated components removed from the
6543 start of the subject key, one-by-one, and &"*."& added on the front of what
6544 remains.
6545
6546 A minimum number of two non-* components are required. This can be adjusted
6547 by including a number before the hyphen in the search type. For example,
6548 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6549 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6550 subject key is &'2250.dates.fict.example'& then the following keys are looked
6551 up when the minimum number of non-* components is two:
6552 .code
6553 2250.dates.fict.example
6554 *.2250.dates.fict.example
6555 *.dates.fict.example
6556 *.fict.example
6557 .endd
6558 As soon as one key in the sequence is successfully looked up, the lookup
6559 finishes.
6560
6561 .cindex "lookup" "partial matching &-- changing prefix"
6562 .cindex "prefix" "for partial matching"
6563 The use of &"*."& as the partial matching prefix is a default that can be
6564 changed. The motivation for this feature is to allow Exim to operate with file
6565 formats that are used by other MTAs. A different prefix can be supplied in
6566 parentheses instead of the hyphen after &"partial"&. For example:
6567 .code
6568 domains = partial(.)lsearch;/some/file
6569 .endd
6570 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6571 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6572 components is unchanged). The prefix may consist of any punctuation characters
6573 other than a closing parenthesis. It may be empty, for example:
6574 .code
6575 domains = partial1()cdb;/some/file
6576 .endd
6577 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6578 &`a.b.c`&, &`b.c`&, and &`c`&.
6579
6580 If &"partial0"& is specified, what happens at the end (when the lookup with
6581 just one non-wild component has failed, and the original key is shortened right
6582 down to the null string) depends on the prefix:
6583
6584 .ilist
6585 If the prefix has zero length, the whole lookup fails.
6586 .next
6587 If the prefix has length 1, a lookup for just the prefix is done. For
6588 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6589 .next
6590 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6591 remainder is looked up. With the default prefix, therefore, the final lookup is
6592 for &"*"& on its own.
6593 .next
6594 Otherwise, the whole prefix is looked up.
6595 .endlist
6596
6597
6598 If the search type ends in &"*"& or &"*@"& (see section
6599 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6600 this implies happens after all partial lookups have failed. If &"partial0"& is
6601 specified, adding &"*"& to the search type has no effect with the default
6602 prefix, because the &"*"& key is already included in the sequence of partial
6603 lookups. However, there might be a use for lookup types such as
6604 &"partial0(.)lsearch*"&.
6605
6606 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6607 in domain lists and the like. Partial matching works only in terms of
6608 dot-separated components; a key such as &`*fict.example`&
6609 in a database file is useless, because the asterisk in a partial matching
6610 subject key is always followed by a dot.
6611
6612
6613
6614
6615 .section "Lookup caching" "SECID64"
6616 .cindex "lookup" "caching"
6617 .cindex "caching" "lookup data"
6618 Exim caches all lookup results in order to avoid needless repetition of
6619 lookups. However, because (apart from the daemon) Exim operates as a collection
6620 of independent, short-lived processes, this caching applies only within a
6621 single Exim process. There is no inter-process lookup caching facility.
6622
6623 For single-key lookups, Exim keeps the relevant files open in case there is
6624 another lookup that needs them. In some types of configuration this can lead to
6625 many files being kept open for messages with many recipients. To avoid hitting
6626 the operating system limit on the number of simultaneously open files, Exim
6627 closes the least recently used file when it needs to open more files than its
6628 own internal limit, which can be changed via the &%lookup_open_max%& option.
6629
6630 The single-key lookup files are closed and the lookup caches are flushed at
6631 strategic points during delivery &-- for example, after all routing is
6632 complete.
6633
6634
6635
6636
6637 .section "Quoting lookup data" "SECID65"
6638 .cindex "lookup" "quoting"
6639 .cindex "quoting" "in lookups"
6640 When data from an incoming message is included in a query-style lookup, there
6641 is the possibility of special characters in the data messing up the syntax of
6642 the query. For example, a NIS+ query that contains
6643 .code
6644 [name=$local_part]
6645 .endd
6646 will be broken if the local part happens to contain a closing square bracket.
6647 For NIS+, data can be enclosed in double quotes like this:
6648 .code
6649 [name="$local_part"]
6650 .endd
6651 but this still leaves the problem of a double quote in the data. The rule for
6652 NIS+ is that double quotes must be doubled. Other lookup types have different
6653 rules, and to cope with the differing requirements, an expansion operator
6654 of the following form is provided:
6655 .code
6656 ${quote_<lookup-type>:<string>}
6657 .endd
6658 For example, the safest way to write the NIS+ query is
6659 .code
6660 [name="${quote_nisplus:$local_part}"]
6661 .endd
6662 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6663 operator can be used for all lookup types, but has no effect for single-key
6664 lookups, since no quoting is ever needed in their key strings.
6665
6666
6667
6668
6669 .section "More about dnsdb" "SECTdnsdb"
6670 .cindex "dnsdb lookup"
6671 .cindex "lookup" "dnsdb"
6672 .cindex "DNS" "as a lookup type"
6673 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6674 of a record type and a domain name, separated by an equals sign. For example,
6675 an expansion string could contain:
6676 .code
6677 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6678 .endd
6679 If the lookup succeeds, the result is placed in &$value$&, which in this case
6680 is used on its own as the result. If the lookup does not succeed, the
6681 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6682 &<<SECTforexpfai>>& for an explanation of what this means.
6683
6684 The supported DNS record types are A, CNAME, MX, NS, PTR, SRV, and TXT, and,
6685 when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6686 configured). If no type is given, TXT is assumed. When the type is PTR,
6687 the data can be an IP address, written as normal; inversion and the addition of
6688 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6689 .code
6690 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6691 .endd
6692 If the data for a PTR record is not a syntactically valid IP address, it is not
6693 altered and nothing is added.
6694
6695 .cindex "MX record" "in &(dnsdb)& lookup"
6696 .cindex "SRV record" "in &(dnsdb)& lookup"
6697 For an MX lookup, both the preference value and the host name are returned for
6698 each record, separated by a space. For an SRV lookup, the priority, weight,
6699 port, and host name are returned for each record, separated by spaces.
6700
6701 For any record type, if multiple records are found (or, for A6 lookups, if a
6702 single record leads to multiple addresses), the data is returned as a
6703 concatenation, with newline as the default separator. The order, of course,
6704 depends on the DNS resolver. You can specify a different separator character
6705 between multiple records by putting a right angle-bracket followed immediately
6706 by the new separator at the start of the query. For example:
6707 .code
6708 ${lookup dnsdb{>: a=host1.example}}
6709 .endd
6710 It is permitted to specify a space as the separator character. Further
6711 white space is ignored.
6712
6713 .cindex "TXT record" "in &(dnsdb)& lookup"
6714 For TXT records with multiple items of data, only the first item is returned,
6715 unless a separator for them is specified using a comma after the separator
6716 character followed immediately by the TXT record item separator. To concatenate
6717 items without a separator, use a semicolon instead.
6718 .code
6719 ${lookup dnsdb{>\n,: txt=a.b.example}}
6720 ${lookup dnsdb{>\n; txt=a.b.example}}
6721 .endd
6722 It is permitted to specify a space as the separator character. Further
6723 white space is ignored.
6724
6725 .section "Pseudo dnsdb record types" "SECID66"
6726 .cindex "MX record" "in &(dnsdb)& lookup"
6727 By default, both the preference value and the host name are returned for
6728 each MX record, separated by a space. If you want only host names, you can use
6729 the pseudo-type MXH:
6730 .code
6731 ${lookup dnsdb{mxh=a.b.example}}
6732 .endd
6733 In this case, the preference values are omitted, and just the host names are
6734 returned.
6735
6736 .cindex "name server for enclosing domain"
6737 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6738 records on the given domain, but if none are found, it removes the first
6739 component of the domain name, and tries again. This process continues until NS
6740 records are found or there are no more components left (or there is a DNS
6741 error). In other words, it may return the name servers for a top-level domain,
6742 but it never returns the root name servers. If there are no NS records for the
6743 top-level domain, the lookup fails. Consider these examples:
6744 .code
6745 ${lookup dnsdb{zns=xxx.quercite.com}}
6746 ${lookup dnsdb{zns=xxx.edu}}
6747 .endd
6748 Assuming that in each case there are no NS records for the full domain name,
6749 the first returns the name servers for &%quercite.com%&, and the second returns
6750 the name servers for &%edu%&.
6751
6752 You should be careful about how you use this lookup because, unless the
6753 top-level domain does not exist, the lookup always returns some host names. The
6754 sort of use to which this might be put is for seeing if the name servers for a
6755 given domain are on a blacklist. You can probably assume that the name servers
6756 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6757 such a list.
6758
6759 .cindex "CSA" "in &(dnsdb)& lookup"
6760 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6761 records according to the CSA rules, which are described in section
6762 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6763 not sufficient because of the extra parent domain search behaviour of CSA. The
6764 result of a successful lookup such as:
6765 .code
6766 ${lookup dnsdb {csa=$sender_helo_name}}
6767 .endd
6768 has two space-separated fields: an authorization code and a target host name.
6769 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6770 authorization required but absent, or &"?"& for unknown.
6771
6772
6773 .section "Multiple dnsdb lookups" "SECID67"
6774 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6775 However, you can specify a list of domains or IP addresses in a single
6776 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6777 the default separator, but with the ability to change this. For example:
6778 .code
6779 ${lookup dnsdb{one.domain.com:two.domain.com}}
6780 ${lookup dnsdb{a=one.host.com:two.host.com}}
6781 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6782 .endd
6783 In order to retain backwards compatibility, there is one special case: if
6784 the lookup type is PTR and no change of separator is specified, Exim looks
6785 to see if the rest of the string is precisely one IPv6 address. In this
6786 case, it does not treat it as a list.
6787
6788 The data from each lookup is concatenated, with newline separators by default,
6789 in the same way that multiple DNS records for a single item are handled. A
6790 different separator can be specified, as described above.
6791
6792 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6793 temporary DNS error for any of them, the behaviour is controlled by
6794 an optional keyword followed by a comma that may appear before the record
6795 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6796 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6797 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6798 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6799 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6800 error causes the whole lookup to defer only if none of the other lookups
6801 succeed. The default is &"lax"&, so the following lookups are equivalent:
6802 .code
6803 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6804 ${lookup dnsdb{a=one.host.com:two.host.com}}
6805 .endd
6806 Thus, in the default case, as long as at least one of the DNS lookups
6807 yields some data, the lookup succeeds.
6808
6809
6810
6811
6812 .section "More about LDAP" "SECTldap"
6813 .cindex "LDAP" "lookup, more about"
6814 .cindex "lookup" "LDAP"
6815 .cindex "Solaris" "LDAP"
6816 The original LDAP implementation came from the University of Michigan; this has
6817 become &"Open LDAP"&, and there are now two different releases. Another
6818 implementation comes from Netscape, and Solaris 7 and subsequent releases
6819 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6820 the lookup function level, their error handling is different. For this reason
6821 it is necessary to set a compile-time variable when building Exim with LDAP, to
6822 indicate which LDAP library is in use. One of the following should appear in
6823 your &_Local/Makefile_&:
6824 .code
6825 LDAP_LIB_TYPE=UMICHIGAN
6826 LDAP_LIB_TYPE=OPENLDAP1
6827 LDAP_LIB_TYPE=OPENLDAP2
6828 LDAP_LIB_TYPE=NETSCAPE
6829 LDAP_LIB_TYPE=SOLARIS
6830 .endd
6831 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6832 same interface as the University of Michigan version.
6833
6834 There are three LDAP lookup types in Exim. These behave slightly differently in
6835 the way they handle the results of a query:
6836
6837 .ilist
6838 &(ldap)& requires the result to contain just one entry; if there are more, it
6839 gives an error.
6840 .next
6841 &(ldapdn)& also requires the result to contain just one entry, but it is the
6842 Distinguished Name that is returned rather than any attribute values.
6843 .next
6844 &(ldapm)& permits the result to contain more than one entry; the attributes
6845 from all of them are returned.
6846 .endlist
6847
6848
6849 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6850 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6851 the data returned by a successful lookup is described in the next section.
6852 First we explain how LDAP queries are coded.
6853
6854
6855 .section "Format of LDAP queries" "SECTforldaque"
6856 .cindex "LDAP" "query format"
6857 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
6858 the configuration of a &(redirect)& router one might have this setting:
6859 .code
6860 data = ${lookup ldap \
6861   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
6862   c=UK?mailbox?base?}}
6863 .endd
6864 .cindex "LDAP" "with TLS"
6865 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
6866 secure (encrypted) LDAP connections. The second of these ensures that an
6867 encrypted TLS connection is used.
6868
6869 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
6870 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
6871 See the &%ldap_start_tls%& option.
6872
6873
6874 .section "LDAP quoting" "SECID68"
6875 .cindex "LDAP" "quoting"
6876 Two levels of quoting are required in LDAP queries, the first for LDAP itself
6877 and the second because the LDAP query is represented as a URL. Furthermore,
6878 within an LDAP query, two different kinds of quoting are required. For this
6879 reason, there are two different LDAP-specific quoting operators.
6880
6881 The &%quote_ldap%& operator is designed for use on strings that are part of
6882 filter specifications. Conceptually, it first does the following conversions on
6883 the string:
6884 .code
6885 *   =>   \2A
6886 (   =>   \28
6887 )   =>   \29
6888 \   =>   \5C
6889 .endd
6890 in accordance with RFC 2254. The resulting string is then quoted according
6891 to the rules for URLs, that is, all non-alphanumeric characters except
6892 .code
6893 ! $ ' - . _ ( ) * +
6894 .endd
6895 are converted to their hex values, preceded by a percent sign. For example:
6896 .code
6897 ${quote_ldap: a(bc)*, a<yz>; }
6898 .endd
6899 yields
6900 .code
6901 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
6902 .endd
6903 Removing the URL quoting, this is (with a leading and a trailing space):
6904 .code
6905 a\28bc\29\2A, a<yz>;
6906 .endd
6907 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
6908 base DN specifications in queries. Conceptually, it first converts the string
6909 by inserting a backslash in front of any of the following characters:
6910 .code
6911 , + " \ < > ;
6912 .endd
6913 It also inserts a backslash before any leading spaces or # characters, and
6914 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
6915 is then quoted according to the rules for URLs. For example:
6916 .code
6917 ${quote_ldap_dn: a(bc)*, a<yz>; }
6918 .endd
6919 yields
6920 .code
6921 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
6922 .endd
6923 Removing the URL quoting, this is (with a trailing space):
6924 .code
6925 \ a(bc)*\, a\<yz\>\;\
6926 .endd
6927 There are some further comments about quoting in the section on LDAP
6928 authentication below.
6929
6930
6931 .section "LDAP connections" "SECID69"
6932 .cindex "LDAP" "connections"
6933 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
6934 is in use, via a Unix domain socket. The example given above does not specify
6935 an LDAP server. A server that is reached by TCP/IP can be specified in a query
6936 by starting it with
6937 .code
6938 ldap://<hostname>:<port>/...
6939 .endd
6940 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
6941 used. When no server is specified in a query, a list of default servers is
6942 taken from the &%ldap_default_servers%& configuration option. This supplies a
6943 colon-separated list of servers which are tried in turn until one successfully
6944 handles a query, or there is a serious error. Successful handling either
6945 returns the requested data, or indicates that it does not exist. Serious errors
6946 are syntactical, or multiple values when only a single value is expected.
6947 Errors which cause the next server to be tried are connection failures, bind
6948 failures, and timeouts.
6949
6950 For each server name in the list, a port number can be given. The standard way
6951 of specifying a host and port is to use a colon separator (RFC 1738). Because
6952 &%ldap_default_servers%& is a colon-separated list, such colons have to be
6953 doubled. For example
6954 .code
6955 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
6956 .endd
6957 If &%ldap_default_servers%& is unset, a URL with no server name is passed
6958 to the LDAP library with no server name, and the library's default (normally
6959 the local host) is used.
6960
6961 If you are using the OpenLDAP library, you can connect to an LDAP server using
6962 a Unix domain socket instead of a TCP/IP connection. This is specified by using
6963 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
6964 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
6965 not available.
6966
6967 For this type of connection, instead of a host name for the server, a pathname
6968 for the socket is required, and the port number is not relevant. The pathname
6969 can be specified either as an item in &%ldap_default_servers%&, or inline in
6970 the query. In the former case, you can have settings such as
6971 .code
6972 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
6973 .endd
6974 When the pathname is given in the query, you have to escape the slashes as
6975 &`%2F`& to fit in with the LDAP URL syntax. For example:
6976 .code
6977 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
6978 .endd
6979 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
6980 a pathname, it uses the Unix domain socket code, even if the query actually
6981 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
6982 socket connection. This behaviour means that you can use a setting of
6983 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
6984 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
6985 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
6986 backup host.
6987
6988 If an explicit &`ldapi`& type is given in a query when a host name is
6989 specified, an error is diagnosed. However, if there are more items in
6990 &%ldap_default_servers%&, they are tried. In other words:
6991
6992 .ilist
6993 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
6994 interface.
6995 .next
6996 Using &`ldapi`& with a host name causes an error.
6997 .endlist
6998
6999
7000 Using &`ldapi`& with no host or path in the query, and no setting of
7001 &%ldap_default_servers%&, does whatever the library does by default.
7002
7003
7004
7005 .section "LDAP authentication and control information" "SECID70"
7006 .cindex "LDAP" "authentication"
7007 The LDAP URL syntax provides no way of passing authentication and other control
7008 information to the server. To make this possible, the URL in an LDAP query may
7009 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7010 spaces. If a value contains spaces it must be enclosed in double quotes, and
7011 when double quotes are used, backslash is interpreted in the usual way inside
7012 them. The following names are recognized:
7013 .display
7014 &`DEREFERENCE`&  set the dereferencing parameter
7015 &`NETTIME    `&  set a timeout for a network operation
7016 &`USER       `&  set the DN, for authenticating the LDAP bind
7017 &`PASS       `&  set the password, likewise
7018 &`REFERRALS  `&  set the referrals parameter
7019 &`SIZE       `&  set the limit for the number of entries returned
7020 &`TIME       `&  set the maximum waiting time for a query
7021 .endd
7022 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7023 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7024 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7025 library from trying to follow referrals issued by the LDAP server.
7026
7027 The name CONNECT is an obsolete name for NETTIME, retained for
7028 backwards compatibility. This timeout (specified as a number of seconds) is
7029 enforced from the client end for operations that can be carried out over a
7030 network. Specifically, it applies to network connections and calls to the
7031 &'ldap_result()'& function. If the value is greater than zero, it is used if
7032 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7033 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7034 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7035 Netscape SDK; for OpenLDAP no action is taken.
7036
7037 The TIME parameter (also a number of seconds) is passed to the server to
7038 set a server-side limit on the time taken to complete a search.
7039
7040
7041 Here is an example of an LDAP query in an Exim lookup that uses some of these
7042 values. This is a single line, folded to fit on the page:
7043 .code
7044 ${lookup ldap
7045   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7046   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7047   {$value}fail}
7048 .endd
7049 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7050 any of the auxiliary data. Exim configuration settings that include lookups
7051 which contain password information should be preceded by &"hide"& to prevent
7052 non-admin users from using the &%-bP%& option to see their values.
7053
7054 The auxiliary data items may be given in any order. The default is no
7055 connection timeout (the system timeout is used), no user or password, no limit
7056 on the number of entries returned, and no time limit on queries.
7057
7058 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7059 removes any URL quoting that it may contain before passing it LDAP. Apparently
7060 some libraries do this for themselves, but some do not. Removing the URL
7061 quoting has two advantages:
7062
7063 .ilist
7064 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7065 DNs as with DNs inside actual queries.
7066 .next
7067 It permits spaces inside USER= DNs.
7068 .endlist
7069
7070 For example, a setting such as
7071 .code
7072 USER=cn=${quote_ldap_dn:$1}
7073 .endd
7074 should work even if &$1$& contains spaces.
7075
7076 Expanded data for the PASS= value should be quoted using the &%quote%&
7077 expansion operator, rather than the LDAP quote operators. The only reason this
7078 field needs quoting is to ensure that it conforms to the Exim syntax, which
7079 does not allow unquoted spaces. For example:
7080 .code
7081 PASS=${quote:$3}
7082 .endd
7083 The LDAP authentication mechanism can be used to check passwords as part of
7084 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7085 &<<CHAPexpand>>&.
7086
7087
7088
7089 .section "Format of data returned by LDAP" "SECID71"
7090 .cindex "LDAP" "returned data formats"
7091 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7092 as a sequence of values, for example
7093 .code
7094 cn=manager, o=University of Cambridge, c=UK
7095 .endd
7096 The &(ldap)& lookup type generates an error if more than one entry matches the
7097 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7098 the result between the data from different entries. It is possible for multiple
7099 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7100 you know that whatever values are returned all came from a single entry in the
7101 directory.
7102
7103 In the common case where you specify a single attribute in your LDAP query, the
7104 result is not quoted, and does not contain the attribute name. If the attribute
7105 has multiple values, they are separated by commas.
7106
7107 If you specify multiple attributes, the result contains space-separated, quoted
7108 strings, each preceded by the attribute name and an equals sign. Within the
7109 quotes, the quote character, backslash, and newline are escaped with
7110 backslashes, and commas are used to separate multiple values for the attribute.
7111 Apart from the escaping, the string within quotes takes the same form as the
7112 output when a single attribute is requested. Specifying no attributes is the
7113 same as specifying all of an entry's attributes.
7114
7115 Here are some examples of the output format. The first line of each pair is an
7116 LDAP query, and the second is the data that is returned. The attribute called
7117 &%attr1%& has two values, whereas &%attr2%& has only one value:
7118 .code
7119 ldap:///o=base?attr1?sub?(uid=fred)
7120 value1.1, value1.2
7121
7122 ldap:///o=base?attr2?sub?(uid=fred)
7123 value two
7124
7125 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7126 attr1="value1.1, value1.2" attr2="value two"
7127
7128 ldap:///o=base??sub?(uid=fred)
7129 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7130 .endd
7131 The &%extract%& operator in string expansions can be used to pick out
7132 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7133 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7134 results of LDAP lookups.
7135
7136
7137
7138
7139 .section "More about NIS+" "SECTnisplus"
7140 .cindex "NIS+ lookup type"
7141 .cindex "lookup" "NIS+"
7142 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7143 and field name. If this is given, the result of a successful query is the
7144 contents of the named field; otherwise the result consists of a concatenation
7145 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7146 values containing spaces are quoted. For example, the query
7147 .code
7148 [name=mg1456],passwd.org_dir
7149 .endd
7150 might return the string
7151 .code
7152 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7153 home=/home/mg1456 shell=/bin/bash shadow=""
7154 .endd
7155 (split over two lines here to fit on the page), whereas
7156 .code
7157 [name=mg1456],passwd.org_dir:gcos
7158 .endd
7159 would just return
7160 .code
7161 Martin Guerre
7162 .endd
7163 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7164 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7165 operator is to double any quote characters within the text.
7166
7167
7168
7169 .section "SQL lookups" "SECTsql"
7170 .cindex "SQL lookup types"
7171 .cindex "MySQL" "lookup type"
7172 .cindex "PostgreSQL lookup type"
7173 .cindex "lookup" "MySQL"
7174 .cindex "lookup" "PostgreSQL"
7175 .cindex "Oracle" "lookup type"
7176 .cindex "lookup" "Oracle"
7177 .cindex "InterBase lookup type"
7178 .cindex "lookup" "InterBase"
7179 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7180 databases. Queries for these databases contain SQL statements, so an example
7181 might be
7182 .code
7183 ${lookup mysql{select mailbox from users where id='userx'}\
7184   {$value}fail}
7185 .endd
7186 If the result of the query contains more than one field, the data for each
7187 field in the row is returned, preceded by its name, so the result of
7188 .code
7189 ${lookup pgsql{select home,name from users where id='userx'}\
7190   {$value}}
7191 .endd
7192 might be
7193 .code
7194 home=/home/userx name="Mister X"
7195 .endd
7196 Empty values and values containing spaces are double quoted, with embedded
7197 quotes escaped by a backslash. If the result of the query contains just one
7198 field, the value is passed back verbatim, without a field name, for example:
7199 .code
7200 Mister X
7201 .endd
7202 If the result of the query yields more than one row, it is all concatenated,
7203 with a newline between the data for each row.
7204
7205
7206 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7207 .cindex "MySQL" "lookup type"
7208 .cindex "PostgreSQL lookup type"
7209 .cindex "lookup" "MySQL"
7210 .cindex "lookup" "PostgreSQL"
7211 .cindex "Oracle" "lookup type"
7212 .cindex "lookup" "Oracle"
7213 .cindex "InterBase lookup type"
7214 .cindex "lookup" "InterBase"
7215 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7216 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7217 option (as appropriate) must be set to a colon-separated list of server
7218 information.
7219 (For MySQL and PostgreSQL only, the global option need not be set if all
7220 queries contain their own server information &-- see section
7221 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7222 items: host name, database name, user name, and password. In the case of
7223 Oracle, the host name field is used for the &"service name"&, and the database
7224 name field is not used and should be empty. For example:
7225 .code
7226 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7227 .endd
7228 Because password data is sensitive, you should always precede the setting with
7229 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7230 option. Here is an example where two MySQL servers are listed:
7231 .code
7232 hide mysql_servers = localhost/users/root/secret:\
7233                      otherhost/users/root/othersecret
7234 .endd
7235 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7236 because this is a colon-separated list, the colon has to be doubled. For each
7237 query, these parameter groups are tried in order until a connection is made and
7238 a query is successfully processed. The result of a query may be that no data is
7239 found, but that is still a successful query. In other words, the list of
7240 servers provides a backup facility, not a list of different places to look.
7241
7242 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7243 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7244 respectively, and the characters single-quote, double-quote, and backslash
7245 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7246 addition, escapes the percent and underscore characters. This cannot be done
7247 for MySQL because these escapes are not recognized in contexts where these
7248 characters are not special.
7249
7250 .section "Specifying the server in the query" "SECTspeserque"
7251 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7252 it is possible to specify a list of servers with an individual query. This is
7253 done by starting the query with
7254 .display
7255 &`servers=`&&'server1:server2:server3:...'&&`;`&
7256 .endd
7257 Each item in the list may take one of two forms:
7258 .olist
7259 If it contains no slashes it is assumed to be just a host name. The appropriate
7260 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7261 of the same name, and the remaining parameters (database, user, password) are
7262 taken from there.
7263 .next
7264 If it contains any slashes, it is taken as a complete parameter set.
7265 .endlist
7266 The list of servers is used in exactly the same way as the global list.
7267 Once a connection to a server has happened and a query has been
7268 successfully executed, processing of the lookup ceases.
7269
7270 This feature is intended for use in master/slave situations where updates
7271 are occurring and you want to update the master rather than a slave. If the
7272 master is in the list as a backup for reading, you might have a global setting
7273 like this:
7274 .code
7275 mysql_servers = slave1/db/name/pw:\
7276                 slave2/db/name/pw:\
7277                 master/db/name/pw
7278 .endd
7279 In an updating lookup, you could then write:
7280 .code
7281 ${lookup mysql{servers=master; UPDATE ...} }
7282 .endd
7283 That query would then be sent only to the master server. If, on the other hand,
7284 the master is not to be used for reading, and so is not present in the global
7285 option, you can still update it by a query of this form:
7286 .code
7287 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7288 .endd
7289
7290
7291 .section "Special MySQL features" "SECID73"
7292 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7293 causes a connection to the server on the local host by means of a Unix domain
7294 socket. An alternate socket can be specified in parentheses. The full syntax of
7295 each item in &%mysql_servers%& is:
7296 .display
7297 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7298   <&'user'&>/<&'password'&>
7299 .endd
7300 Any of the three sub-parts of the first field can be omitted. For normal use on
7301 the local host it can be left blank or set to just &"localhost"&.
7302
7303 No database need be supplied &-- but if it is absent here, it must be given in
7304 the queries.
7305
7306 If a MySQL query is issued that does not request any data (an insert, update,
7307 or delete command), the result of the lookup is the number of rows affected.
7308
7309 &*Warning*&: This can be misleading. If an update does not actually change
7310 anything (for example, setting a field to the value it already has), the result
7311 is zero because no rows are affected.
7312
7313
7314 .section "Special PostgreSQL features" "SECID74"
7315 PostgreSQL lookups can also use Unix domain socket connections to the database.
7316 This is usually faster and costs less CPU time than a TCP/IP connection.
7317 However it can be used only if the mail server runs on the same machine as the
7318 database server. A configuration line for PostgreSQL via Unix domain sockets
7319 looks like this:
7320 .code
7321 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7322 .endd
7323 In other words, instead of supplying a host name, a path to the socket is
7324 given. The path name is enclosed in parentheses so that its slashes aren't
7325 visually confused with the delimiters for the other server parameters.
7326
7327 If a PostgreSQL query is issued that does not request any data (an insert,
7328 update, or delete command), the result of the lookup is the number of rows
7329 affected.
7330
7331 .section "More about SQLite" "SECTsqlite"
7332 .cindex "lookup" "SQLite"
7333 .cindex "sqlite lookup type"
7334 SQLite is different to the other SQL lookups because a file name is required in
7335 addition to the SQL query. An SQLite database is a single file, and there is no
7336 daemon as in the other SQL databases. The interface to Exim requires the name
7337 of the file, as an absolute path, to be given at the start of the query. It is
7338 separated from the query by white space. This means that the path name cannot
7339 contain white space. Here is a lookup expansion example:
7340 .code
7341 ${lookup sqlite {/some/thing/sqlitedb \
7342   select name from aliases where id='userx';}}
7343 .endd
7344 In a list, the syntax is similar. For example:
7345 .code
7346 domainlist relay_domains = sqlite;/some/thing/sqlitedb \
7347    select * from relays where ip='$sender_host_address';
7348 .endd
7349 The only character affected by the &%quote_sqlite%& operator is a single
7350 quote, which it doubles.
7351
7352 The SQLite library handles multiple simultaneous accesses to the database
7353 internally. Multiple readers are permitted, but only one process can
7354 update at once. Attempts to access the database while it is being updated
7355 are rejected after a timeout period, during which the SQLite library
7356 waits for the lock to be released. In Exim, the default timeout is set
7357 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7358 option.
7359 .ecindex IIDfidalo1
7360 .ecindex IIDfidalo2
7361
7362
7363 . ////////////////////////////////////////////////////////////////////////////
7364 . ////////////////////////////////////////////////////////////////////////////
7365
7366 .chapter "Domain, host, address, and local part lists" &&&
7367          "CHAPdomhosaddlists" &&&
7368          "Domain, host, and address lists"
7369 .scindex IIDdohoadli "lists of domains; hosts; etc."
7370 A number of Exim configuration options contain lists of domains, hosts,
7371 email addresses, or local parts. For example, the &%hold_domains%& option
7372 contains a list of domains whose delivery is currently suspended. These lists
7373 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7374 arguments to expansion conditions such as &%match_domain%&.
7375
7376 Each item in one of these lists is a pattern to be matched against a domain,
7377 host, email address, or local part, respectively. In the sections below, the
7378 different types of pattern for each case are described, but first we cover some
7379 general facilities that apply to all four kinds of list.
7380
7381
7382
7383 .section "Expansion of lists" "SECID75"
7384 .cindex "expansion" "of lists"
7385 Each list is expanded as a single string before it is used. The result of
7386 expansion must be a list, possibly containing empty items, which is split up
7387 into separate items for matching. By default, colon is the separator character,
7388 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7389 &<<SECTempitelis>>& for details of the list syntax; the second of these
7390 discusses the way to specify empty list items.
7391
7392
7393 If the string expansion is forced to fail, Exim behaves as if the item it is
7394 testing (domain, host, address, or local part) is not in the list. Other
7395 expansion failures cause temporary errors.
7396
7397 If an item in a list is a regular expression, backslashes, dollars and possibly
7398 other special characters in the expression must be protected against
7399 misinterpretation by the string expander. The easiest way to do this is to use
7400 the &`\N`& expansion feature to indicate that the contents of the regular
7401 expression should not be expanded. For example, in an ACL you might have:
7402 .code
7403 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7404                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7405 .endd
7406 The first item is a regular expression that is protected from expansion by
7407 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7408 senders based on the receiving domain.
7409
7410
7411
7412
7413 .section "Negated items in lists" "SECID76"
7414 .cindex "list" "negation"
7415 .cindex "negation" "in lists"
7416 Items in a list may be positive or negative. Negative items are indicated by a
7417 leading exclamation mark, which may be followed by optional white space. A list
7418 defines a set of items (domains, etc). When Exim processes one of these lists,
7419 it is trying to find out whether a domain, host, address, or local part
7420 (respectively) is in the set that is defined by the list. It works like this:
7421
7422 The list is scanned from left to right. If a positive item is matched, the
7423 subject that is being checked is in the set; if a negative item is matched, the
7424 subject is not in the set. If the end of the list is reached without the
7425 subject having matched any of the patterns, it is in the set if the last item
7426 was a negative one, but not if it was a positive one. For example, the list in
7427 .code
7428 domainlist relay_domains = !a.b.c : *.b.c
7429 .endd
7430 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7431 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7432 list is positive. However, if the setting were
7433 .code
7434 domainlist relay_domains = !a.b.c
7435 .endd
7436 then all domains other than &'a.b.c'& would match because the last item in the
7437 list is negative. In other words, a list that ends with a negative item behaves
7438 as if it had an extra item &`:*`& on the end.
7439
7440 Another way of thinking about positive and negative items in lists is to read
7441 the connector as &"or"& after a positive item and as &"and"& after a negative
7442 item.
7443
7444
7445
7446 .section "File names in lists" "SECTfilnamlis"
7447 .cindex "list" "file name in"
7448 If an item in a domain, host, address, or local part list is an absolute file
7449 name (beginning with a slash character), each line of the file is read and
7450 processed as if it were an independent item in the list, except that further
7451 file names are not allowed,
7452 and no expansion of the data from the file takes place.
7453 Empty lines in the file are ignored, and the file may also contain comment
7454 lines:
7455
7456 .ilist
7457 For domain and host lists, if a # character appears anywhere in a line of the
7458 file, it and all following characters are ignored.
7459 .next
7460 Because local parts may legitimately contain # characters, a comment in an
7461 address list or local part list file is recognized only if # is preceded by
7462 white space or the start of the line. For example:
7463 .code
7464 not#comment@x.y.z   # but this is a comment
7465 .endd
7466 .endlist
7467
7468 Putting a file name in a list has the same effect as inserting each line of the
7469 file as an item in the list (blank lines and comments excepted). However, there
7470 is one important difference: the file is read each time the list is processed,
7471 so if its contents vary over time, Exim's behaviour changes.
7472
7473 If a file name is preceded by an exclamation mark, the sense of any match
7474 within the file is inverted. For example, if
7475 .code
7476 hold_domains = !/etc/nohold-domains
7477 .endd
7478 and the file contains the lines
7479 .code
7480 !a.b.c
7481 *.b.c
7482 .endd
7483 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7484 any domain matching &`*.b.c`& is not.
7485
7486
7487
7488 .section "An lsearch file is not an out-of-line list" "SECID77"
7489 As will be described in the sections that follow, lookups can be used in lists
7490 to provide indexed methods of checking list membership. There has been some
7491 confusion about the way &(lsearch)& lookups work in lists. Because
7492 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7493 sometimes thought that it is allowed to contain wild cards and other kinds of
7494 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7495 always fixed strings, just as for any other single-key lookup type.
7496
7497 If you want to use a file to contain wild-card patterns that form part of a
7498 list, just give the file name on its own, without a search type, as described
7499 in the previous section. You could also use the &(wildlsearch)& or
7500 &(nwildlsearch)&, but there is no advantage in doing this.
7501
7502
7503
7504
7505 .section "Named lists" "SECTnamedlists"
7506 .cindex "named lists"
7507 .cindex "list" "named"
7508 A list of domains, hosts, email addresses, or local parts can be given a name
7509 which is then used to refer to the list elsewhere in the configuration. This is
7510 particularly convenient if the same list is required in several different
7511 places. It also allows lists to be given meaningful names, which can improve
7512 the readability of the configuration. For example, it is conventional to define
7513 a domain list called &'local_domains'& for all the domains that are handled
7514 locally on a host, using a configuration line such as
7515 .code
7516 domainlist local_domains = localhost:my.dom.example
7517 .endd
7518 Named lists are referenced by giving their name preceded by a plus sign, so,
7519 for example, a router that is intended to handle local domains would be
7520 configured with the line
7521 .code
7522 domains = +local_domains
7523 .endd
7524 The first router in a configuration is often one that handles all domains
7525 except the local ones, using a configuration with a negated item like this:
7526 .code
7527 dnslookup:
7528   driver = dnslookup
7529   domains = ! +local_domains
7530   transport = remote_smtp
7531   no_more
7532 .endd
7533 The four kinds of named list are created by configuration lines starting with
7534 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7535 respectively. Then there follows the name that you are defining, followed by an
7536 equals sign and the list itself. For example:
7537 .code
7538 hostlist    relay_hosts = 192.168.23.0/24 : my.friend.example
7539 addresslist bad_senders = cdb;/etc/badsenders
7540 .endd
7541 A named list may refer to other named lists:
7542 .code
7543 domainlist  dom1 = first.example : second.example
7544 domainlist  dom2 = +dom1 : third.example
7545 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7546 .endd
7547 &*Warning*&: If the last item in a referenced list is a negative one, the
7548 effect may not be what you intended, because the negation does not propagate
7549 out to the higher level. For example, consider:
7550 .code
7551 domainlist  dom1 = !a.b
7552 domainlist  dom2 = +dom1 : *.b
7553 .endd
7554 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7555 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7556 means it matches the second list as well. The effect is not the same as
7557 .code
7558 domainlist  dom2 = !a.b : *.b
7559 .endd
7560 where &'x.y'& does not match. It's best to avoid negation altogether in
7561 referenced lists if you can.
7562
7563 Named lists may have a performance advantage. When Exim is routing an
7564 address or checking an incoming message, it caches the result of tests on named
7565 lists. So, if you have a setting such as
7566 .code
7567 domains = +local_domains
7568 .endd
7569 on several of your routers
7570 or in several ACL statements,
7571 the actual test is done only for the first one. However, the caching works only
7572 if there are no expansions within the list itself or any sublists that it
7573 references. In other words, caching happens only for lists that are known to be
7574 the same each time they are referenced.
7575
7576 By default, there may be up to 16 named lists of each type. This limit can be
7577 extended by changing a compile-time variable. The use of domain and host lists
7578 is recommended for concepts such as local domains, relay domains, and relay
7579 hosts. The default configuration is set up like this.
7580
7581
7582
7583 .section "Named lists compared with macros" "SECID78"
7584 .cindex "list" "named compared with macro"
7585 .cindex "macro" "compared with named list"
7586 At first sight, named lists might seem to be no different from macros in the
7587 configuration file. However, macros are just textual substitutions. If you
7588 write
7589 .code
7590 ALIST = host1 : host2
7591 auth_advertise_hosts = !ALIST
7592 .endd
7593 it probably won't do what you want, because that is exactly the same as
7594 .code
7595 auth_advertise_hosts = !host1 : host2
7596 .endd
7597 Notice that the second host name is not negated. However, if you use a host
7598 list, and write
7599 .code
7600 hostlist alist = host1 : host2
7601 auth_advertise_hosts = ! +alist
7602 .endd
7603 the negation applies to the whole list, and so that is equivalent to
7604 .code
7605 auth_advertise_hosts = !host1 : !host2
7606 .endd
7607
7608
7609 .section "Named list caching" "SECID79"
7610 .cindex "list" "caching of named"
7611 .cindex "caching" "named lists"
7612 While processing a message, Exim caches the result of checking a named list if
7613 it is sure that the list is the same each time. In practice, this means that
7614 the cache operates only if the list contains no $ characters, which guarantees
7615 that it will not change when it is expanded. Sometimes, however, you may have
7616 an expanded list that you know will be the same each time within a given
7617 message. For example:
7618 .code
7619 domainlist special_domains = \
7620            ${lookup{$sender_host_address}cdb{/some/file}}
7621 .endd
7622 This provides a list of domains that depends only on the sending host's IP
7623 address. If this domain list is referenced a number of times (for example,
7624 in several ACL lines, or in several routers) the result of the check is not
7625 cached by default, because Exim does not know that it is going to be the
7626 same list each time.
7627
7628 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7629 cache the result anyway. For example:
7630 .code
7631 domainlist_cache special_domains = ${lookup{...
7632 .endd
7633 If you do this, you should be absolutely sure that caching is going to do
7634 the right thing in all cases. When in doubt, leave it out.
7635
7636
7637
7638 .section "Domain lists" "SECTdomainlist"
7639 .cindex "domain list" "patterns for"
7640 .cindex "list" "domain list"
7641 Domain lists contain patterns that are to be matched against a mail domain.
7642 The following types of item may appear in domain lists:
7643
7644 .ilist
7645 .cindex "primary host name"
7646 .cindex "host name" "matched in domain list"
7647 .oindex "&%primary_hostname%&"
7648 .cindex "domain list" "matching primary host name"
7649 .cindex "@ in a domain list"
7650 If a pattern consists of a single @ character, it matches the local host name,
7651 as set by the &%primary_hostname%& option (or defaulted). This makes it
7652 possible to use the same configuration file on several different hosts that
7653 differ only in their names.
7654 .next
7655 .cindex "@[] in a domain list"
7656 .cindex "domain list" "matching local IP interfaces"
7657 .cindex "domain literal"
7658 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7659 in square brackets (as in an email address that contains a domain literal), but
7660 only if that IP address is recognized as local for email routing purposes. The
7661 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7662 control which of a host's several IP addresses are treated as local.
7663 In today's Internet, the use of domain literals is controversial.
7664 .next
7665 .cindex "@mx_any"
7666 .cindex "@mx_primary"
7667 .cindex "@mx_secondary"
7668 .cindex "domain list" "matching MX pointers to local host"
7669 If a pattern consists of the string &`@mx_any`& it matches any domain that
7670 has an MX record pointing to the local host or to any host that is listed in
7671 .oindex "&%hosts_treat_as_local%&"
7672 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7673 are similar, except that the first matches only when a primary MX target is the
7674 local host, and the second only when no primary MX target is the local host,
7675 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7676 preference value &-- there may of course be more than one of them.
7677
7678 The MX lookup that takes place when matching a pattern of this type is
7679 performed with the resolver options for widening names turned off. Thus, for
7680 example, a single-component domain will &'not'& be expanded by adding the
7681 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7682 options of the &(dnslookup)& router for a discussion of domain widening.
7683
7684 Sometimes you may want to ignore certain IP addresses when using one of these
7685 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7686 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7687 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7688 on a router). For example:
7689 .code
7690 domains = @mx_any/ignore=127.0.0.1
7691 .endd
7692 This example matches any domain that has an MX record pointing to one of
7693 the local host's IP addresses other than 127.0.0.1.
7694
7695 The list of IP addresses is in fact processed by the same code that processes
7696 host lists, so it may contain CIDR-coded network specifications and it may also
7697 contain negative items.
7698
7699 Because the list of IP addresses is a sublist within a domain list, you have to
7700 be careful about delimiters if there is more than one address. Like any other
7701 list, the default delimiter can be changed. Thus, you might have:
7702 .code
7703 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7704           an.other.domain : ...
7705 .endd
7706 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7707 involved, it is easiest to change the delimiter for the main list as well:
7708 .code
7709 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7710           an.other.domain ? ...
7711 .endd
7712 .next
7713 .cindex "asterisk" "in domain list"
7714 .cindex "domain list" "asterisk in"
7715 .cindex "domain list" "matching &""ends with""&"
7716 If a pattern starts with an asterisk, the remaining characters of the pattern
7717 are compared with the terminating characters of the domain. The use of &"*"& in
7718 domain lists differs from its use in partial matching lookups. In a domain
7719 list, the character following the asterisk need not be a dot, whereas partial
7720 matching works only in terms of dot-separated components. For example, a domain
7721 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7722 &'cipher.key.ex'&.
7723
7724 .next
7725 .cindex "regular expressions" "in domain list"
7726 .cindex "domain list" "matching regular expression"
7727 If a pattern starts with a circumflex character, it is treated as a regular
7728 expression, and matched against the domain using a regular expression matching
7729 function. The circumflex is treated as part of the regular expression.
7730 Email domains are case-independent, so this regular expression match is by
7731 default case-independent, but you can make it case-dependent by starting it
7732 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7733 are given in chapter &<<CHAPregexp>>&.
7734
7735 &*Warning*&: Because domain lists are expanded before being processed, you
7736 must escape any backslash and dollar characters in the regular expression, or
7737 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7738 it is not to be expanded (unless you really do want to build a regular
7739 expression by expansion, of course).
7740 .next
7741 .cindex "lookup" "in domain list"
7742 .cindex "domain list" "matching by lookup"
7743 If a pattern starts with the name of a single-key lookup type followed by a
7744 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7745 must be a file name in a suitable format for the lookup type. For example, for
7746 &"cdb;"& it must be an absolute path:
7747 .code
7748 domains = cdb;/etc/mail/local_domains.cdb
7749 .endd
7750 The appropriate type of lookup is done on the file using the domain name as the
7751 key. In most cases, the data that is looked up is not used; Exim is interested
7752 only in whether or not the key is present in the file. However, when a lookup
7753 is used for the &%domains%& option on a router
7754 or a &%domains%& condition in an ACL statement, the data is preserved in the
7755 &$domain_data$& variable and can be referred to in other router options or
7756 other statements in the same ACL.
7757
7758 .next
7759 Any of the single-key lookup type names may be preceded by
7760 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7761 .code
7762 domains = partial-dbm;/partial/domains
7763 .endd
7764 This causes partial matching logic to be invoked; a description of how this
7765 works is given in section &<<SECTpartiallookup>>&.
7766
7767 .next
7768 .cindex "asterisk" "in lookup type"
7769 Any of the single-key lookup types may be followed by an asterisk. This causes
7770 a default lookup for a key consisting of a single asterisk to be done if the
7771 original lookup fails. This is not a useful feature when using a domain list to
7772 select particular domains (because any domain would match), but it might have
7773 value if the result of the lookup is being used via the &$domain_data$&
7774 expansion variable.
7775 .next
7776 If the pattern starts with the name of a query-style lookup type followed by a
7777 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7778 pattern must be an appropriate query for the lookup type, as described in
7779 chapter &<<CHAPfdlookup>>&. For example:
7780 .code
7781 hold_domains = mysql;select domain from holdlist \
7782   where domain = '${quote_mysql:$domain}';
7783 .endd
7784 In most cases, the data that is looked up is not used (so for an SQL query, for
7785 example, it doesn't matter what field you select). Exim is interested only in
7786 whether or not the query succeeds. However, when a lookup is used for the
7787 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7788 variable and can be referred to in other options.
7789 .next
7790 .cindex "domain list" "matching literal domain name"
7791 If none of the above cases apply, a caseless textual comparison is made
7792 between the pattern and the domain.
7793 .endlist
7794
7795 Here is an example that uses several different kinds of pattern:
7796 .code
7797 domainlist funny_domains = \
7798   @ : \
7799   lib.unseen.edu : \
7800   *.foundation.fict.example : \
7801   \N^[1-2]\d{3}\.fict\.example$\N : \
7802   partial-dbm;/opt/data/penguin/book : \
7803   nis;domains.byname : \
7804   nisplus;[name=$domain,status=local],domains.org_dir
7805 .endd
7806 There are obvious processing trade-offs among the various matching modes. Using
7807 an asterisk is faster than a regular expression, and listing a few names
7808 explicitly probably is too. The use of a file or database lookup is expensive,
7809 but may be the only option if hundreds of names are required. Because the
7810 patterns are tested in order, it makes sense to put the most commonly matched
7811 patterns earlier.
7812
7813
7814
7815 .section "Host lists" "SECThostlist"
7816 .cindex "host list" "patterns in"
7817 .cindex "list" "host list"
7818 Host lists are used to control what remote hosts are allowed to do. For
7819 example, some hosts may be allowed to use the local host as a relay, and some
7820 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7821 two different ways, by name or by IP address. In a host list, some types of
7822 pattern are matched to a host name, and some are matched to an IP address.
7823 You need to be particularly careful with this when single-key lookups are
7824 involved, to ensure that the right value is being used as the key.
7825
7826
7827 .section "Special host list patterns" "SECID80"
7828 .cindex "empty item in hosts list"
7829 .cindex "host list" "empty string in"
7830 If a host list item is the empty string, it matches only when no remote host is
7831 involved. This is the case when a message is being received from a local
7832 process using SMTP on the standard input, that is, when a TCP/IP connection is
7833 not used.
7834
7835 .cindex "asterisk" "in host list"
7836 The special pattern &"*"& in a host list matches any host or no host. Neither
7837 the IP address nor the name is actually inspected.
7838
7839
7840
7841 .section "Host list patterns that match by IP address" "SECThoslispatip"
7842 .cindex "host list" "matching IP addresses"
7843 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7844 the incoming address actually appears in the IPv6 host as
7845 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7846 list, it is converted into a traditional IPv4 address first. (Not all operating
7847 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7848 concerns.)
7849
7850 The following types of pattern in a host list check the remote host by
7851 inspecting its IP address:
7852
7853 .ilist
7854 If the pattern is a plain domain name (not a regular expression, not starting
7855 with *, not a lookup of any kind), Exim calls the operating system function
7856 to find the associated IP address(es). Exim uses the newer
7857 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
7858 This typically causes a forward DNS lookup of the name. The result is compared
7859 with the IP address of the subject host.
7860
7861 If there is a temporary problem (such as a DNS timeout) with the host name
7862 lookup, a temporary error occurs. For example, if the list is being used in an
7863 ACL condition, the ACL gives a &"defer"& response, usually leading to a
7864 temporary SMTP error code. If no IP address can be found for the host name,
7865 what happens is described in section &<<SECTbehipnot>>& below.
7866
7867 .next
7868 .cindex "@ in a host list"
7869 If the pattern is &"@"&, the primary host name is substituted and used as a
7870 domain name, as just described.
7871
7872 .next
7873 If the pattern is an IP address, it is matched against the IP address of the
7874 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
7875 IPv6 addresses can be given in colon-separated format, but the colons have to
7876 be doubled so as not to be taken as item separators when the default list
7877 separator is used. IPv6 addresses are recognized even when Exim is compiled
7878 without IPv6 support. This means that if they appear in a host list on an
7879 IPv4-only host, Exim will not treat them as host names. They are just addresses
7880 that can never match a client host.
7881
7882 .next
7883 .cindex "@[] in a host list"
7884 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
7885 the local host. For example, if the local host is an IPv4 host with one
7886 interface address 10.45.23.56, these two ACL statements have the same effect:
7887 .code
7888 accept hosts = 127.0.0.1 : 10.45.23.56
7889 accept hosts = @[]
7890 .endd
7891 .next
7892 .cindex "CIDR notation"
7893 If the pattern is an IP address followed by a slash and a mask length (for
7894 example 10.11.42.0/24), it is matched against the IP address of the subject
7895 host under the given mask. This allows, an entire network of hosts to be
7896 included (or excluded) by a single item. The mask uses CIDR notation; it
7897 specifies the number of address bits that must match, starting from the most
7898 significant end of the address.
7899
7900 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
7901 of a range of addresses. It is the number of bits in the network portion of the
7902 address. The above example specifies a 24-bit netmask, so it matches all 256
7903 addresses in the 10.11.42.0 network. An item such as
7904 .code
7905 192.168.23.236/31
7906 .endd
7907 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
7908 32 for an IPv4 address is the same as no mask at all; just a single address
7909 matches.
7910
7911 Here is another example which shows an IPv4 and an IPv6 network:
7912 .code
7913 recipient_unqualified_hosts = 192.168.0.0/16: \
7914                               3ffe::ffff::836f::::/48
7915 .endd
7916 The doubling of list separator characters applies only when these items
7917 appear inline in a host list. It is not required when indirecting via a file.
7918 For example:
7919 .code
7920 recipient_unqualified_hosts = /opt/exim/unqualnets
7921 .endd
7922 could make use of a file containing
7923 .code
7924 172.16.0.0/12
7925 3ffe:ffff:836f::/48
7926 .endd
7927 to have exactly the same effect as the previous example. When listing IPv6
7928 addresses inline, it is usually more convenient to use the facility for
7929 changing separator characters. This list contains the same two networks:
7930 .code
7931 recipient_unqualified_hosts = <; 172.16.0.0/12; \
7932                                  3ffe:ffff:836f::/48
7933 .endd
7934 The separator is changed to semicolon by the leading &"<;"& at the start of the
7935 list.
7936 .endlist
7937
7938
7939
7940 .section "Host list patterns for single-key lookups by host address" &&&
7941          "SECThoslispatsikey"
7942 .cindex "host list" "lookup of IP address"
7943 When a host is to be identified by a single-key lookup of its complete IP
7944 address, the pattern takes this form:
7945 .display
7946 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7947 .endd
7948 For example:
7949 .code
7950 hosts_lookup = net-cdb;/hosts-by-ip.db
7951 .endd
7952 The text form of the IP address of the subject host is used as the lookup key.
7953 IPv6 addresses are converted to an unabbreviated form, using lower case
7954 letters, with dots as separators because colon is the key terminator in
7955 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
7956 quoting the keys, but this is a facility that was added later.] The data
7957 returned by the lookup is not used.
7958
7959 .cindex "IP address" "masking"
7960 .cindex "host list" "masked IP address"
7961 Single-key lookups can also be performed using masked IP addresses, using
7962 patterns of this form:
7963 .display
7964 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7965 .endd
7966 For example:
7967 .code
7968 net24-dbm;/networks.db
7969 .endd
7970 The IP address of the subject host is masked using <&'number'&> as the mask
7971 length. A textual string is constructed from the masked value, followed by the
7972 mask, and this is used as the lookup key. For example, if the host's IP address
7973 is 192.168.34.6, the key that is looked up for the above example is
7974 &"192.168.34.0/24"&.
7975
7976 When an IPv6 address is converted to a string, dots are normally used instead
7977 of colons, so that keys in &(lsearch)& files need not contain colons (which
7978 terminate &(lsearch)& keys). This was implemented some time before the ability
7979 to quote keys was made available in &(lsearch)& files. However, the more
7980 recently implemented &(iplsearch)& files do require colons in IPv6 keys
7981 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
7982 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
7983 converted using colons and not dots. In all cases, full, unabbreviated IPv6
7984 addresses are always used.
7985
7986 Ideally, it would be nice to tidy up this anomalous situation by changing to
7987 colons in all cases, given that quoting is now available for &(lsearch)&.
7988 However, this would be an incompatible change that might break some existing
7989 configurations.
7990
7991 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
7992 IPv6 address) is not the same as specifying just &%net-%& without a number. In
7993 the former case the key strings include the mask value, whereas in the latter
7994 case the IP address is used on its own.
7995
7996
7997
7998 .section "Host list patterns that match by host name" "SECThoslispatnam"
7999 .cindex "host" "lookup failures"
8000 .cindex "unknown host name"
8001 .cindex "host list" "matching host name"
8002 There are several types of pattern that require Exim to know the name of the
8003 remote host. These are either wildcard patterns or lookups by name. (If a
8004 complete hostname is given without any wildcarding, it is used to find an IP
8005 address to match against, as described in the section &<<SECThoslispatip>>&
8006 above.)
8007
8008 If the remote host name is not already known when Exim encounters one of these
8009 patterns, it has to be found from the IP address.
8010 Although many sites on the Internet are conscientious about maintaining reverse
8011 DNS data for their hosts, there are also many that do not do this.
8012 Consequently, a name cannot always be found, and this may lead to unwanted
8013 effects. Take care when configuring host lists with wildcarded name patterns.
8014 Consider what will happen if a name cannot be found.
8015
8016 Because of the problems of determining host names from IP addresses, matching
8017 against host names is not as common as matching against IP addresses.
8018
8019 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8020 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8021 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8022 are done can be changed by setting the &%host_lookup_order%& option. For
8023 security, once Exim has found one or more names, it looks up the IP addresses
8024 for these names and compares them with the IP address that it started with.
8025 Only those names whose IP addresses match are accepted. Any other names are
8026 discarded. If no names are left, Exim behaves as if the host name cannot be
8027 found. In the most common case there is only one name and one IP address.
8028
8029 There are some options that control what happens if a host name cannot be
8030 found. These are described in section &<<SECTbehipnot>>& below.
8031
8032 .cindex "host" "alias for"
8033 .cindex "alias for host"
8034 As a result of aliasing, hosts may have more than one name. When processing any
8035 of the following types of pattern, all the host's names are checked:
8036
8037 .ilist
8038 .cindex "asterisk" "in host list"
8039 If a pattern starts with &"*"& the remainder of the item must match the end of
8040 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8041 &'.b.c'&. This special simple form is provided because this is a very common
8042 requirement. Other kinds of wildcarding require the use of a regular
8043 expression.
8044 .next
8045 .cindex "regular expressions" "in host list"
8046 .cindex "host list" "regular expression in"
8047 If the item starts with &"^"& it is taken to be a regular expression which is
8048 matched against the host name. Host names are case-independent, so this regular
8049 expression match is by default case-independent, but you can make it
8050 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8051 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8052 example,
8053 .code
8054 ^(a|b)\.c\.d$
8055 .endd
8056 is a regular expression that matches either of the two hosts &'a.c.d'& or
8057 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8058 that backslash and dollar characters are not misinterpreted as part of the
8059 string expansion. The simplest way to do this is to use &`\N`& to mark that
8060 part of the string as non-expandable. For example:
8061 .code
8062 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8063 .endd
8064 &*Warning*&: If you want to match a complete host name, you must include the
8065 &`$`& terminating metacharacter in the regular expression, as in the above
8066 example. Without it, a match at the start of the host name is all that is
8067 required.
8068 .endlist
8069
8070
8071
8072
8073 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8074 .cindex "host" "lookup failures, permanent"
8075 While processing a host list, Exim may need to look up an IP address from a
8076 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8077 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8078 behaviour when it fails to find the information it is seeking is the same.
8079
8080 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8081 apply to temporary DNS errors, whose handling is described in the next section.
8082
8083 .cindex "&`+include_unknown`&"
8084 .cindex "&`+ignore_unknown`&"
8085 By default, Exim behaves as if the host does not match the list. This may not
8086 always be what you want to happen. To change Exim's behaviour, the special
8087 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8088 top level &-- they are not recognized in an indirected file).
8089
8090 .ilist
8091 If any item that follows &`+include_unknown`& requires information that
8092 cannot found, Exim behaves as if the host does match the list. For example,
8093 .code
8094 host_reject_connection = +include_unknown:*.enemy.ex
8095 .endd
8096 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8097 any hosts whose name it cannot find.
8098
8099 .next
8100 If any item that follows &`+ignore_unknown`& requires information that cannot
8101 be found, Exim ignores that item and proceeds to the rest of the list. For
8102 example:
8103 .code
8104 accept hosts = +ignore_unknown : friend.example : \
8105                192.168.4.5
8106 .endd
8107 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8108 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8109 name can be found for 192.168.4.5, it is rejected.
8110 .endlist
8111
8112 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8113 list. The effect of each one lasts until the next, or until the end of the
8114 list.
8115
8116
8117 .section "Temporary DNS errors when looking up host information" &&&
8118          "SECTtemdnserr"
8119 .cindex "host" "lookup failures, temporary"
8120 .cindex "&`+include_defer`&"
8121 .cindex "&`+ignore_defer`&"
8122 A temporary DNS lookup failure normally causes a defer action (except when
8123 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8124 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8125 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8126 section. These options should be used with care, probably only in non-critical
8127 host lists such as whitelists.
8128
8129
8130
8131 .section "Host list patterns for single-key lookups by host name" &&&
8132          "SECThoslispatnamsk"
8133 .cindex "unknown host name"
8134 .cindex "host list" "matching host name"
8135 If a pattern is of the form
8136 .display
8137 <&'single-key-search-type'&>;<&'search-data'&>
8138 .endd
8139 for example
8140 .code
8141 dbm;/host/accept/list
8142 .endd
8143 a single-key lookup is performed, using the host name as its key. If the
8144 lookup succeeds, the host matches the item. The actual data that is looked up
8145 is not used.
8146
8147 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8148 keys in the file, not IP addresses. If you want to do lookups based on IP
8149 addresses, you must precede the search type with &"net-"& (see section
8150 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8151 two items in the same list, one doing an address lookup and one doing a name
8152 lookup, both using the same file.
8153
8154
8155
8156 .section "Host list patterns for query-style lookups" "SECID81"
8157 If a pattern is of the form
8158 .display
8159 <&'query-style-search-type'&>;<&'query'&>
8160 .endd
8161 the query is obeyed, and if it succeeds, the host matches the item. The actual
8162 data that is looked up is not used. The variables &$sender_host_address$& and
8163 &$sender_host_name$& can be used in the query. For example:
8164 .code
8165 hosts_lookup = pgsql;\
8166   select ip from hostlist where ip='$sender_host_address'
8167 .endd
8168 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8169 can use the &%sg%& expansion item to change this if you need to. If you want to
8170 use masked IP addresses in database queries, you can use the &%mask%& expansion
8171 operator.
8172
8173 If the query contains a reference to &$sender_host_name$&, Exim automatically
8174 looks up the host name if has not already done so. (See section
8175 &<<SECThoslispatnam>>& for comments on finding host names.)
8176
8177 Historical note: prior to release 4.30, Exim would always attempt to find a
8178 host name before running the query, unless the search type was preceded by
8179 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8180 still recognized for query-style lookups, but its presence or absence has no
8181 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8182 See section &<<SECThoslispatsikey>>&.)
8183
8184
8185
8186 .section "Mixing wildcarded host names and addresses in host lists" &&&
8187          "SECTmixwilhos"
8188 .cindex "host list" "mixing names and addresses in"
8189 If you have name lookups or wildcarded host names and IP addresses in the same
8190 host list, you should normally put the IP addresses first. For example, in an
8191 ACL you could have:
8192 .code
8193 accept hosts = 10.9.8.7 : *.friend.example
8194 .endd
8195 The reason for this lies in the left-to-right way that Exim processes lists.
8196 It can test IP addresses without doing any DNS lookups, but when it reaches an
8197 item that requires a host name, it fails if it cannot find a host name to
8198 compare with the pattern. If the above list is given in the opposite order, the
8199 &%accept%& statement fails for a host whose name cannot be found, even if its
8200 IP address is 10.9.8.7.
8201
8202 If you really do want to do the name check first, and still recognize the IP
8203 address, you can rewrite the ACL like this:
8204 .code
8205 accept hosts = *.friend.example
8206 accept hosts = 10.9.8.7
8207 .endd
8208 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8209 &<<CHAPACL>>& for details of ACLs.
8210
8211
8212
8213
8214
8215 .section "Address lists" "SECTaddresslist"
8216 .cindex "list" "address list"
8217 .cindex "address list" "empty item"
8218 .cindex "address list" "patterns"
8219 Address lists contain patterns that are matched against mail addresses. There
8220 is one special case to be considered: the sender address of a bounce message is
8221 always empty. You can test for this by providing an empty item in an address
8222 list. For example, you can set up a router to process bounce messages by
8223 using this option setting:
8224 .code
8225 senders = :
8226 .endd
8227 The presence of the colon creates an empty item. If you do not provide any
8228 data, the list is empty and matches nothing. The empty sender can also be
8229 detected by a regular expression that matches an empty string,
8230 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8231
8232 Non-empty items in an address list can be straightforward email addresses. For
8233 example:
8234 .code
8235 senders = jbc@askone.example : hs@anacreon.example
8236 .endd
8237 A certain amount of wildcarding is permitted. If a pattern contains an @
8238 character, but is not a regular expression and does not begin with a
8239 semicolon-terminated lookup type (described below), the local part of the
8240 subject address is compared with the local part of the pattern, which may start
8241 with an asterisk. If the local parts match, the domain is checked in exactly
8242 the same way as for a pattern in a domain list. For example, the domain can be
8243 wildcarded, refer to a named list, or be a lookup:
8244 .code
8245 deny senders = *@*.spamming.site:\
8246                *@+hostile_domains:\
8247                bozo@partial-lsearch;/list/of/dodgy/sites:\
8248                *@dbm;/bad/domains.db
8249 .endd
8250 .cindex "local part" "starting with !"
8251 .cindex "address list" "local part starting with !"
8252 If a local part that begins with an exclamation mark is required, it has to be
8253 specified using a regular expression, because otherwise the exclamation mark is
8254 treated as a sign of negation, as is standard in lists.
8255
8256 If a non-empty pattern that is not a regular expression or a lookup does not
8257 contain an @ character, it is matched against the domain part of the subject
8258 address. The only two formats that are recognized this way are a literal
8259 domain, or a domain pattern that starts with *. In both these cases, the effect
8260 is the same as if &`*@`& preceded the pattern. For example:
8261 .code
8262 deny senders = enemy.domain : *.enemy.domain
8263 .endd
8264
8265 The following kinds of more complicated address list pattern can match any
8266 address, including the empty address that is characteristic of bounce message
8267 senders:
8268
8269 .ilist
8270 .cindex "regular expressions" "in address list"
8271 .cindex "address list" "regular expression in"
8272 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8273 done against the complete address, with the pattern as the regular expression.
8274 You must take care that backslash and dollar characters are not misinterpreted
8275 as part of the string expansion. The simplest way to do this is to use &`\N`&
8276 to mark that part of the string as non-expandable. For example:
8277 .code
8278 deny senders = \N^.*this.*@example\.com$\N : \
8279                \N^\d{8}.+@spamhaus.example$\N : ...
8280 .endd
8281 The &`\N`& sequences are removed by the expansion, so these items do indeed
8282 start with &"^"& by the time they are being interpreted as address patterns.
8283
8284 .next
8285 .cindex "address list" "lookup for complete address"
8286 Complete addresses can be looked up by using a pattern that starts with a
8287 lookup type terminated by a semicolon, followed by the data for the lookup. For
8288 example:
8289 .code
8290 deny senders = cdb;/etc/blocked.senders : \
8291   mysql;select address from blocked where \
8292   address='${quote_mysql:$sender_address}'
8293 .endd
8294 Both query-style and single-key lookup types can be used. For a single-key
8295 lookup type, Exim uses the complete address as the key. However, empty keys are
8296 not supported for single-key lookups, so a match against the empty address
8297 always fails. This restriction does not apply to query-style lookups.
8298
8299 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8300 cannot be used, and is ignored if specified, with an entry being written to the
8301 panic log.
8302 .cindex "*@ with single-key lookup"
8303 However, you can configure lookup defaults, as described in section
8304 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8305 default. For example, with this lookup:
8306 .code
8307 accept senders = lsearch*@;/some/file
8308 .endd
8309 the file could contains lines like this:
8310 .code
8311 user1@domain1.example
8312 *@domain2.example
8313 .endd
8314 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8315 that are tried is:
8316 .code
8317 nimrod@jaeger.example
8318 *@jaeger.example
8319 *
8320 .endd
8321 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8322 would mean that every address matches, thus rendering the test useless.
8323
8324 &*Warning 2*&: Do not confuse these two kinds of item:
8325 .code
8326 deny recipients = dbm*@;/some/file
8327 deny recipients = *@dbm;/some/file
8328 .endd
8329 The first does a whole address lookup, with defaulting, as just described,
8330 because it starts with a lookup type. The second matches the local part and
8331 domain independently, as described in a bullet point below.
8332 .endlist
8333
8334
8335 The following kinds of address list pattern can match only non-empty addresses.
8336 If the subject address is empty, a match against any of these pattern types
8337 always fails.
8338
8339
8340 .ilist
8341 .cindex "@@ with single-key lookup"
8342 .cindex "address list" "@@ lookup type"
8343 .cindex "address list" "split local part and domain"
8344 If a pattern starts with &"@@"& followed by a single-key lookup item
8345 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8346 split into a local part and a domain. The domain is looked up in the file. If
8347 it is not found, there is no match. If it is found, the data that is looked up
8348 from the file is treated as a colon-separated list of local part patterns, each
8349 of which is matched against the subject local part in turn.
8350
8351 .cindex "asterisk" "in address list"
8352 The lookup may be a partial one, and/or one involving a search for a default
8353 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8354 patterns that are looked up can be regular expressions or begin with &"*"&, or
8355 even be further lookups. They may also be independently negated. For example,
8356 with
8357 .code
8358 deny senders = @@dbm;/etc/reject-by-domain
8359 .endd
8360 the data from which the DBM file is built could contain lines like
8361 .code
8362 baddomain.com:  !postmaster : *
8363 .endd
8364 to reject all senders except &%postmaster%& from that domain.
8365
8366 .cindex "local part" "starting with !"
8367 If a local part that actually begins with an exclamation mark is required, it
8368 has to be specified using a regular expression. In &(lsearch)& files, an entry
8369 may be split over several lines by indenting the second and subsequent lines,
8370 but the separating colon must still be included at line breaks. White space
8371 surrounding the colons is ignored. For example:
8372 .code
8373 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8374 spammer3 : spammer4
8375 .endd
8376 As in all colon-separated lists in Exim, a colon can be included in an item by
8377 doubling.
8378
8379 If the last item in the list starts with a right angle-bracket, the remainder
8380 of the item is taken as a new key to look up in order to obtain a continuation
8381 list of local parts. The new key can be any sequence of characters. Thus one
8382 might have entries like
8383 .code
8384 aol.com: spammer1 : spammer 2 : >*
8385 xyz.com: spammer3 : >*
8386 *:       ^\d{8}$
8387 .endd
8388 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8389 local parts for all domains, in addition to the specific local parts listed for
8390 each domain. Of course, using this feature costs another lookup each time a
8391 chain is followed, but the effort needed to maintain the data is reduced.
8392
8393 .cindex "loop" "in lookups"
8394 It is possible to construct loops using this facility, and in order to catch
8395 them, the chains may be no more than fifty items long.
8396
8397 .next
8398 The @@<&'lookup'&> style of item can also be used with a query-style
8399 lookup, but in this case, the chaining facility is not available. The lookup
8400 can only return a single list of local parts.
8401 .endlist
8402
8403 &*Warning*&: There is an important difference between the address list items
8404 in these two examples:
8405 .code
8406 senders = +my_list
8407 senders = *@+my_list
8408 .endd
8409 In the first one, &`my_list`& is a named address list, whereas in the second
8410 example it is a named domain list.
8411
8412
8413
8414
8415 .section "Case of letters in address lists" "SECTcasletadd"
8416 .cindex "case of local parts"
8417 .cindex "address list" "case forcing"
8418 .cindex "case forcing in address lists"
8419 Domains in email addresses are always handled caselessly, but for local parts
8420 case may be significant on some systems (see &%caseful_local_part%& for how
8421 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8422 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8423 blocking lists should be done in a case-independent manner. Since most address
8424 lists in Exim are used for this kind of control, Exim attempts to do this by
8425 default.
8426
8427 The domain portion of an address is always lowercased before matching it to an
8428 address list. The local part is lowercased by default, and any string
8429 comparisons that take place are done caselessly. This means that the data in
8430 the address list itself, in files included as plain file names, and in any file
8431 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8432 keys in files that are looked up by a search type other than &(lsearch)& (which
8433 works caselessly) must be in lower case, because these lookups are not
8434 case-independent.
8435
8436 .cindex "&`+caseful`&"
8437 To allow for the possibility of caseful address list matching, if an item in
8438 an address list is the string &"+caseful"&, the original case of the local
8439 part is restored for any comparisons that follow, and string comparisons are no
8440 longer case-independent. This does not affect the domain, which remains in
8441 lower case. However, although independent matches on the domain alone are still
8442 performed caselessly, regular expressions that match against an entire address
8443 become case-sensitive after &"+caseful"& has been seen.
8444
8445
8446
8447 .section "Local part lists" "SECTlocparlis"
8448 .cindex "list" "local part list"
8449 .cindex "local part" "list"
8450 Case-sensitivity in local part lists is handled in the same way as for address
8451 lists, as just described. The &"+caseful"& item can be used if required. In a
8452 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8453 set false, the subject is lowercased and the matching is initially
8454 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8455 matching in the local part list, but not elsewhere in the router. If
8456 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8457 option is case-sensitive from the start.
8458
8459 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8460 comments are handled in the same way as address lists &-- they are recognized
8461 only if the # is preceded by white space or the start of the line.
8462 Otherwise, local part lists are matched in the same way as domain lists, except
8463 that the special items that refer to the local host (&`@`&, &`@[]`&,
8464 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8465 Refer to section &<<SECTdomainlist>>& for details of the other available item
8466 types.
8467 .ecindex IIDdohoadli
8468
8469
8470
8471
8472 . ////////////////////////////////////////////////////////////////////////////
8473 . ////////////////////////////////////////////////////////////////////////////
8474
8475 .chapter "String expansions" "CHAPexpand"
8476 .scindex IIDstrexp "expansion" "of strings"
8477 Many strings in Exim's run time configuration are expanded before use. Some of
8478 them are expanded every time they are used; others are expanded only once.
8479
8480 When a string is being expanded it is copied verbatim from left to right except
8481 when a dollar or backslash character is encountered. A dollar specifies the
8482 start of a portion of the string that is interpreted and replaced as described
8483 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8484 escape character, as described in the following section.
8485
8486
8487
8488 .section "Literal text in expanded strings" "SECTlittext"
8489 .cindex "expansion" "including literal text"
8490 An uninterpreted dollar can be included in an expanded string by putting a
8491 backslash in front of it. A backslash can be used to prevent any special
8492 character being treated specially in an expansion, including backslash itself.
8493 If the string appears in quotes in the configuration file, two backslashes are
8494 required because the quotes themselves cause interpretation of backslashes when
8495 the string is read in (see section &<<SECTstrings>>&).
8496
8497 .cindex "expansion" "non-expandable substrings"
8498 A portion of the string can specified as non-expandable by placing it between
8499 two occurrences of &`\N`&. This is particularly useful for protecting regular
8500 expressions, which often contain backslashes and dollar signs. For example:
8501 .code
8502 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8503 .endd
8504 On encountering the first &`\N`&, the expander copies subsequent characters
8505 without interpretation until it reaches the next &`\N`& or the end of the
8506 string.
8507
8508
8509
8510 .section "Character escape sequences in expanded strings" "SECID82"
8511 .cindex "expansion" "escape sequences"
8512 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8513 expanded string is recognized as an escape sequence for the character newline,
8514 carriage return, or tab, respectively. A backslash followed by up to three
8515 octal digits is recognized as an octal encoding for a single character, and a
8516 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8517 encoding.
8518
8519 These escape sequences are also recognized in quoted strings when they are read
8520 in. Their interpretation in expansions as well is useful for unquoted strings,
8521 and for other cases such as looked-up strings that are then expanded.
8522
8523
8524 .section "Testing string expansions" "SECID83"
8525 .cindex "expansion" "testing"
8526 .cindex "testing" "string expansion"
8527 .oindex "&%-be%&"
8528 Many expansions can be tested by calling Exim with the &%-be%& option. This
8529 takes the command arguments, or lines from the standard input if there are no
8530 arguments, runs them through the string expansion code, and writes the results
8531 to the standard output. Variables based on configuration values are set up, but
8532 since no message is being processed, variables such as &$local_part$& have no
8533 value. Nevertheless the &%-be%& option can be useful for checking out file and
8534 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8535 and &%nhash%&.
8536
8537 Exim gives up its root privilege when it is called with the &%-be%& option, and
8538 instead runs under the uid and gid it was called with, to prevent users from
8539 using &%-be%& for reading files to which they do not have access.
8540
8541 .oindex "&%-bem%&"
8542 If you want to test expansions that include variables whose values are taken
8543 from a message, there are two other options that can be used. The &%-bem%&
8544 option is like &%-be%& except that it is followed by a file name. The file is
8545 read as a message before doing the test expansions. For example:
8546 .code
8547 exim -bem /tmp/test.message '$h_subject:'
8548 .endd
8549 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8550 Exim message identifier. For example:
8551 .code
8552 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8553 .endd
8554 This loads the message from Exim's spool before doing the test expansions, and
8555 is therefore restricted to admin users.
8556
8557
8558 .section "Forced expansion failure" "SECTforexpfai"
8559 .cindex "expansion" "forced failure"
8560 A number of expansions that are described in the following section have
8561 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8562 (which are sometimes called &"curly brackets"&). Which of the two strings is
8563 used depends on some condition that is evaluated as part of the expansion. If,
8564 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8565 the entire string expansion fails in a way that can be detected by the code
8566 that requested the expansion. This is called &"forced expansion failure"&, and
8567 its consequences depend on the circumstances. In some cases it is no different
8568 from any other expansion failure, but in others a different action may be
8569 taken. Such variations are mentioned in the documentation of the option that is
8570 being expanded.
8571
8572
8573
8574
8575 .section "Expansion items" "SECTexpansionitems"
8576 The following items are recognized in expanded strings. White space may be used
8577 between sub-items that are keywords or substrings enclosed in braces inside an
8578 outer set of braces, to improve readability. &*Warning*&: Within braces,
8579 white space is significant.
8580
8581 .vlist
8582 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8583 .cindex "expansion" "variables"
8584 Substitute the contents of the named variable, for example:
8585 .code
8586 $local_part
8587 ${domain}
8588 .endd
8589 The second form can be used to separate the name from subsequent alphanumeric
8590 characters. This form (using braces) is available only for variables; it does
8591 &'not'& apply to message headers. The names of the variables are given in
8592 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8593 given, the expansion fails.
8594
8595 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8596 .cindex "expansion" "operators"
8597 The string is first itself expanded, and then the operation specified by
8598 <&'op'&> is applied to it. For example:
8599 .code
8600 ${lc:$local_part}
8601 .endd
8602 The string starts with the first character after the colon, which may be
8603 leading white space. A list of operators is given in section &<<SECTexpop>>&
8604 below. The operator notation is used for simple expansion items that have just
8605 one argument, because it reduces the number of braces and therefore makes the
8606 string easier to understand.
8607
8608 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8609 This item inserts &"basic"& header lines. It is described with the &%header%&
8610 expansion item below.
8611
8612 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8613        {*&<&'arg'&>&*}...}*&"
8614 .cindex &%dlfunc%&
8615 This expansion dynamically loads and then calls a locally-written C function.
8616 This functionality is available only if Exim is compiled with
8617 .code
8618 EXPAND_DLFUNC=yes
8619 .endd
8620 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8621 object so that it doesn't reload the same object file in the same Exim process
8622 (but of course Exim does start new processes frequently).
8623
8624 There may be from zero to eight arguments to the function. When compiling
8625 a local function that is to be called in this way, &_local_scan.h_& should be
8626 included. The Exim variables and functions that are defined by that API
8627 are also available for dynamically loaded functions. The function itself
8628 must have the following type:
8629 .code
8630 int dlfunction(uschar **yield, int argc, uschar *argv[])
8631 .endd
8632 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8633 function should return one of the following values:
8634
8635 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8636 into the expanded string that is being built.
8637
8638 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8639 from &'yield'&, if it is set.
8640
8641 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8642 taken from &'yield'& if it is set.
8643
8644 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8645
8646 When compiling a function that is to be used in this way with gcc,
8647 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8648 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8649
8650 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8651        {*&<&'string3'&>&*}}*&"
8652 .cindex "expansion" "extracting substrings by key"
8653 .cindex "&%extract%&" "substrings by key"
8654 The key and <&'string1'&> are first expanded separately. Leading and trailing
8655 white space is removed from the key (but not from any of the strings). The key
8656 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8657 form:
8658 .display
8659 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8660 .endd
8661 .vindex "&$value$&"
8662 where the equals signs and spaces (but not both) are optional. If any of the
8663 values contain white space, they must be enclosed in double quotes, and any
8664 values that are enclosed in double quotes are subject to escape processing as
8665 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8666 for the value that corresponds to the key. The search is case-insensitive. If
8667 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8668 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8669 variable &$value$& contains the value that has been extracted. Afterwards, it
8670 is restored to any previous value it might have had.
8671
8672 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8673 key is not found. If {<&'string2'&>} is also omitted, the value that was
8674 extracted is used. Thus, for example, these two expansions are identical, and
8675 yield &"2001"&:
8676 .code
8677 ${extract{gid}{uid=1984 gid=2001}}
8678 ${extract{gid}{uid=1984 gid=2001}{$value}}
8679 .endd
8680 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8681 appear, for example:
8682 .code
8683 ${extract{Z}{A=... B=...}{$value} fail }
8684 .endd
8685 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8686 {<&'string2'&>} must be present for &"fail"& to be recognized.
8687
8688
8689 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8690         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8691 .cindex "expansion" "extracting substrings by number"
8692 .cindex "&%extract%&" "substrings by number"
8693 The <&'number'&> argument must consist entirely of decimal digits,
8694 apart from leading and trailing white space, which is ignored.
8695 This is what distinguishes this form of &%extract%& from the previous kind. It
8696 behaves in the same way, except that, instead of extracting a named field, it
8697 extracts from <&'string1'&> the field whose number is given as the first
8698 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8699 <&'string3'&> as before.
8700
8701 The fields in the string are separated by any one of the characters in the
8702 separator string. These may include space or tab characters.
8703 The first field is numbered one. If the number is negative, the fields are
8704 counted from the end of the string, with the rightmost one numbered -1. If the
8705 number given is zero, the entire string is returned. If the modulus of the
8706 number is greater than the number of fields in the string, the result is the
8707 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8708 provided. For example:
8709 .code
8710 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8711 .endd
8712 yields &"42"&, and
8713 .code
8714 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8715 .endd
8716 yields &"99"&. Two successive separators mean that the field between them is
8717 empty (for example, the fifth field above).
8718
8719
8720 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8721 .cindex "list" "selecting by condition"
8722 .cindex "expansion" "selecting from list by condition"
8723 .vindex "&$item$&"
8724 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8725 default, but the separator can be changed in the usual way. For each item
8726 in this list, its value is place in &$item$&, and then the condition is
8727 evaluated. If the condition is true, &$item$& is added to the output as an
8728 item in a new list; if the condition is false, the item is discarded. The
8729 separator used for the output list is the same as the one used for the
8730 input, but a separator setting is not included in the output. For example:
8731 .code
8732 ${filter{a:b:c}{!eq{$item}{b}}
8733 .endd
8734 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8735 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8736
8737
8738 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8739 .cindex "hash function" "textual"
8740 .cindex "expansion" "textual hash"
8741 This is a textual hashing function, and was the first to be implemented in
8742 early versions of Exim. In current releases, there are other hashing functions
8743 (numeric, MD5, and SHA-1), which are described below.
8744
8745 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8746 <&'n'&>. If you are using fixed values for these numbers, that is, if
8747 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8748 use the simpler operator notation that avoids some of the braces:
8749 .code
8750 ${hash_<n>_<m>:<string>}
8751 .endd
8752 The second number is optional (in both notations). If <&'n'&> is greater than
8753 or equal to the length of the string, the expansion item returns the string.
8754 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8755 function to the string. The new string consists of characters taken from the
8756 first <&'m'&> characters of the string
8757 .code
8758 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8759 .endd
8760 If <&'m'&> is not present the value 26 is used, so that only lower case
8761 letters appear. For example:
8762 .display
8763 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8764 &`$hash{5}{monty}}           `&   yields  &`monty`&
8765 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8766 .endd
8767
8768 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8769         &*$h_*&<&'header&~name'&>&*:*&" &&&
8770        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8771         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8772        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8773         &*$rh_*&<&'header&~name'&>&*:*&"
8774 .cindex "expansion" "header insertion"
8775 .vindex "&$header_$&"
8776 .vindex "&$bheader_$&"
8777 .vindex "&$rheader_$&"
8778 .cindex "header lines" "in expansion strings"
8779 .cindex "header lines" "character sets"
8780 .cindex "header lines" "decoding"
8781 Substitute the contents of the named message header line, for example
8782 .code
8783 $header_reply-to:
8784 .endd
8785 The newline that terminates a header line is not included in the expansion, but
8786 internal newlines (caused by splitting the header line over several physical
8787 lines) may be present.
8788
8789 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8790 the data in the header line is interpreted.
8791
8792 .ilist
8793 .cindex "white space" "in header lines"
8794 &%rheader%& gives the original &"raw"& content of the header line, with no
8795 processing at all, and without the removal of leading and trailing white space.
8796
8797 .next
8798 .cindex "base64 encoding" "in header lines"
8799 &%bheader%& removes leading and trailing white space, and then decodes base64
8800 or quoted-printable MIME &"words"& within the header text, but does no
8801 character set translation. If decoding of what looks superficially like a MIME
8802 &"word"& fails, the raw string is returned. If decoding
8803 .cindex "binary zero" "in header line"
8804 produces a binary zero character, it is replaced by a question mark &-- this is
8805 what Exim does for binary zeros that are actually received in header lines.
8806
8807 .next
8808 &%header%& tries to translate the string as decoded by &%bheader%& to a
8809 standard character set. This is an attempt to produce the same string as would
8810 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8811 returned. Translation is attempted only on operating systems that support the
8812 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8813 a system Makefile or in &_Local/Makefile_&.
8814 .endlist ilist
8815
8816 In a filter file, the target character set for &%header%& can be specified by a
8817 command of the following form:
8818 .code
8819 headers charset "UTF-8"
8820 .endd
8821 This command affects all references to &$h_$& (or &$header_$&) expansions in
8822 subsequently obeyed filter commands. In the absence of this command, the target
8823 character set in a filter is taken from the setting of the &%headers_charset%&
8824 option in the runtime configuration. The value of this option defaults to the
8825 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8826 ISO-8859-1.
8827
8828 Header names follow the syntax of RFC 2822, which states that they may contain
8829 any printing characters except space and colon. Consequently, curly brackets
8830 &'do not'& terminate header names, and should not be used to enclose them as
8831 if they were variables. Attempting to do so causes a syntax error.
8832
8833 Only header lines that are common to all copies of a message are visible to
8834 this mechanism. These are the original header lines that are received with the
8835 message, and any that are added by an ACL statement or by a system
8836 filter. Header lines that are added to a particular copy of a message by a
8837 router or transport are not accessible.
8838
8839 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
8840 before the DATA ACL, because the header structure is not set up until the
8841 message is received. Header lines that are added in a RCPT ACL (for example)
8842 are saved until the message's incoming header lines are available, at which
8843 point they are added. When a DATA ACL is running, however, header lines added
8844 by earlier ACLs are visible.
8845
8846 Upper case and lower case letters are synonymous in header names. If the
8847 following character is white space, the terminating colon may be omitted, but
8848 this is not recommended, because you may then forget it when it is needed. When
8849 white space terminates the header name, it is included in the expanded string.
8850 If the message does not contain the given header, the expansion item is
8851 replaced by an empty string. (See the &%def%& condition in section
8852 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
8853
8854 If there is more than one header with the same name, they are all concatenated
8855 to form the substitution string, up to a maximum length of 64K. Unless
8856 &%rheader%& is being used, leading and trailing white space is removed from
8857 each header before concatenation, and a completely empty header is ignored. A
8858 newline character is then inserted between non-empty headers, but there is no
8859 newline at the very end. For the &%header%& and &%bheader%& expansion, for
8860 those headers that contain lists of addresses, a comma is also inserted at the
8861 junctions between headers. This does not happen for the &%rheader%& expansion.
8862
8863
8864 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
8865 .cindex "expansion" "hmac hashing"
8866 .cindex &%hmac%&
8867 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
8868 shared secret and some text into a message authentication code, as specified in
8869 RFC 2104. This differs from &`${md5:secret_text...}`& or
8870 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
8871 cryptographic hash, allowing for authentication that is not possible with MD5
8872 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
8873 present. For example:
8874 .code
8875 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
8876 .endd
8877 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
8878 produces:
8879 .code
8880 dd97e3ba5d1a61b5006108f8c8252953
8881 .endd
8882 As an example of how this might be used, you might put in the main part of
8883 an Exim configuration:
8884 .code
8885 SPAMSCAN_SECRET=cohgheeLei2thahw
8886 .endd
8887 In a router or a transport you could then have:
8888 .code
8889 headers_add = \
8890   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
8891   ${hmac{md5}{SPAMSCAN_SECRET}\
8892   {${primary_hostname},${message_exim_id},$h_message-id:}}
8893 .endd
8894 Then given a message, you can check where it was scanned by looking at the
8895 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
8896 this header line is authentic by recomputing the authentication code from the
8897 host name, message ID and the &'Message-id:'& header line. This can be done
8898 using Exim's &%-be%& option, or by other means, for example by using the
8899 &'hmac_md5_hex()'& function in Perl.
8900
8901
8902 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8903 .cindex "expansion" "conditional"
8904 .cindex "&%if%&, expansion item"
8905 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
8906 item; otherwise <&'string2'&> is used. The available conditions are described
8907 in section &<<SECTexpcond>>& below. For example:
8908 .code
8909 ${if eq {$local_part}{postmaster} {yes}{no} }
8910 .endd
8911 The second string need not be present; if it is not and the condition is not
8912 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
8913 be present instead of the second string (without any curly brackets). In this
8914 case, the expansion is forced to fail if the condition is not true (see section
8915 &<<SECTforexpfai>>&).
8916
8917 If both strings are omitted, the result is the string &`true`& if the condition
8918 is true, and the empty string if the condition is false. This makes it less
8919 cumbersome to write custom ACL and router conditions. For example, instead of
8920 .code
8921 condition = ${if >{$acl_m4}{3}{true}{false}}
8922 .endd
8923 you can use
8924 .code
8925 condition = ${if >{$acl_m4}{3}}
8926 .endd
8927
8928 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8929 .cindex "expansion" "string truncation"
8930 .cindex "&%length%& expansion item"
8931 The &%length%& item is used to extract the initial portion of a string. Both
8932 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
8933 you are using a fixed value for the number, that is, if <&'string1'&> does not
8934 change when expanded, you can use the simpler operator notation that avoids
8935 some of the braces:
8936 .code
8937 ${length_<n>:<string>}
8938 .endd
8939 The result of this item is either the first <&'n'&> characters or the whole
8940 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
8941 &%strlen%&, which gives the length of a string.
8942
8943
8944 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
8945         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8946 This is the first of one of two different types of lookup item, which are both
8947 described in the next item.
8948
8949 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
8950         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8951 .cindex "expansion" "lookup in"
8952 .cindex "file" "lookups"
8953 .cindex "lookup" "in expanded string"
8954 The two forms of lookup item specify data lookups in files and databases, as
8955 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
8956 lookups, and the second is used for query-style lookups. The <&'key'&>,
8957 <&'file'&>, and <&'query'&> strings are expanded before use.
8958
8959 If there is any white space in a lookup item which is part of a filter command,
8960 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
8961 other place where white space is significant, the lookup item must be enclosed
8962 in double quotes. The use of data lookups in users' filter files may be locked
8963 out by the system administrator.
8964
8965 .vindex "&$value$&"
8966 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
8967 During its expansion, the variable &$value$& contains the data returned by the
8968 lookup. Afterwards it reverts to the value it had previously (at the outer
8969 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
8970 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
8971 string on failure. If <&'string2'&> is provided, it can itself be a nested
8972 lookup, thus providing a mechanism for looking up a default value when the
8973 original lookup fails.
8974
8975 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
8976 data for the outer lookup while the parameters of the second lookup are
8977 expanded, and also while <&'string2'&> of the second lookup is expanded, should
8978 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
8979 appear, and in this case, if the lookup fails, the entire expansion is forced
8980 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
8981 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
8982 successful lookup, and nothing in the case of failure.
8983
8984 For single-key lookups, the string &"partial"& is permitted to precede the
8985 search type in order to do partial matching, and * or *@ may follow a search
8986 type to request default lookups if the key does not match (see sections
8987 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
8988
8989 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
8990 If a partial search is used, the variables &$1$& and &$2$& contain the wild
8991 and non-wild parts of the key during the expansion of the replacement text.
8992 They return to their previous values at the end of the lookup item.
8993
8994 This example looks up the postmaster alias in the conventional alias file:
8995 .code
8996 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
8997 .endd
8998 This example uses NIS+ to look up the full name of the user corresponding to
8999 the local part of an address, forcing the expansion to fail if it is not found:
9000 .code
9001 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9002   {$value}fail}
9003 .endd
9004
9005
9006 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9007 .cindex "expansion" "list creation"
9008 .vindex "&$item$&"
9009 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9010 default, but the separator can be changed in the usual way. For each item
9011 in this list, its value is place in &$item$&, and then <&'string2'&> is
9012 expanded and added to the output as an item in a new list. The separator used
9013 for the output list is the same as the one used for the input, but a separator
9014 setting is not included in the output. For example:
9015 .code
9016 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9017 .endd
9018 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9019 value of &$item$& is restored to what it was before. See also the &*filter*&
9020 and &*reduce*& expansion items.
9021
9022 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9023 .cindex "expansion" "numeric hash"
9024 .cindex "hash function" "numeric"
9025 The three strings are expanded; the first two must yield numbers. Call them
9026 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9027 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9028 can use the simpler operator notation that avoids some of the braces:
9029 .code
9030 ${nhash_<n>_<m>:<string>}
9031 .endd
9032 The second number is optional (in both notations). If there is only one number,
9033 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9034 processed by a div/mod hash function that returns two numbers, separated by a
9035 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9036 example,
9037 .code
9038 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9039 .endd
9040 returns the string &"6/33"&.
9041
9042
9043
9044 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9045 .cindex "Perl" "use in expanded string"
9046 .cindex "expansion" "calling Perl from"
9047 This item is available only if Exim has been built to include an embedded Perl
9048 interpreter. The subroutine name and the arguments are first separately
9049 expanded, and then the Perl subroutine is called with those arguments. No
9050 additional arguments need be given; the maximum number permitted, including the
9051 name of the subroutine, is nine.
9052
9053 The return value of the subroutine is inserted into the expanded string, unless
9054 the return value is &%undef%&. In that case, the expansion fails in the same
9055 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9056 Whatever you return is evaluated in a scalar context. For example, if you
9057 return the name of a Perl vector, the return value is the size of the vector,
9058 not its contents.
9059
9060 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9061 with the error message that was passed to &%die%&. More details of the embedded
9062 Perl facility are given in chapter &<<CHAPperl>>&.
9063
9064 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9065 out the use of this expansion item in filter files.
9066
9067
9068 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9069 .cindex "&%prvs%& expansion item"
9070 The first argument is a complete email address and the second is secret
9071 keystring. The third argument, specifying a key number, is optional. If absent,
9072 it defaults to 0. The result of the expansion is a prvs-signed email address,
9073 to be typically used with the &%return_path%& option on an &(smtp)& transport
9074 as part of a bounce address tag validation (BATV) scheme. For more discussion
9075 and an example, see section &<<SECTverifyPRVS>>&.
9076
9077 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9078         {*&<&'string'&>&*}}*&"
9079 .cindex "&%prvscheck%& expansion item"
9080 This expansion item is the complement of the &%prvs%& item. It is used for
9081 checking prvs-signed addresses. If the expansion of the first argument does not
9082 yield a syntactically valid prvs-signed address, the whole item expands to the
9083 empty string. When the first argument does expand to a syntactically valid
9084 prvs-signed address, the second argument is expanded, with the prvs-decoded
9085 version of the address and the key number extracted from the address in the
9086 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9087
9088 These two variables can be used in the expansion of the second argument to
9089 retrieve the secret. The validity of the prvs-signed address is then checked
9090 against the secret. The result is stored in the variable &$prvscheck_result$&,
9091 which is empty for failure or &"1"& for success.
9092
9093 The third argument is optional; if it is missing, it defaults to an empty
9094 string. This argument is now expanded. If the result is an empty string, the
9095 result of the expansion is the decoded version of the address. This is the case
9096 whether or not the signature was valid. Otherwise, the result of the expansion
9097 is the expansion of the third argument.
9098
9099 All three variables can be used in the expansion of the third argument.
9100 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9101 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9102
9103 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9104 .cindex "expansion" "inserting an entire file"
9105 .cindex "file" "inserting into expansion"
9106 .cindex "&%readfile%& expansion item"
9107 The file name and end-of-line string are first expanded separately. The file is
9108 then read, and its contents replace the entire item. All newline characters in
9109 the file are replaced by the end-of-line string if it is present. Otherwise,
9110 newlines are left in the string.
9111 String expansion is not applied to the contents of the file. If you want this,
9112 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9113 the string expansion fails.
9114
9115 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9116 locks out the use of this expansion item in filter files.
9117
9118
9119
9120 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9121         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9122 .cindex "expansion" "inserting from a socket"
9123 .cindex "socket, use of in expansion"
9124 .cindex "&%readsocket%& expansion item"
9125 This item inserts data from a Unix domain or Internet socket into the expanded
9126 string. The minimal way of using it uses just two arguments, as in these
9127 examples:
9128 .code
9129 ${readsocket{/socket/name}{request string}}
9130 ${readsocket{inet:some.host:1234}{request string}}
9131 .endd
9132 For a Unix domain socket, the first substring must be the path to the socket.
9133 For an Internet socket, the first substring must contain &`inet:`& followed by
9134 a host name or IP address, followed by a colon and a port, which can be a
9135 number or the name of a TCP port in &_/etc/services_&. An IP address may
9136 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9137 example:
9138 .code
9139 ${readsocket{inet:[::1]:1234}{request string}}
9140 .endd
9141 Only a single host name may be given, but if looking it up yields more than
9142 one IP address, they are each tried in turn until a connection is made. For
9143 both kinds of socket, Exim makes a connection, writes the request string
9144 (unless it is an empty string) and reads from the socket until an end-of-file
9145 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9146 extend what can be done. Firstly, you can vary the timeout. For example:
9147 .code
9148 ${readsocket{/socket/name}{request string}{3s}}
9149 .endd
9150 A fourth argument allows you to change any newlines that are in the data
9151 that is read, in the same way as for &%readfile%& (see above). This example
9152 turns them into spaces:
9153 .code
9154 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9155 .endd
9156 As with all expansions, the substrings are expanded before the processing
9157 happens. Errors in these sub-expansions cause the expansion to fail. In
9158 addition, the following errors can occur:
9159
9160 .ilist
9161 Failure to create a socket file descriptor;
9162 .next
9163 Failure to connect the socket;
9164 .next
9165 Failure to write the request string;
9166 .next
9167 Timeout on reading from the socket.
9168 .endlist
9169
9170 By default, any of these errors causes the expansion to fail. However, if
9171 you supply a fifth substring, it is expanded and used when any of the above
9172 errors occurs. For example:
9173 .code
9174 ${readsocket{/socket/name}{request string}{3s}{\n}\
9175   {socket failure}}
9176 .endd
9177 You can test for the existence of a Unix domain socket by wrapping this
9178 expansion in &`${if exists`&, but there is a race condition between that test
9179 and the actual opening of the socket, so it is safer to use the fifth argument
9180 if you want to be absolutely sure of avoiding an expansion error for a
9181 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9182
9183 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9184 locks out the use of this expansion item in filter files.
9185
9186
9187 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9188 .cindex "expansion" "reducing a list to a scalar"
9189 .cindex "list" "reducing to a scalar"
9190 .vindex "&$value$&"
9191 .vindex "&$item$&"
9192 This operation reduces a list to a single, scalar string. After expansion,
9193 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9194 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9195 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9196 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9197 them. The result of that expansion is assigned to &$value$& before the next
9198 iteration. When the end of the list is reached, the final value of &$value$& is
9199 added to the expansion output. The &*reduce*& expansion item can be used in a
9200 number of ways. For example, to add up a list of numbers:
9201 .code
9202 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9203 .endd
9204 The result of that expansion would be &`6`&. The maximum of a list of numbers
9205 can be found:
9206 .code
9207 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9208 .endd
9209 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9210 restored to what they were before. See also the &*filter*& and &*map*&
9211 expansion items.
9212
9213 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9214 This item inserts &"raw"& header lines. It is described with the &%header%&
9215 expansion item above.
9216
9217 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9218         {*&<&'string2'&>&*}}*&"
9219 .cindex "expansion" "running a command"
9220 .cindex "&%run%& expansion item"
9221 The command and its arguments are first expanded separately, and then the
9222 command is run in a separate process, but under the same uid and gid. As in
9223 other command executions from Exim, a shell is not used by default. If you want
9224 a shell, you must explicitly code it.
9225
9226 The standard input for the command exists, but is empty. The standard output
9227 and standard error are set to the same file descriptor.
9228 .cindex "return code" "from &%run%& expansion"
9229 .vindex "&$value$&"
9230 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9231 and replaces the entire item; during this expansion, the standard output/error
9232 from the command is in the variable &$value$&. If the command fails,
9233 <&'string2'&>, if present, is expanded and used. Once again, during the
9234 expansion, the standard output/error from the command is in the variable
9235 &$value$&.
9236
9237 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9238 can be the word &"fail"& (not in braces) to force expansion failure if the
9239 command does not succeed. If both strings are omitted, the result is contents
9240 of the standard output/error on success, and nothing on failure.
9241
9242 .vindex "&$runrc$&"
9243 The return code from the command is put in the variable &$runrc$&, and this
9244 remains set afterwards, so in a filter file you can do things like this:
9245 .code
9246 if "${run{x y z}{}}$runrc" is 1 then ...
9247   elif $runrc is 2 then ...
9248   ...
9249 endif
9250 .endd
9251 If execution of the command fails (for example, the command does not exist),
9252 the return code is 127 &-- the same code that shells use for non-existent
9253 commands.
9254
9255 &*Warning*&: In a router or transport, you cannot assume the order in which
9256 option values are expanded, except for those preconditions whose order of
9257 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9258 by the expansion of one option, and use it in another.
9259
9260 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9261 out the use of this expansion item in filter files.
9262
9263
9264 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9265 .cindex "expansion" "string substitution"
9266 .cindex "&%sg%& expansion item"
9267 This item works like Perl's substitution operator (s) with the global (/g)
9268 option; hence its name. However, unlike the Perl equivalent, Exim does not
9269 modify the subject string; instead it returns the modified string for insertion
9270 into the overall expansion. The item takes three arguments: the subject string,
9271 a regular expression, and a substitution string. For example:
9272 .code
9273 ${sg{abcdefabcdef}{abc}{xyz}}
9274 .endd
9275 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9276 if any $ or \ characters are required in the regular expression or in the
9277 substitution string, they have to be escaped. For example:
9278 .code
9279 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9280 .endd
9281 yields &"defabc"&, and
9282 .code
9283 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9284 .endd
9285 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9286 the regular expression from string expansion.
9287
9288
9289
9290 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9291 .cindex "&%substr%& expansion item"
9292 .cindex "substring extraction"
9293 .cindex "expansion" "substring extraction"
9294 The three strings are expanded; the first two must yield numbers. Call them
9295 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9296 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9297 can use the simpler operator notation that avoids some of the braces:
9298 .code
9299 ${substr_<n>_<m>:<string>}
9300 .endd
9301 The second number is optional (in both notations).
9302 If it is absent in the simpler format, the preceding underscore must also be
9303 omitted.
9304
9305 The &%substr%& item can be used to extract more general substrings than
9306 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9307 length required. For example
9308 .code
9309 ${substr{3}{2}{$local_part}}
9310 .endd
9311 If the starting offset is greater than the string length the result is the
9312 null string; if the length plus starting offset is greater than the string
9313 length, the result is the right-hand part of the string, starting from the
9314 given offset. The first character in the string has offset zero.
9315
9316 The &%substr%& expansion item can take negative offset values to count
9317 from the right-hand end of its operand. The last character is offset -1, the
9318 second-last is offset -2, and so on. Thus, for example,
9319 .code
9320 ${substr{-5}{2}{1234567}}
9321 .endd
9322 yields &"34"&. If the absolute value of a negative offset is greater than the
9323 length of the string, the substring starts at the beginning of the string, and
9324 the length is reduced by the amount of overshoot. Thus, for example,
9325 .code
9326 ${substr{-5}{2}{12}}
9327 .endd
9328 yields an empty string, but
9329 .code
9330 ${substr{-3}{2}{12}}
9331 .endd
9332 yields &"1"&.
9333
9334 When the second number is omitted from &%substr%&, the remainder of the string
9335 is taken if the offset is positive. If it is negative, all characters in the
9336 string preceding the offset point are taken. For example, an offset of -1 and
9337 no length, as in these semantically identical examples:
9338 .code
9339 ${substr_-1:abcde}
9340 ${substr{-1}{abcde}}
9341 .endd
9342 yields all but the last character of the string, that is, &"abcd"&.
9343
9344
9345
9346 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9347         {*&<&'replacements'&>&*}}*&"
9348 .cindex "expansion" "character translation"
9349 .cindex "&%tr%& expansion item"
9350 This item does single-character translation on its subject string. The second
9351 argument is a list of characters to be translated in the subject string. Each
9352 matching character is replaced by the corresponding character from the
9353 replacement list. For example
9354 .code
9355 ${tr{abcdea}{ac}{13}}
9356 .endd
9357 yields &`1b3de1`&. If there are duplicates in the second character string, the
9358 last occurrence is used. If the third string is shorter than the second, its
9359 last character is replicated. However, if it is empty, no translation takes
9360 place.
9361 .endlist
9362
9363
9364
9365 .section "Expansion operators" "SECTexpop"
9366 .cindex "expansion" "operators"
9367 For expansion items that perform transformations on a single argument string,
9368 the &"operator"& notation is used because it is simpler and uses fewer braces.
9369 The substring is first expanded before the operation is applied to it. The
9370 following operations can be performed:
9371
9372 .vlist
9373 .vitem &*${address:*&<&'string'&>&*}*&
9374 .cindex "expansion" "RFC 2822 address handling"
9375 .cindex "&%address%& expansion item"
9376 The string is interpreted as an RFC 2822 address, as it might appear in a
9377 header line, and the effective address is extracted from it. If the string does
9378 not parse successfully, the result is empty.
9379
9380
9381 .vitem &*${addresses:*&<&'string'&>&*}*&
9382 .cindex "expansion" "RFC 2822 address handling"
9383 .cindex "&%addresses%& expansion item"
9384 The string (after expansion) is interpreted as a list of addresses in RFC
9385 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9386 operative address (&'local-part@domain'&) is extracted from each item, and the
9387 result of the expansion is a colon-separated list, with appropriate
9388 doubling of colons should any happen to be present in the email addresses.
9389 Syntactically invalid RFC2822 address items are omitted from the output.
9390
9391 It is possible to specify a character other than colon for the output
9392 separator by starting the string with > followed by the new separator
9393 character. For example:
9394 .code
9395 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9396 .endd
9397 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9398 expansion item, which extracts the working address from a single RFC2822
9399 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9400 processing lists.
9401
9402
9403 .vitem &*${base62:*&<&'digits'&>&*}*&
9404 .cindex "&%base62%& expansion item"
9405 .cindex "expansion" "conversion to base 62"
9406 The string must consist entirely of decimal digits. The number is converted to
9407 base 62 and output as a string of six characters, including leading zeros. In
9408 the few operating environments where Exim uses base 36 instead of base 62 for
9409 its message identifiers (because those systems do not have case-sensitive file
9410 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9411 be absolutely clear: this is &'not'& base64 encoding.
9412
9413 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9414 .cindex "&%base62d%& expansion item"
9415 .cindex "expansion" "conversion to base 62"
9416 The string must consist entirely of base-62 digits, or, in operating
9417 environments where Exim uses base 36 instead of base 62 for its message
9418 identifiers, base-36 digits. The number is converted to decimal and output as a
9419 string.
9420
9421 .vitem &*${domain:*&<&'string'&>&*}*&
9422 .cindex "domain" "extraction"
9423 .cindex "expansion" "domain extraction"
9424 The string is interpreted as an RFC 2822 address and the domain is extracted
9425 from it. If the string does not parse successfully, the result is empty.
9426
9427
9428 .vitem &*${escape:*&<&'string'&>&*}*&
9429 .cindex "expansion" "escaping non-printing characters"
9430 .cindex "&%escape%& expansion item"
9431 If the string contains any non-printing characters, they are converted to
9432 escape sequences starting with a backslash. Whether characters with the most
9433 significant bit set (so-called &"8-bit characters"&) count as printing or not
9434 is controlled by the &%print_topbitchars%& option.
9435
9436
9437 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9438 .cindex "expansion" "expression evaluation"
9439 .cindex "expansion" "arithmetic expression"
9440 .cindex "&%eval%& expansion item"
9441 These items supports simple arithmetic and bitwise logical operations in
9442 expansion strings. The string (after expansion) must be a conventional
9443 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9444 logical operators, and parentheses. All operations are carried out using
9445 integer arithmetic. The operator priorities are as follows (the same as in the
9446 C programming language):
9447 .table2 70pt 300pt
9448 .irow &'highest:'& "not (~), negate (-)"
9449 .irow ""   "multiply (*), divide (/), remainder (%)"
9450 .irow ""   "plus (+), minus (-)"
9451 .irow ""   "shift-left (<<), shift-right (>>)"
9452 .irow ""   "and (&&)"
9453 .irow ""   "xor (^)"
9454 .irow &'lowest:'&  "or (|)"
9455 .endtable
9456 Binary operators with the same priority are evaluated from left to right. White
9457 space is permitted before or after operators.
9458
9459 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9460 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9461 decimal, even if they start with a leading zero; hexadecimal numbers are not
9462 permitted. This can be useful when processing numbers extracted from dates or
9463 times, which often do have leading zeros.
9464
9465 A number may be followed by &"K"& or &"M"& to multiply it by 1024 or 1024*1024,
9466 respectively. Negative numbers are supported. The result of the computation is
9467 a decimal representation of the answer (without &"K"& or &"M"&). For example:
9468
9469 .display
9470 &`${eval:1+1}            `&  yields 2
9471 &`${eval:1+2*3}          `&  yields 7
9472 &`${eval:(1+2)*3}        `&  yields 9
9473 &`${eval:2+42%5}         `&  yields 4
9474 &`${eval:0xc&amp;5}          `&  yields 4
9475 &`${eval:0xc|5}          `&  yields 13
9476 &`${eval:0xc^5}          `&  yields 9
9477 &`${eval:0xc>>1}         `&  yields 6
9478 &`${eval:0xc<<1}         `&  yields 24
9479 &`${eval:~255&amp;0x1234}    `&  yields 4608
9480 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9481 .endd
9482
9483 As a more realistic example, in an ACL you might have
9484 .code
9485 deny   message = Too many bad recipients
9486        condition =                    \
9487          ${if and {                   \
9488            {>{$rcpt_count}{10}}       \
9489            {                          \
9490            <                          \
9491              {$recipients_count}      \
9492              {${eval:$rcpt_count/2}}  \
9493            }                          \
9494          }{yes}{no}}
9495 .endd
9496 The condition is true if there have been more than 10 RCPT commands and
9497 fewer than half of them have resulted in a valid recipient.
9498
9499
9500 .vitem &*${expand:*&<&'string'&>&*}*&
9501 .cindex "expansion" "re-expansion of substring"
9502 The &%expand%& operator causes a string to be expanded for a second time. For
9503 example,
9504 .code
9505 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9506 .endd
9507 first looks up a string in a file while expanding the operand for &%expand%&,
9508 and then re-expands what it has found.
9509
9510
9511 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9512 .cindex "Unicode"
9513 .cindex "UTF-8" "conversion from"
9514 .cindex "expansion" "UTF-8 conversion"
9515 .cindex "&%from_utf8%& expansion item"
9516 The world is slowly moving towards Unicode, although there are no standards for
9517 email yet. However, other applications (including some databases) are starting
9518 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9519 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9520 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9521 the result is an undefined sequence of bytes.
9522
9523 Unicode code points with values less than 256 are compatible with ASCII and
9524 ISO-8859-1 (also known as Latin-1).
9525 For example, character 169 is the copyright symbol in both cases, though the
9526 way it is encoded is different. In UTF-8, more than one byte is needed for
9527 characters with code values greater than 127, whereas ISO-8859-1 is a
9528 single-byte encoding (but thereby limited to 256 characters). This makes
9529 translation from UTF-8 to ISO-8859-1 straightforward.
9530
9531
9532 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9533 .cindex "hash function" "textual"
9534 .cindex "expansion" "textual hash"
9535 The &%hash%& operator is a simpler interface to the hashing function that can
9536 be used when the two parameters are fixed numbers (as opposed to strings that
9537 change when expanded). The effect is the same as
9538 .code
9539 ${hash{<n>}{<m>}{<string>}}
9540 .endd
9541 See the description of the general &%hash%& item above for details. The
9542 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9543
9544
9545
9546 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9547 .cindex "base64 encoding" "conversion from hex"
9548 .cindex "expansion" "hex to base64"
9549 .cindex "&%hex2b64%& expansion item"
9550 This operator converts a hex string into one that is base64 encoded. This can
9551 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9552
9553
9554 .vitem &*${lc:*&<&'string'&>&*}*&
9555 .cindex "case forcing in strings"
9556 .cindex "string" "case forcing"
9557 .cindex "lower casing"
9558 .cindex "expansion" "case forcing"
9559 .cindex "&%lc%& expansion item"
9560 This forces the letters in the string into lower-case, for example:
9561 .code
9562 ${lc:$local_part}
9563 .endd
9564
9565 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9566 .cindex "expansion" "string truncation"
9567 .cindex "&%length%& expansion item"
9568 The &%length%& operator is a simpler interface to the &%length%& function that
9569 can be used when the parameter is a fixed number (as opposed to a string that
9570 changes when expanded). The effect is the same as
9571 .code
9572 ${length{<number>}{<string>}}
9573 .endd
9574 See the description of the general &%length%& item above for details. Note that
9575 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9576 when &%length%& is used as an operator.
9577
9578
9579 .vitem &*${local_part:*&<&'string'&>&*}*&
9580 .cindex "expansion" "local part extraction"
9581 .cindex "&%local_part%& expansion item"
9582 The string is interpreted as an RFC 2822 address and the local part is
9583 extracted from it. If the string does not parse successfully, the result is
9584 empty.
9585
9586
9587 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9588 .cindex "masked IP address"
9589 .cindex "IP address" "masking"
9590 .cindex "CIDR notation"
9591 .cindex "expansion" "IP address masking"
9592 .cindex "&%mask%& expansion item"
9593 If the form of the string to be operated on is not an IP address followed by a
9594 slash and an integer (that is, a network address in CIDR notation), the
9595 expansion fails. Otherwise, this operator converts the IP address to binary,
9596 masks off the least significant bits according to the bit count, and converts
9597 the result back to text, with mask appended. For example,
9598 .code
9599 ${mask:10.111.131.206/28}
9600 .endd
9601 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9602 be mostly used for looking up masked addresses in files, the result for an IPv6
9603 address uses dots to separate components instead of colons, because colon
9604 terminates a key string in lsearch files. So, for example,
9605 .code
9606 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9607 .endd
9608 returns the string
9609 .code
9610 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9611 .endd
9612 Letters in IPv6 addresses are always output in lower case.
9613
9614
9615 .vitem &*${md5:*&<&'string'&>&*}*&
9616 .cindex "MD5 hash"
9617 .cindex "expansion" "MD5 hash"
9618 .cindex "&%md5%& expansion item"
9619 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9620 as a 32-digit hexadecimal number, in which any letters are in lower case.
9621
9622
9623 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9624 .cindex "expansion" "numeric hash"
9625 .cindex "hash function" "numeric"
9626 The &%nhash%& operator is a simpler interface to the numeric hashing function
9627 that can be used when the two parameters are fixed numbers (as opposed to
9628 strings that change when expanded). The effect is the same as
9629 .code
9630 ${nhash{<n>}{<m>}{<string>}}
9631 .endd
9632 See the description of the general &%nhash%& item above for details.
9633
9634
9635 .vitem &*${quote:*&<&'string'&>&*}*&
9636 .cindex "quoting" "in string expansions"
9637 .cindex "expansion" "quoting"
9638 .cindex "&%quote%& expansion item"
9639 The &%quote%& operator puts its argument into double quotes if it
9640 is an empty string or
9641 contains anything other than letters, digits, underscores, dots, and hyphens.
9642 Any occurrences of double quotes and backslashes are escaped with a backslash.
9643 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9644 respectively For example,
9645 .code
9646 ${quote:ab"*"cd}
9647 .endd
9648 becomes
9649 .code
9650 "ab\"*\"cd"
9651 .endd
9652 The place where this is useful is when the argument is a substitution from a
9653 variable or a message header.
9654
9655 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9656 .cindex "&%quote_local_part%& expansion item"
9657 This operator is like &%quote%&, except that it quotes the string only if
9658 required to do so by the rules of RFC 2822 for quoting local parts. For
9659 example, a plus sign would not cause quoting (but it would for &%quote%&).
9660 If you are creating a new email address from the contents of &$local_part$&
9661 (or any other unknown data), you should always use this operator.
9662
9663
9664 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9665 .cindex "quoting" "lookup-specific"
9666 This operator applies lookup-specific quoting rules to the string. Each
9667 query-style lookup type has its own quoting rules which are described with
9668 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9669 .code
9670 ${quote_ldap:two * two}
9671 .endd
9672 returns
9673 .code
9674 two%20%5C2A%20two
9675 .endd
9676 For single-key lookup types, no quoting is ever necessary and this operator
9677 yields an unchanged string.
9678
9679
9680 .vitem &*${randint:*&<&'n'&>&*}*&
9681 .cindex "random number"
9682 This operator returns a somewhat random number which is less than the
9683 supplied number and is at least 0.  The quality of this randomness depends
9684 on how Exim was built; the values are not suitable for keying material.
9685 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9686 Otherwise, the implementation may be arc4random(), random() seeded by
9687 srandomdev() or srandom(), or a custom implementation even weaker than
9688 random().
9689
9690
9691 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9692 .cindex "expansion" "IP address"
9693 This operator reverses an IP address; for IPv4 addresses, the result is in
9694 dotted-quad decimal form, while for IPv6 addreses the result is in
9695 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9696 for DNS.  For example,
9697 .code
9698 ${reverse_ip:192.0.2.4} and ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9699 .endd
9700 returns
9701 .code
9702 4.2.0.192 and 3.0.2.0.0.0.0.c.d.c.b.a.1.0.0.0.9.0.0.0.2.4.c.0.8.b.d.0.1.0.0.2
9703 .endd
9704
9705
9706 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9707 .cindex "expansion" "RFC 2047"
9708 .cindex "RFC 2047" "expansion operator"
9709 .cindex "&%rfc2047%& expansion item"
9710 This operator encodes text according to the rules of RFC 2047. This is an
9711 encoding that is used in header lines to encode non-ASCII characters. It is
9712 assumed that the input string is in the encoding specified by the
9713 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9714 contains only characters in the range 33&--126, and no instances of the
9715 characters
9716 .code
9717 ? = ( ) < > @ , ; : \ " . [ ] _
9718 .endd
9719 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9720 string, using as many &"encoded words"& as necessary to encode all the
9721 characters.
9722
9723
9724 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9725 .cindex "expansion" "RFC 2047"
9726 .cindex "RFC 2047" "decoding"
9727 .cindex "&%rfc2047d%& expansion item"
9728 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9729 bytes are replaced by question marks. Characters are converted into the
9730 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9731 not recognized unless &%check_rfc2047_length%& is set false.
9732
9733 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9734 access a header line, RFC 2047 decoding is done automatically. You do not need
9735 to use this operator as well.
9736
9737
9738
9739 .vitem &*${rxquote:*&<&'string'&>&*}*&
9740 .cindex "quoting" "in regular expressions"
9741 .cindex "regular expressions" "quoting"
9742 .cindex "&%rxquote%& expansion item"
9743 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9744 characters in its argument. This is useful when substituting the values of
9745 variables or headers inside regular expressions.
9746
9747
9748 .vitem &*${sha1:*&<&'string'&>&*}*&
9749 .cindex "SHA-1 hash"
9750 .cindex "expansion" "SHA-1 hashing"
9751 .cindex "&%sha2%& expansion item"
9752 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9753 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9754
9755
9756 .vitem &*${stat:*&<&'string'&>&*}*&
9757 .cindex "expansion" "statting a file"
9758 .cindex "file" "extracting characteristics"
9759 .cindex "&%stat%& expansion item"
9760 The string, after expansion, must be a file path. A call to the &[stat()]&
9761 function is made for this path. If &[stat()]& fails, an error occurs and the
9762 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9763 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9764 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9765 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9766 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9767 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9768 can extract individual fields using the &%extract%& expansion item.
9769
9770 The use of the &%stat%& expansion in users' filter files can be locked out by
9771 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9772 systems for files larger than 2GB.
9773
9774 .vitem &*${str2b64:*&<&'string'&>&*}*&
9775 .cindex "expansion" "base64 encoding"
9776 .cindex "base64 encoding" "in string expansion"
9777 .cindex "&%str2b64%& expansion item"
9778 This operator converts a string into one that is base64 encoded.
9779
9780
9781
9782 .vitem &*${strlen:*&<&'string'&>&*}*&
9783 .cindex "expansion" "string length"
9784 .cindex "string" "length in expansion"
9785 .cindex "&%strlen%& expansion item"
9786 The item is replace by the length of the expanded string, expressed as a
9787 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9788
9789
9790 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9791 .cindex "&%substr%& expansion item"
9792 .cindex "substring extraction"
9793 .cindex "expansion" "substring expansion"
9794 The &%substr%& operator is a simpler interface to the &%substr%& function that
9795 can be used when the two parameters are fixed numbers (as opposed to strings
9796 that change when expanded). The effect is the same as
9797 .code
9798 ${substr{<start>}{<length>}{<string>}}
9799 .endd
9800 See the description of the general &%substr%& item above for details. The
9801 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9802
9803 .vitem &*${time_eval:*&<&'string'&>&*}*&
9804 .cindex "&%time_eval%& expansion item"
9805 .cindex "time interval" "decoding"
9806 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9807 seconds.
9808
9809 .vitem &*${time_interval:*&<&'string'&>&*}*&
9810 .cindex "&%time_interval%& expansion item"
9811 .cindex "time interval" "formatting"
9812 The argument (after sub-expansion) must be a sequence of decimal digits that
9813 represents an interval of time as a number of seconds. It is converted into a
9814 number of larger units and output in Exim's normal time format, for example,
9815 &`1w3d4h2m6s`&.
9816
9817 .vitem &*${uc:*&<&'string'&>&*}*&
9818 .cindex "case forcing in strings"
9819 .cindex "string" "case forcing"
9820 .cindex "upper casing"
9821 .cindex "expansion" "case forcing"
9822 .cindex "&%uc%& expansion item"
9823 This forces the letters in the string into upper-case.
9824 .endlist
9825
9826
9827
9828
9829
9830
9831 .section "Expansion conditions" "SECTexpcond"
9832 .scindex IIDexpcond "expansion" "conditions"
9833 The following conditions are available for testing by the &%${if%& construct
9834 while expanding strings:
9835
9836 .vlist
9837 .vitem &*!*&<&'condition'&>
9838 .cindex "expansion" "negating a condition"
9839 .cindex "negation" "in expansion condition"
9840 Preceding any condition with an exclamation mark negates the result of the
9841 condition.
9842
9843 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9844 .cindex "numeric comparison"
9845 .cindex "expansion" "numeric comparison"
9846 There are a number of symbolic operators for doing numeric comparisons. They
9847 are:
9848 .display
9849 &`=   `&   equal
9850 &`==  `&   equal
9851 &`>   `&   greater
9852 &`>=  `&   greater or equal
9853 &`<   `&   less
9854 &`<=  `&   less or equal
9855 .endd
9856 For example:
9857 .code
9858 ${if >{$message_size}{10M} ...
9859 .endd
9860 Note that the general negation operator provides for inequality testing. The
9861 two strings must take the form of optionally signed decimal integers,
9862 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9863 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9864 As a special case, the numerical value of an empty string is taken as
9865 zero.
9866
9867
9868 .vitem &*bool&~{*&<&'string'&>&*}*&
9869 .cindex "expansion" "boolean parsing"
9870 .cindex "&%bool%& expansion condition"
9871 This condition turns a string holding a true or false representation into
9872 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
9873 (case-insensitively); also positive integer numbers map to true if non-zero,
9874 false if zero.  Leading and trailing whitespace is ignored.
9875 All other string values will result in expansion failure.
9876
9877 When combined with ACL variables, this expansion condition will let you
9878 make decisions in one place and act on those decisions in another place.
9879 For example:
9880 .code
9881 ${if bool{$acl_m_privileged_sender} ...
9882 .endd
9883
9884
9885 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
9886 .cindex "expansion" "boolean parsing"
9887 .cindex "&%bool_lax%& expansion condition"
9888 Like &%bool%&, this condition turns a string into a boolean state.  But
9889 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
9890 loose definition that the Router &%condition%& option uses.  The empty string
9891 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
9892 true.  Leading and trailing whitespace is ignored.
9893
9894 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
9895
9896 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9897 .cindex "expansion" "encrypted comparison"
9898 .cindex "encrypted strings, comparing"
9899 .cindex "&%crypteq%& expansion condition"
9900 This condition is included in the Exim binary if it is built to support any
9901 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
9902 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
9903 included in the binary.
9904
9905 The &%crypteq%& condition has two arguments. The first is encrypted and
9906 compared against the second, which is already encrypted. The second string may
9907 be in the LDAP form for storing encrypted strings, which starts with the
9908 encryption type in curly brackets, followed by the data. If the second string
9909 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
9910 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
9911 Typically this will be a field from a password file. An example of an encrypted
9912 string in LDAP form is:
9913 .code
9914 {md5}CY9rzUYh03PK3k6DJie09g==
9915 .endd
9916 If such a string appears directly in an expansion, the curly brackets have to
9917 be quoted, because they are part of the expansion syntax. For example:
9918 .code
9919 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
9920 .endd
9921 The following encryption types (whose names are matched case-independently) are
9922 supported:
9923
9924 .ilist
9925 .cindex "MD5 hash"
9926 .cindex "base64 encoding" "in encrypted password"
9927 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
9928 printable characters to compare with the remainder of the second string. If the
9929 length of the comparison string is 24, Exim assumes that it is base64 encoded
9930 (as in the above example). If the length is 32, Exim assumes that it is a
9931 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
9932 comparison fails.
9933
9934 .next
9935 .cindex "SHA-1 hash"
9936 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
9937 printable characters to compare with the remainder of the second string. If the
9938 length of the comparison string is 28, Exim assumes that it is base64 encoded.
9939 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
9940 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
9941
9942 .next
9943 .cindex "&[crypt()]&"
9944 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
9945 only the first eight characters of the password. However, in modern operating
9946 systems this is no longer true, and in many cases the entire password is used,
9947 whatever its length.
9948
9949 .next
9950 .cindex "&[crypt16()]&"
9951 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
9952 use up to 16 characters of the password in some operating systems. Again, in
9953 modern operating systems, more characters may be used.
9954 .endlist
9955 Exim has its own version of &[crypt16()]&, which is just a double call to
9956 &[crypt()]&. For operating systems that have their own version, setting
9957 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
9958 operating system version instead of its own. This option is set by default in
9959 the OS-dependent &_Makefile_& for those operating systems that are known to
9960 support &[crypt16()]&.
9961
9962 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
9963 it was not using the same algorithm as some operating systems' versions. It
9964 turns out that as well as &[crypt16()]& there is a function called
9965 &[bigcrypt()]& in some operating systems. This may or may not use the same
9966 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
9967
9968 However, since there is now a move away from the traditional &[crypt()]&
9969 functions towards using SHA1 and other algorithms, tidying up this area of
9970 Exim is seen as very low priority.
9971
9972 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
9973 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
9974 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
9975 default is &`{crypt}`&. Whatever the default, you can always use either
9976 function by specifying it explicitly in curly brackets.
9977
9978 .vitem &*def:*&<&'variable&~name'&>
9979 .cindex "expansion" "checking for empty variable"
9980 .cindex "&%def%& expansion condition"
9981 The &%def%& condition must be followed by the name of one of the expansion
9982 variables defined in section &<<SECTexpvar>>&. The condition is true if the
9983 variable does not contain the empty string. For example:
9984 .code
9985 ${if def:sender_ident {from $sender_ident}}
9986 .endd
9987 Note that the variable name is given without a leading &%$%& character. If the
9988 variable does not exist, the expansion fails.
9989
9990 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
9991         &~&*def:h_*&<&'header&~name'&>&*:*&"
9992 .cindex "expansion" "checking header line existence"
9993 This condition is true if a message is being processed and the named header
9994 exists in the message. For example,
9995 .code
9996 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
9997 .endd
9998 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
9999 the header name must be terminated by a colon if white space does not follow.
10000
10001 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10002        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10003 .cindex "string" "comparison"
10004 .cindex "expansion" "string comparison"
10005 .cindex "&%eq%& expansion condition"
10006 .cindex "&%eqi%& expansion condition"
10007 The two substrings are first expanded. The condition is true if the two
10008 resulting strings are identical. For &%eq%& the comparison includes the case of
10009 letters, whereas for &%eqi%& the comparison is case-independent.
10010
10011 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10012 .cindex "expansion" "file existence test"
10013 .cindex "file" "existence test"
10014 .cindex "&%exists%&, expansion condition"
10015 The substring is first expanded and then interpreted as an absolute path. The
10016 condition is true if the named file (or directory) exists. The existence test
10017 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10018 users' filter files may be locked out by the system administrator.
10019
10020 .vitem &*first_delivery*&
10021 .cindex "delivery" "first"
10022 .cindex "first delivery"
10023 .cindex "expansion" "first delivery test"
10024 .cindex "&%first_delivery%& expansion condition"
10025 This condition, which has no data, is true during a message's first delivery
10026 attempt. It is false during any subsequent delivery attempts.
10027
10028
10029 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10030        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10031 .cindex "list" "iterative conditions"
10032 .cindex "expansion" "&*forall*& condition"
10033 .cindex "expansion" "&*forany*& condition"
10034 .vindex "&$item$&"
10035 These conditions iterate over a list. The first argument is expanded to form
10036 the list. By default, the list separator is a colon, but it can be changed by
10037 the normal method. The second argument is interpreted as a condition that is to
10038 be applied to each item in the list in turn. During the interpretation of the
10039 condition, the current list item is placed in a variable called &$item$&.
10040 .ilist
10041 For &*forany*&, interpretation stops if the condition is true for any item, and
10042 the result of the whole condition is true. If the condition is false for all
10043 items in the list, the overall condition is false.
10044 .next
10045 For &*forall*&, interpretation stops if the condition is false for any item,
10046 and the result of the whole condition is false. If the condition is true for
10047 all items in the list, the overall condition is true.
10048 .endlist
10049 Note that negation of &*forany*& means that the condition must be false for all
10050 items for the overall condition to succeed, and negation of &*forall*& means
10051 that the condition must be false for at least one item. In this example, the
10052 list separator is changed to a comma:
10053 .code
10054 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10055 .endd
10056 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10057 being processed, to enable these expansion items to be nested.
10058
10059
10060 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10061        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10062 .cindex "string" "comparison"
10063 .cindex "expansion" "string comparison"
10064 .cindex "&%ge%& expansion condition"
10065 .cindex "&%gei%& expansion condition"
10066 The two substrings are first expanded. The condition is true if the first
10067 string is lexically greater than or equal to the second string. For &%ge%& the
10068 comparison includes the case of letters, whereas for &%gei%& the comparison is
10069 case-independent.
10070
10071 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10072        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10073 .cindex "string" "comparison"
10074 .cindex "expansion" "string comparison"
10075 .cindex "&%gt%& expansion condition"
10076 .cindex "&%gti%& expansion condition"
10077 The two substrings are first expanded. The condition is true if the first
10078 string is lexically greater than the second string. For &%gt%& the comparison
10079 includes the case of letters, whereas for &%gti%& the comparison is
10080 case-independent.
10081
10082 .new
10083 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10084        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10085 .cindex "string" "comparison"
10086 .cindex "list" "iterative conditions"
10087 Both strings are expanded; the second string is treated as a list of simple
10088 strings; if the first string is a member of the second, then the condition
10089 is true.
10090
10091 These are simpler to use versions of the more powerful &*forany*& condition.
10092 Examples, and the &*forany*& equivalents:
10093 .code
10094 ${if inlist{needle}{foo:needle:bar}}
10095   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10096 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10097   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10098 .endd
10099 .wen
10100
10101 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10102        &*isip4&~{*&<&'string'&>&*}*& &&&
10103        &*isip6&~{*&<&'string'&>&*}*&
10104 .cindex "IP address" "testing string format"
10105 .cindex "string" "testing for IP address"
10106 .cindex "&%isip%& expansion condition"
10107 .cindex "&%isip4%& expansion condition"
10108 .cindex "&%isip6%& expansion condition"
10109 The substring is first expanded, and then tested to see if it has the form of
10110 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10111 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10112
10113 For an IPv4 address, the test is for four dot-separated components, each of
10114 which consists of from one to three digits. For an IPv6 address, up to eight
10115 colon-separated components are permitted, each containing from one to four
10116 hexadecimal digits. There may be fewer than eight components if an empty
10117 component (adjacent colons) is present. Only one empty component is permitted.
10118
10119 &*Note*&: The checks are just on the form of the address; actual numerical
10120 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10121 check. The main use of these tests is to distinguish between IP addresses and
10122 host names, or between IPv4 and IPv6 addresses. For example, you could use
10123 .code
10124 ${if isip4{$sender_host_address}...
10125 .endd
10126 to test which IP version an incoming SMTP connection is using.
10127
10128 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10129 .cindex "LDAP" "use for authentication"
10130 .cindex "expansion" "LDAP authentication test"
10131 .cindex "&%ldapauth%& expansion condition"
10132 This condition supports user authentication using LDAP. See section
10133 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10134 queries. For this use, the query must contain a user name and password. The
10135 query itself is not used, and can be empty. The condition is true if the
10136 password is not empty, and the user name and password are accepted by the LDAP
10137 server. An empty password is rejected without calling LDAP because LDAP binds
10138 with an empty password are considered anonymous regardless of the username, and
10139 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10140 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10141 this can be used.
10142
10143
10144 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10145        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10146 .cindex "string" "comparison"
10147 .cindex "expansion" "string comparison"
10148 .cindex "&%le%& expansion condition"
10149 .cindex "&%lei%& expansion condition"
10150 The two substrings are first expanded. The condition is true if the first
10151 string is lexically less than or equal to the second string. For &%le%& the
10152 comparison includes the case of letters, whereas for &%lei%& the comparison is
10153 case-independent.
10154
10155 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10156        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10157 .cindex "string" "comparison"
10158 .cindex "expansion" "string comparison"
10159 .cindex "&%lt%& expansion condition"
10160 .cindex "&%lti%& expansion condition"
10161 The two substrings are first expanded. The condition is true if the first
10162 string is lexically less than the second string. For &%lt%& the comparison
10163 includes the case of letters, whereas for &%lti%& the comparison is
10164 case-independent.
10165
10166
10167 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10168 .cindex "expansion" "regular expression comparison"
10169 .cindex "regular expressions" "match in expanded string"
10170 .cindex "&%match%& expansion condition"
10171 The two substrings are first expanded. The second is then treated as a regular
10172 expression and applied to the first. Because of the pre-expansion, if the
10173 regular expression contains dollar, or backslash characters, they must be
10174 escaped. Care must also be taken if the regular expression contains braces
10175 (curly brackets). A closing brace must be escaped so that it is not taken as a
10176 premature termination of <&'string2'&>. The easiest approach is to use the
10177 &`\N`& feature to disable expansion of the regular expression.
10178 For example,
10179 .code
10180 ${if match {$local_part}{\N^\d{3}\N} ...
10181 .endd
10182 If the whole expansion string is in double quotes, further escaping of
10183 backslashes is also required.
10184
10185 The condition is true if the regular expression match succeeds.
10186 The regular expression is not required to begin with a circumflex
10187 metacharacter, but if there is no circumflex, the expression is not anchored,
10188 and it may match anywhere in the subject, not just at the start. If you want
10189 the pattern to match at the end of the subject, you must include the &`$`&
10190 metacharacter at an appropriate point.
10191
10192 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10193 At the start of an &%if%& expansion the values of the numeric variable
10194 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10195 succeeds causes them to be reset to the substrings of that condition and they
10196 will have these values during the expansion of the success string. At the end
10197 of the &%if%& expansion, the previous values are restored. After testing a
10198 combination of conditions using &%or%&, the subsequent values of the numeric
10199 variables are those of the condition that succeeded.
10200
10201 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10202 .cindex "&%match_address%& expansion condition"
10203 See &*match_local_part*&.
10204
10205 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10206 .cindex "&%match_domain%& expansion condition"
10207 See &*match_local_part*&.
10208
10209 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10210 .cindex "&%match_ip%& expansion condition"
10211 This condition matches an IP address to a list of IP address patterns. It must
10212 be followed by two argument strings. The first (after expansion) must be an IP
10213 address or an empty string. The second (after expansion) is a restricted host
10214 list that can match only an IP address, not a host name. For example:
10215 .code
10216 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10217 .endd
10218 The specific types of host list item that are permitted in the list are:
10219
10220 .ilist
10221 An IP address, optionally with a CIDR mask.
10222 .next
10223 A single asterisk, which matches any IP address.
10224 .next
10225 An empty item, which matches only if the IP address is empty. This could be
10226 useful for testing for a locally submitted message or one from specific hosts
10227 in a single test such as
10228 . ==== As this is a nested list, any displays it contains must be indented
10229 . ==== as otherwise they are too far to the left. This comment applies to
10230 . ==== the use of xmlto plus fop. There's no problem when formatting with
10231 . ==== sdop, with or without the extra indent.
10232 .code
10233   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10234 .endd
10235 where the first item in the list is the empty string.
10236 .next
10237 The item @[] matches any of the local host's interface addresses.
10238 .next
10239 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10240 even if &`net-`& is not specified. There is never any attempt to turn the IP
10241 address into a host name. The most common type of linear search for
10242 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10243 masks. For example:
10244 .code
10245   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10246 .endd
10247 It is of course possible to use other kinds of lookup, and in such a case, you
10248 do need to specify the &`net-`& prefix if you want to specify a specific
10249 address mask, for example:
10250 .code
10251   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10252 .endd
10253 However, unless you are combining a &%match_ip%& condition with others, it is
10254 just as easy to use the fact that a lookup is itself a condition, and write:
10255 .code
10256   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10257 .endd
10258 .endlist ilist
10259
10260 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10261
10262 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10263 .cindex "domain list" "in expansion condition"
10264 .cindex "address list" "in expansion condition"
10265 .cindex "local part" "list, in expansion condition"
10266 .cindex "&%match_local_part%& expansion condition"
10267 This condition, together with &%match_address%& and &%match_domain%&, make it
10268 possible to test domain, address, and local part lists within expansions. Each
10269 condition requires two arguments: an item and a list to match. A trivial
10270 example is:
10271 .code
10272 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10273 .endd
10274 In each case, the second argument may contain any of the allowable items for a
10275 list of the appropriate type. Also, because the second argument (after
10276 expansion) is a standard form of list, it is possible to refer to a named list.
10277 Thus, you can use conditions like this:
10278 .code
10279 ${if match_domain{$domain}{+local_domains}{...
10280 .endd
10281 .cindex "&`+caseful`&"
10282 For address lists, the matching starts off caselessly, but the &`+caseful`&
10283 item can be used, as in all address lists, to cause subsequent items to
10284 have their local parts matched casefully. Domains are always matched
10285 caselessly.
10286
10287 .new
10288 Note that <&'string2'&> is not itself subject to string expansion, unless
10289 Exim was built with the EXPAND_LISTMATCH_RHS option.
10290 .wen
10291
10292 &*Note*&: Host lists are &'not'& supported in this way. This is because
10293 hosts have two identities: a name and an IP address, and it is not clear
10294 how to specify cleanly how such a test would work. However, IP addresses can be
10295 matched using &%match_ip%&.
10296
10297 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10298 .cindex "PAM authentication"
10299 .cindex "AUTH" "with PAM"
10300 .cindex "Solaris" "PAM support"
10301 .cindex "expansion" "PAM authentication test"
10302 .cindex "&%pam%& expansion condition"
10303 &'Pluggable Authentication Modules'&
10304 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10305 available in the latest releases of Solaris and in some GNU/Linux
10306 distributions. The Exim support, which is intended for use in conjunction with
10307 the SMTP AUTH command, is available only if Exim is compiled with
10308 .code
10309 SUPPORT_PAM=yes
10310 .endd
10311 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10312 in some releases of GNU/Linux &%-ldl%& is also needed.
10313
10314 The argument string is first expanded, and the result must be a
10315 colon-separated list of strings. Leading and trailing white space is ignored.
10316 The PAM module is initialized with the service name &"exim"& and the user name
10317 taken from the first item in the colon-separated data string (<&'string1'&>).
10318 The remaining items in the data string are passed over in response to requests
10319 from the authentication function. In the simple case there will only be one
10320 request, for a password, so the data consists of just two strings.
10321
10322 There can be problems if any of the strings are permitted to contain colon
10323 characters. In the usual way, these have to be doubled to avoid being taken as
10324 separators. If the data is being inserted from a variable, the &%sg%& expansion
10325 item can be used to double any existing colons. For example, the configuration
10326 of a LOGIN authenticator might contain this setting:
10327 .code
10328 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10329 .endd
10330 For a PLAIN authenticator you could use:
10331 .code
10332 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10333 .endd
10334 In some operating systems, PAM authentication can be done only from a process
10335 running as root. Since Exim is running as the Exim user when receiving
10336 messages, this means that PAM cannot be used directly in those systems.
10337 A patched version of the &'pam_unix'& module that comes with the
10338 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10339 The patched module allows one special uid/gid combination, in addition to root,
10340 to authenticate. If you build the patched module to allow the Exim user and
10341 group, PAM can then be used from an Exim authenticator.
10342
10343
10344 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10345 .cindex "&'pwcheck'& daemon"
10346 .cindex "Cyrus"
10347 .cindex "expansion" "&'pwcheck'& authentication test"
10348 .cindex "&%pwcheck%& expansion condition"
10349 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10350 This is one way of making it possible for passwords to be checked by a process
10351 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10352 deprecated. Its replacement is &'saslauthd'& (see below).
10353
10354 The pwcheck support is not included in Exim by default. You need to specify
10355 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10356 building Exim. For example:
10357 .code
10358 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10359 .endd
10360 You do not need to install the full Cyrus software suite in order to use
10361 the pwcheck daemon. You can compile and install just the daemon alone
10362 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10363 access to the &_/var/pwcheck_& directory.
10364
10365 The &%pwcheck%& condition takes one argument, which must be the user name and
10366 password, separated by a colon. For example, in a LOGIN authenticator
10367 configuration, you might have this:
10368 .code
10369 server_condition = ${if pwcheck{$auth1:$auth2}}
10370 .endd
10371 Again, for a PLAIN authenticator configuration, this would be:
10372 .code
10373 server_condition = ${if pwcheck{$auth2:$auth3}}
10374 .endd
10375 .vitem &*queue_running*&
10376 .cindex "queue runner" "detecting when delivering from"
10377 .cindex "expansion" "queue runner test"
10378 .cindex "&%queue_running%& expansion condition"
10379 This condition, which has no data, is true during delivery attempts that are
10380 initiated by queue runner processes, and false otherwise.
10381
10382
10383 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10384 .cindex "Radius"
10385 .cindex "expansion" "Radius authentication"
10386 .cindex "&%radius%& expansion condition"
10387 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10388 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10389 the Radius client configuration file in order to build Exim with Radius
10390 support.
10391
10392 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10393 library, using the original API. If you are using release 0.4.0 or later of
10394 this library, you need to set
10395 .code
10396 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10397 .endd
10398 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10399 &%libradius%& library that comes with FreeBSD. To do this, set
10400 .code
10401 RADIUS_LIB_TYPE=RADLIB
10402 .endd
10403 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10404 You may also have to supply a suitable setting in EXTRALIBS so that the
10405 Radius library can be found when Exim is linked.
10406
10407 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10408 Radius client library, which calls the Radius server. The condition is true if
10409 the authentication is successful. For example:
10410 .code
10411 server_condition = ${if radius{<arguments>}}
10412 .endd
10413
10414
10415 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10416         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10417 .cindex "&'saslauthd'& daemon"
10418 .cindex "Cyrus"
10419 .cindex "expansion" "&'saslauthd'& authentication test"
10420 .cindex "&%saslauthd%& expansion condition"
10421 This condition supports user authentication using the Cyrus &'saslauthd'&
10422 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10423 Using this daemon is one way of making it possible for passwords to be checked
10424 by a process that is not running as root.
10425
10426 The saslauthd support is not included in Exim by default. You need to specify
10427 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10428 building Exim. For example:
10429 .code
10430 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10431 .endd
10432 You do not need to install the full Cyrus software suite in order to use
10433 the saslauthd daemon. You can compile and install just the daemon alone
10434 from the Cyrus SASL library.
10435
10436 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10437 two are mandatory. For example:
10438 .code
10439 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10440 .endd
10441 The service and the realm are optional (which is why the arguments are enclosed
10442 in their own set of braces). For details of the meaning of the service and
10443 realm, and how to run the daemon, consult the Cyrus documentation.
10444 .endlist vlist
10445
10446
10447
10448 .section "Combining expansion conditions" "SECID84"
10449 .cindex "expansion" "combining conditions"
10450 Several conditions can be tested at once by combining them using the &%and%&
10451 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10452 conditions on their own, and precede their lists of sub-conditions. Each
10453 sub-condition must be enclosed in braces within the overall braces that contain
10454 the list. No repetition of &%if%& is used.
10455
10456
10457 .vlist
10458 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10459 .cindex "&""or""& expansion condition"
10460 .cindex "expansion" "&""or""& of conditions"
10461 The sub-conditions are evaluated from left to right. The condition is true if
10462 any one of the sub-conditions is true.
10463 For example,
10464 .code
10465 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10466 .endd
10467 When a true sub-condition is found, the following ones are parsed but not
10468 evaluated. If there are several &"match"& sub-conditions the values of the
10469 numeric variables afterwards are taken from the first one that succeeds.
10470
10471 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10472 .cindex "&""and""& expansion condition"
10473 .cindex "expansion" "&""and""& of conditions"
10474 The sub-conditions are evaluated from left to right. The condition is true if
10475 all of the sub-conditions are true. If there are several &"match"&
10476 sub-conditions, the values of the numeric variables afterwards are taken from
10477 the last one. When a false sub-condition is found, the following ones are
10478 parsed but not evaluated.
10479 .endlist
10480 .ecindex IIDexpcond
10481
10482
10483
10484
10485 .section "Expansion variables" "SECTexpvar"
10486 .cindex "expansion" "variables, list of"
10487 This section contains an alphabetical list of all the expansion variables. Some
10488 of them are available only when Exim is compiled with specific options such as
10489 support for TLS or the content scanning extension.
10490
10491 .vlist
10492 .vitem "&$0$&, &$1$&, etc"
10493 .cindex "numerical variables (&$1$& &$2$& etc)"
10494 When a &%match%& expansion condition succeeds, these variables contain the
10495 captured substrings identified by the regular expression during subsequent
10496 processing of the success string of the containing &%if%& expansion item.
10497 However, they do not retain their values afterwards; in fact, their previous
10498 values are restored at the end of processing an &%if%& item. The numerical
10499 variables may also be set externally by some other matching process which
10500 precedes the expansion of the string. For example, the commands available in
10501 Exim filter files include an &%if%& command with its own regular expression
10502 matching condition.
10503
10504 .vitem "&$acl_c...$&"
10505 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10506 can be given any name that starts with &$acl_c$& and is at least six characters
10507 long, but the sixth character must be either a digit or an underscore. For
10508 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10509 variables persist throughout the lifetime of an SMTP connection. They can be
10510 used to pass information between ACLs and between different invocations of the
10511 same ACL. When a message is received, the values of these variables are saved
10512 with the message, and can be accessed by filters, routers, and transports
10513 during subsequent delivery.
10514
10515 .vitem "&$acl_m...$&"
10516 These variables are like the &$acl_c...$& variables, except that their values
10517 are reset after a message has been received. Thus, if several messages are
10518 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10519 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10520 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10521 message is received, the values of these variables are saved with the message,
10522 and can be accessed by filters, routers, and transports during subsequent
10523 delivery.
10524
10525 .vitem &$acl_verify_message$&
10526 .vindex "&$acl_verify_message$&"
10527 After an address verification has failed, this variable contains the failure
10528 message. It retains its value for use in subsequent modifiers. The message can
10529 be preserved by coding like this:
10530 .code
10531 warn !verify = sender
10532      set acl_m0 = $acl_verify_message
10533 .endd
10534 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10535 &%log_message%& modifiers, to include information about the verification
10536 failure.
10537
10538 .vitem &$address_data$&
10539 .vindex "&$address_data$&"
10540 This variable is set by means of the &%address_data%& option in routers. The
10541 value then remains with the address while it is processed by subsequent routers
10542 and eventually a transport. If the transport is handling multiple addresses,
10543 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10544 for more details. &*Note*&: The contents of &$address_data$& are visible in
10545 user filter files.
10546
10547 If &$address_data$& is set when the routers are called from an ACL to verify
10548 a recipient address, the final value is still in the variable for subsequent
10549 conditions and modifiers of the ACL statement. If routing the address caused it
10550 to be redirected to just one address, the child address is also routed as part
10551 of the verification, and in this case the final value of &$address_data$& is
10552 from the child's routing.
10553
10554 If &$address_data$& is set when the routers are called from an ACL to verify a
10555 sender address, the final value is also preserved, but this time in
10556 &$sender_address_data$&, to distinguish it from data from a recipient
10557 address.
10558
10559 In both cases (recipient and sender verification), the value does not persist
10560 after the end of the current ACL statement. If you want to preserve
10561 these values for longer, you can save them in ACL variables.
10562
10563 .vitem &$address_file$&
10564 .vindex "&$address_file$&"
10565 When, as a result of aliasing, forwarding, or filtering, a message is directed
10566 to a specific file, this variable holds the name of the file when the transport
10567 is running. At other times, the variable is empty. For example, using the
10568 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10569 .code
10570 /home/r2d2/savemail
10571 .endd
10572 then when the &(address_file)& transport is running, &$address_file$&
10573 contains the text string &`/home/r2d2/savemail`&.
10574 .cindex "Sieve filter" "value of &$address_file$&"
10575 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10576 then up to the transport configuration to generate an appropriate absolute path
10577 to the relevant file.
10578
10579 .vitem &$address_pipe$&
10580 .vindex "&$address_pipe$&"
10581 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10582 this variable holds the pipe command when the transport is running.
10583
10584 .vitem "&$auth1$& &-- &$auth3$&"
10585 .vindex "&$auth1$&, &$auth2$&, etc"
10586 These variables are used in SMTP authenticators (see chapters
10587 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10588
10589 .vitem &$authenticated_id$&
10590 .cindex "authentication" "id"
10591 .vindex "&$authenticated_id$&"
10592 When a server successfully authenticates a client it may be configured to
10593 preserve some of the authentication information in the variable
10594 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10595 user/password authenticator configuration might preserve the user name for use
10596 in the routers. Note that this is not the same information that is saved in
10597 &$sender_host_authenticated$&.
10598 When a message is submitted locally (that is, not over a TCP connection)
10599 the value of &$authenticated_id$& is normally the login name of the calling
10600 process. However, a trusted user can override this by means of the &%-oMai%&
10601 command line option.
10602
10603
10604
10605
10606 .vitem &$authenticated_sender$&
10607 .cindex "sender" "authenticated"
10608 .cindex "authentication" "sender"
10609 .cindex "AUTH" "on MAIL command"
10610 .vindex "&$authenticated_sender$&"
10611 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10612 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10613 described in section &<<SECTauthparamail>>&. Unless the data is the string
10614 &"<>"&, it is set as the authenticated sender of the message, and the value is
10615 available during delivery in the &$authenticated_sender$& variable. If the
10616 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10617
10618 .vindex "&$qualify_domain$&"
10619 When a message is submitted locally (that is, not over a TCP connection), the
10620 value of &$authenticated_sender$& is an address constructed from the login
10621 name of the calling process and &$qualify_domain$&, except that a trusted user
10622 can override this by means of the &%-oMas%& command line option.
10623
10624
10625 .vitem &$authentication_failed$&
10626 .cindex "authentication" "failure"
10627 .vindex "&$authentication_failed$&"
10628 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10629 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10630 possible to distinguish between &"did not try to authenticate"&
10631 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10632 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10633 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10634 negative response to an AUTH command, including (for example) an attempt to use
10635 an undefined mechanism.
10636
10637 .new
10638 .vitem &$av_failed$&
10639 .cindex "content scanning" "AV scanner failure"
10640 This variable is available when Exim is compiled with the content-scanning
10641 extension. It is set to &"0"& by default, but will be set to &"1"& if any
10642 problem occurs with the virus scanner (specified by &%av_scanner%&) during
10643 the ACL malware condition.
10644 .wen
10645
10646 .vitem &$body_linecount$&
10647 .cindex "message body" "line count"
10648 .cindex "body of message" "line count"
10649 .vindex "&$body_linecount$&"
10650 When a message is being received or delivered, this variable contains the
10651 number of lines in the message's body. See also &$message_linecount$&.
10652
10653 .vitem &$body_zerocount$&
10654 .cindex "message body" "binary zero count"
10655 .cindex "body of message" "binary zero count"
10656 .cindex "binary zero" "in message body"
10657 .vindex "&$body_zerocount$&"
10658 When a message is being received or delivered, this variable contains the
10659 number of binary zero bytes in the message's body.
10660
10661 .vitem &$bounce_recipient$&
10662 .vindex "&$bounce_recipient$&"
10663 This is set to the recipient address of a bounce message while Exim is creating
10664 it. It is useful if a customized bounce message text file is in use (see
10665 chapter &<<CHAPemsgcust>>&).
10666
10667 .vitem &$bounce_return_size_limit$&
10668 .vindex "&$bounce_return_size_limit$&"
10669 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10670 up to a multiple of 1000. It is useful when a customized error message text
10671 file is in use (see chapter &<<CHAPemsgcust>>&).
10672
10673 .vitem &$caller_gid$&
10674 .cindex "gid (group id)" "caller"
10675 .vindex "&$caller_gid$&"
10676 The real group id under which the process that called Exim was running. This is
10677 not the same as the group id of the originator of a message (see
10678 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10679 incarnation normally contains the Exim gid.
10680
10681 .vitem &$caller_uid$&
10682 .cindex "uid (user id)" "caller"
10683 .vindex "&$caller_uid$&"
10684 The real user id under which the process that called Exim was running. This is
10685 not the same as the user id of the originator of a message (see
10686 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10687 incarnation normally contains the Exim uid.
10688
10689 .vitem &$compile_date$&
10690 .vindex "&$compile_date$&"
10691 The date on which the Exim binary was compiled.
10692
10693 .vitem &$compile_number$&
10694 .vindex "&$compile_number$&"
10695 The building process for Exim keeps a count of the number
10696 of times it has been compiled. This serves to distinguish different
10697 compilations of the same version of the program.
10698
10699 .vitem &$demime_errorlevel$&
10700 .vindex "&$demime_errorlevel$&"
10701 This variable is available when Exim is compiled with
10702 the content-scanning extension and the obsolete &%demime%& condition. For
10703 details, see section &<<SECTdemimecond>>&.
10704
10705 .vitem &$demime_reason$&
10706 .vindex "&$demime_reason$&"
10707 This variable is available when Exim is compiled with the
10708 content-scanning extension and the obsolete &%demime%& condition. For details,
10709 see section &<<SECTdemimecond>>&.
10710
10711 .vitem &$dnslist_domain$& &&&
10712        &$dnslist_matched$& &&&
10713        &$dnslist_text$& &&&
10714        &$dnslist_value$&
10715 .vindex "&$dnslist_domain$&"
10716 .vindex "&$dnslist_matched$&"
10717 .vindex "&$dnslist_text$&"
10718 .vindex "&$dnslist_value$&"
10719 .cindex "black list (DNS)"
10720 When a DNS (black) list lookup succeeds, these variables are set to contain
10721 the following data from the lookup: the list's domain name, the key that was
10722 looked up, the contents of any associated TXT record, and the value from the
10723 main A record. See section &<<SECID204>>& for more details.
10724
10725 .vitem &$domain$&
10726 .vindex "&$domain$&"
10727 When an address is being routed, or delivered on its own, this variable
10728 contains the domain. Uppercase letters in the domain are converted into lower
10729 case for &$domain$&.
10730
10731 Global address rewriting happens when a message is received, so the value of
10732 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10733 is set during user filtering, but not during system filtering, because a
10734 message may have many recipients and the system filter is called just once.
10735
10736 When more than one address is being delivered at once (for example, several
10737 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10738 have the same domain. Transports can be restricted to handling only one domain
10739 at a time if the value of &$domain$& is required at transport time &-- this is
10740 the default for local transports. For further details of the environment in
10741 which local transports are run, see chapter &<<CHAPenvironment>>&.
10742
10743 .oindex "&%delay_warning_condition%&"
10744 At the end of a delivery, if all deferred addresses have the same domain, it is
10745 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10746
10747 The &$domain$& variable is also used in some other circumstances:
10748
10749 .ilist
10750 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10751 the recipient address. The domain of the &'sender'& address is in
10752 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10753 normally set during the running of the MAIL ACL. However, if the sender address
10754 is verified with a callout during the MAIL ACL, the sender domain is placed in
10755 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10756 the &(smtp)& transport.
10757
10758 .next
10759 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10760 &$domain$& contains the domain portion of the address that is being rewritten;
10761 it can be used in the expansion of the replacement address, for example, to
10762 rewrite domains by file lookup.
10763
10764 .next
10765 With one important exception, whenever a domain list is being scanned,
10766 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10767 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10768 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10769 that, in a RCPT ACL, the sender domain list can be dependent on the
10770 recipient domain (which is what is in &$domain$& at this time).
10771
10772 .next
10773 .cindex "ETRN" "value of &$domain$&"
10774 .oindex "&%smtp_etrn_command%&"
10775 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10776 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10777 .endlist
10778
10779
10780 .vitem &$domain_data$&
10781 .vindex "&$domain_data$&"
10782 When the &%domains%& option on a router matches a domain by
10783 means of a lookup, the data read by the lookup is available during the running
10784 of the router as &$domain_data$&. In addition, if the driver routes the
10785 address to a transport, the value is available in that transport. If the
10786 transport is handling multiple addresses, the value from the first address is
10787 used.
10788
10789 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10790 domain by means of a lookup. The data read by the lookup is available during
10791 the rest of the ACL statement. In all other situations, this variable expands
10792 to nothing.
10793
10794 .vitem &$exim_gid$&
10795 .vindex "&$exim_gid$&"
10796 This variable contains the numerical value of the Exim group id.
10797
10798 .vitem &$exim_path$&
10799 .vindex "&$exim_path$&"
10800 This variable contains the path to the Exim binary.
10801
10802 .vitem &$exim_uid$&
10803 .vindex "&$exim_uid$&"
10804 This variable contains the numerical value of the Exim user id.
10805
10806 .vitem &$found_extension$&
10807 .vindex "&$found_extension$&"
10808 This variable is available when Exim is compiled with the
10809 content-scanning extension and the obsolete &%demime%& condition. For details,
10810 see section &<<SECTdemimecond>>&.
10811
10812 .vitem &$header_$&<&'name'&>
10813 This is not strictly an expansion variable. It is expansion syntax for
10814 inserting the message header line with the given name. Note that the name must
10815 be terminated by colon or white space, because it may contain a wide variety of
10816 characters. Note also that braces must &'not'& be used.
10817
10818 .vitem &$home$&
10819 .vindex "&$home$&"
10820 When the &%check_local_user%& option is set for a router, the user's home
10821 directory is placed in &$home$& when the check succeeds. In particular, this
10822 means it is set during the running of users' filter files. A router may also
10823 explicitly set a home directory for use by a transport; this can be overridden
10824 by a setting on the transport itself.
10825
10826 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10827 of the environment variable HOME.
10828
10829 .vitem &$host$&
10830 .vindex "&$host$&"
10831 If a router assigns an address to a transport (any transport), and passes a
10832 list of hosts with the address, the value of &$host$& when the transport starts
10833 to run is the name of the first host on the list. Note that this applies both
10834 to local and remote transports.
10835
10836 .cindex "transport" "filter"
10837 .cindex "filter" "transport filter"
10838 For the &(smtp)& transport, if there is more than one host, the value of
10839 &$host$& changes as the transport works its way through the list. In
10840 particular, when the &(smtp)& transport is expanding its options for encryption
10841 using TLS, or for specifying a transport filter (see chapter
10842 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10843 is connected.
10844
10845 When used in the client part of an authenticator configuration (see chapter
10846 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10847 client is connected.
10848
10849
10850 .vitem &$host_address$&
10851 .vindex "&$host_address$&"
10852 This variable is set to the remote host's IP address whenever &$host$& is set
10853 for a remote connection. It is also set to the IP address that is being checked
10854 when the &%ignore_target_hosts%& option is being processed.
10855
10856 .vitem &$host_data$&
10857 .vindex "&$host_data$&"
10858 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10859 result of the lookup is made available in the &$host_data$& variable. This
10860 allows you, for example, to do things like this:
10861 .code
10862 deny  hosts = net-lsearch;/some/file
10863 message = $host_data
10864 .endd
10865 .vitem &$host_lookup_deferred$&
10866 .cindex "host name" "lookup, failure of"
10867 .vindex "&$host_lookup_deferred$&"
10868 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10869 message comes from a remote host and there is an attempt to look up the host's
10870 name from its IP address, and the attempt is not successful, one of these
10871 variables is set to &"1"&.
10872
10873 .ilist
10874 If the lookup receives a definite negative response (for example, a DNS lookup
10875 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10876
10877 .next
10878 If there is any kind of problem during the lookup, such that Exim cannot
10879 tell whether or not the host name is defined (for example, a timeout for a DNS
10880 lookup), &$host_lookup_deferred$& is set to &"1"&.
10881 .endlist ilist
10882
10883 Looking up a host's name from its IP address consists of more than just a
10884 single reverse lookup. Exim checks that a forward lookup of at least one of the
10885 names it receives from a reverse lookup yields the original IP address. If this
10886 is not the case, Exim does not accept the looked up name(s), and
10887 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10888 IP address (for example, the existence of a PTR record in the DNS) is not
10889 sufficient on its own for the success of a host name lookup. If the reverse
10890 lookup succeeds, but there is a lookup problem such as a timeout when checking
10891 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
10892 &"1"&. See also &$sender_host_name$&.
10893
10894 .vitem &$host_lookup_failed$&
10895 .vindex "&$host_lookup_failed$&"
10896 See &$host_lookup_deferred$&.
10897
10898
10899 .vitem &$inode$&
10900 .vindex "&$inode$&"
10901 The only time this variable is set is while expanding the &%directory_file%&
10902 option in the &(appendfile)& transport. The variable contains the inode number
10903 of the temporary file which is about to be renamed. It can be used to construct
10904 a unique name for the file.
10905
10906 .vitem &$interface_address$&
10907 .vindex "&$interface_address$&"
10908 This is an obsolete name for &$received_ip_address$&.
10909
10910 .vitem &$interface_port$&
10911 .vindex "&$interface_port$&"
10912 This is an obsolete name for &$received_port$&.
10913
10914 .vitem &$item$&
10915 .vindex "&$item$&"
10916 This variable is used during the expansion of &*forall*& and &*forany*&
10917 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
10918 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
10919 empty.
10920
10921 .vitem &$ldap_dn$&
10922 .vindex "&$ldap_dn$&"
10923 This variable, which is available only when Exim is compiled with LDAP support,
10924 contains the DN from the last entry in the most recently successful LDAP
10925 lookup.
10926
10927 .vitem &$load_average$&
10928 .vindex "&$load_average$&"
10929 This variable contains the system load average, multiplied by 1000 so that it
10930 is an integer. For example, if the load average is 0.21, the value of the
10931 variable is 210. The value is recomputed every time the variable is referenced.
10932
10933 .vitem &$local_part$&
10934 .vindex "&$local_part$&"
10935 When an address is being routed, or delivered on its own, this
10936 variable contains the local part. When a number of addresses are being
10937 delivered together (for example, multiple RCPT commands in an SMTP
10938 session), &$local_part$& is not set.
10939
10940 Global address rewriting happens when a message is received, so the value of
10941 &$local_part$& during routing and delivery is the value after rewriting.
10942 &$local_part$& is set during user filtering, but not during system filtering,
10943 because a message may have many recipients and the system filter is called just
10944 once.
10945
10946 .vindex "&$local_part_prefix$&"
10947 .vindex "&$local_part_suffix$&"
10948 If a local part prefix or suffix has been recognized, it is not included in the
10949 value of &$local_part$& during routing and subsequent delivery. The values of
10950 any prefix or suffix are in &$local_part_prefix$& and
10951 &$local_part_suffix$&, respectively.
10952
10953 When a message is being delivered to a file, pipe, or autoreply transport as a
10954 result of aliasing or forwarding, &$local_part$& is set to the local part of
10955 the parent address, not to the file name or command (see &$address_file$& and
10956 &$address_pipe$&).
10957
10958 When an ACL is running for a RCPT command, &$local_part$& contains the
10959 local part of the recipient address.
10960
10961 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10962 &$local_part$& contains the local part of the address that is being rewritten;
10963 it can be used in the expansion of the replacement address, for example.
10964
10965 In all cases, all quoting is removed from the local part. For example, for both
10966 the addresses
10967 .code
10968 "abc:xyz"@test.example
10969 abc\:xyz@test.example
10970 .endd
10971 the value of &$local_part$& is
10972 .code
10973 abc:xyz
10974 .endd
10975 If you use &$local_part$& to create another address, you should always wrap it
10976 inside a quoting operator. For example, in a &(redirect)& router you could
10977 have:
10978 .code
10979 data = ${quote_local_part:$local_part}@new.domain.example
10980 .endd
10981 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
10982 to process local parts in a case-dependent manner in a router, you can set the
10983 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
10984
10985 .vitem &$local_part_data$&
10986 .vindex "&$local_part_data$&"
10987 When the &%local_parts%& option on a router matches a local part by means of a
10988 lookup, the data read by the lookup is available during the running of the
10989 router as &$local_part_data$&. In addition, if the driver routes the address
10990 to a transport, the value is available in that transport. If the transport is
10991 handling multiple addresses, the value from the first address is used.
10992
10993 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
10994 matches a local part by means of a lookup. The data read by the lookup is
10995 available during the rest of the ACL statement. In all other situations, this
10996 variable expands to nothing.
10997
10998 .vitem &$local_part_prefix$&
10999 .vindex "&$local_part_prefix$&"
11000 When an address is being routed or delivered, and a
11001 specific prefix for the local part was recognized, it is available in this
11002 variable, having been removed from &$local_part$&.
11003
11004 .vitem &$local_part_suffix$&
11005 .vindex "&$local_part_suffix$&"
11006 When an address is being routed or delivered, and a
11007 specific suffix for the local part was recognized, it is available in this
11008 variable, having been removed from &$local_part$&.
11009
11010 .vitem &$local_scan_data$&
11011 .vindex "&$local_scan_data$&"
11012 This variable contains the text returned by the &[local_scan()]& function when
11013 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11014
11015 .vitem &$local_user_gid$&
11016 .vindex "&$local_user_gid$&"
11017 See &$local_user_uid$&.
11018
11019 .vitem &$local_user_uid$&
11020 .vindex "&$local_user_uid$&"
11021 This variable and &$local_user_gid$& are set to the uid and gid after the
11022 &%check_local_user%& router precondition succeeds. This means that their values
11023 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11024 and &%condition%&), for the &%address_data%& expansion, and for any
11025 router-specific expansions. At all other times, the values in these variables
11026 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11027
11028 .vitem &$localhost_number$&
11029 .vindex "&$localhost_number$&"
11030 This contains the expanded value of the
11031 &%localhost_number%& option. The expansion happens after the main options have
11032 been read.
11033
11034 .vitem &$log_inodes$&
11035 .vindex "&$log_inodes$&"
11036 The number of free inodes in the disk partition where Exim's
11037 log files are being written. The value is recalculated whenever the variable is
11038 referenced. If the relevant file system does not have the concept of inodes,
11039 the value of is -1. See also the &%check_log_inodes%& option.
11040
11041 .vitem &$log_space$&
11042 .vindex "&$log_space$&"
11043 The amount of free space (as a number of kilobytes) in the disk
11044 partition where Exim's log files are being written. The value is recalculated
11045 whenever the variable is referenced. If the operating system does not have the
11046 ability to find the amount of free space (only true for experimental systems),
11047 the space value is -1. See also the &%check_log_space%& option.
11048
11049
11050 .vitem &$mailstore_basename$&
11051 .vindex "&$mailstore_basename$&"
11052 This variable is set only when doing deliveries in &"mailstore"& format in the
11053 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11054 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11055 contains the basename of the files that are being written, that is, the name
11056 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11057 variable is empty.
11058
11059 .vitem &$malware_name$&
11060 .vindex "&$malware_name$&"
11061 This variable is available when Exim is compiled with the
11062 content-scanning extension. It is set to the name of the virus that was found
11063 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11064
11065 .vitem &$max_received_linelength$&
11066 .vindex "&$max_received_linelength$&"
11067 .cindex "maximum" "line length"
11068 .cindex "line length" "maximum"
11069 This variable contains the number of bytes in the longest line that was
11070 received as part of the message, not counting the line termination
11071 character(s).
11072
11073 .vitem &$message_age$&
11074 .cindex "message" "age of"
11075 .vindex "&$message_age$&"
11076 This variable is set at the start of a delivery attempt to contain the number
11077 of seconds since the message was received. It does not change during a single
11078 delivery attempt.
11079
11080 .vitem &$message_body$&
11081 .cindex "body of message" "expansion variable"
11082 .cindex "message body" "in expansion"
11083 .cindex "binary zero" "in message body"
11084 .vindex "&$message_body$&"
11085 .oindex "&%message_body_visible%&"
11086 This variable contains the initial portion of a message's body while it is
11087 being delivered, and is intended mainly for use in filter files. The maximum
11088 number of characters of the body that are put into the variable is set by the
11089 &%message_body_visible%& configuration option; the default is 500.
11090
11091 .oindex "&%message_body_newlines%&"
11092 By default, newlines are converted into spaces in &$message_body$&, to make it
11093 easier to search for phrases that might be split over a line break. However,
11094 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11095 zeros are always converted into spaces.
11096
11097 .vitem &$message_body_end$&
11098 .cindex "body of message" "expansion variable"
11099 .cindex "message body" "in expansion"
11100 .vindex "&$message_body_end$&"
11101 This variable contains the final portion of a message's
11102 body while it is being delivered. The format and maximum size are as for
11103 &$message_body$&.
11104
11105 .vitem &$message_body_size$&
11106 .cindex "body of message" "size"
11107 .cindex "message body" "size"
11108 .vindex "&$message_body_size$&"
11109 When a message is being delivered, this variable contains the size of the body
11110 in bytes. The count starts from the character after the blank line that
11111 separates the body from the header. Newlines are included in the count. See
11112 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11113
11114 .vitem &$message_exim_id$&
11115 .vindex "&$message_exim_id$&"
11116 When a message is being received or delivered, this variable contains the
11117 unique message id that is generated and used by Exim to identify the message.
11118 An id is not created for a message until after its header has been successfully
11119 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11120 line; it is the local id that Exim assigns to the message, for example:
11121 &`1BXTIK-0001yO-VA`&.
11122
11123 .vitem &$message_headers$&
11124 .vindex &$message_headers$&
11125 This variable contains a concatenation of all the header lines when a message
11126 is being processed, except for lines added by routers or transports. The header
11127 lines are separated by newline characters. Their contents are decoded in the
11128 same way as a header line that is inserted by &%bheader%&.
11129
11130 .vitem &$message_headers_raw$&
11131 .vindex &$message_headers_raw$&
11132 This variable is like &$message_headers$& except that no processing of the
11133 contents of header lines is done.
11134
11135 .vitem &$message_id$&
11136 This is an old name for &$message_exim_id$&, which is now deprecated.
11137
11138 .vitem &$message_linecount$&
11139 .vindex "&$message_linecount$&"
11140 This variable contains the total number of lines in the header and body of the
11141 message. Compare &$body_linecount$&, which is the count for the body only.
11142 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11143 number of lines received. Before delivery happens (that is, before filters,
11144 routers, and transports run) the count is increased to include the
11145 &'Received:'& header line that Exim standardly adds, and also any other header
11146 lines that are added by ACLs. The blank line that separates the message header
11147 from the body is not counted.
11148
11149 As with the special case of &$message_size$&, during the expansion of the
11150 appendfile transport's maildir_tag option in maildir format, the value of
11151 &$message_linecount$& is the precise size of the number of newlines in the
11152 file that has been written (minus one for the blank line between the
11153 header and the body).
11154
11155 Here is an example of the use of this variable in a DATA ACL:
11156 .code
11157 deny message   = Too many lines in message header
11158      condition = \
11159       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11160 .endd
11161 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11162 message has not yet been received.
11163
11164 .vitem &$message_size$&
11165 .cindex "size" "of message"
11166 .cindex "message" "size"
11167 .vindex "&$message_size$&"
11168 When a message is being processed, this variable contains its size in bytes. In
11169 most cases, the size includes those headers that were received with the
11170 message, but not those (such as &'Envelope-to:'&) that are added to individual
11171 deliveries as they are written. However, there is one special case: during the
11172 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11173 doing a delivery in maildir format, the value of &$message_size$& is the
11174 precise size of the file that has been written. See also
11175 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11176
11177 .cindex "RCPT" "value of &$message_size$&"
11178 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11179 contains the size supplied on the MAIL command, or -1 if no size was given. The
11180 value may not, of course, be truthful.
11181
11182 .vitem &$mime_$&&'xxx'&
11183 A number of variables whose names start with &$mime$& are
11184 available when Exim is compiled with the content-scanning extension. For
11185 details, see section &<<SECTscanmimepart>>&.
11186
11187 .vitem "&$n0$& &-- &$n9$&"
11188 These variables are counters that can be incremented by means
11189 of the &%add%& command in filter files.
11190
11191 .vitem &$original_domain$&
11192 .vindex "&$domain$&"
11193 .vindex "&$original_domain$&"
11194 When a top-level address is being processed for delivery, this contains the
11195 same value as &$domain$&. However, if a &"child"& address (for example,
11196 generated by an alias, forward, or filter file) is being processed, this
11197 variable contains the domain of the original address (lower cased). This
11198 differs from &$parent_domain$& only when there is more than one level of
11199 aliasing or forwarding. When more than one address is being delivered in a
11200 single transport run, &$original_domain$& is not set.
11201
11202 If a new address is created by means of a &%deliver%& command in a system
11203 filter, it is set up with an artificial &"parent"& address. This has the local
11204 part &'system-filter'& and the default qualify domain.
11205
11206 .vitem &$original_local_part$&
11207 .vindex "&$local_part$&"
11208 .vindex "&$original_local_part$&"
11209 When a top-level address is being processed for delivery, this contains the
11210 same value as &$local_part$&, unless a prefix or suffix was removed from the
11211 local part, because &$original_local_part$& always contains the full local
11212 part. When a &"child"& address (for example, generated by an alias, forward, or
11213 filter file) is being processed, this variable contains the full local part of
11214 the original address.
11215
11216 If the router that did the redirection processed the local part
11217 case-insensitively, the value in &$original_local_part$& is in lower case.
11218 This variable differs from &$parent_local_part$& only when there is more than
11219 one level of aliasing or forwarding. When more than one address is being
11220 delivered in a single transport run, &$original_local_part$& is not set.
11221
11222 If a new address is created by means of a &%deliver%& command in a system
11223 filter, it is set up with an artificial &"parent"& address. This has the local
11224 part &'system-filter'& and the default qualify domain.
11225
11226 .vitem &$originator_gid$&
11227 .cindex "gid (group id)" "of originating user"
11228 .cindex "sender" "gid"
11229 .vindex "&$caller_gid$&"
11230 .vindex "&$originator_gid$&"
11231 This variable contains the value of &$caller_gid$& that was set when the
11232 message was received. For messages received via the command line, this is the
11233 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11234 normally the gid of the Exim user.
11235
11236 .vitem &$originator_uid$&
11237 .cindex "uid (user id)" "of originating user"
11238 .cindex "sender" "uid"
11239 .vindex "&$caller_uid$&"
11240 .vindex "&$originaltor_uid$&"
11241 The value of &$caller_uid$& that was set when the message was received. For
11242 messages received via the command line, this is the uid of the sending user.
11243 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11244 user.
11245
11246 .vitem &$parent_domain$&
11247 .vindex "&$parent_domain$&"
11248 This variable is similar to &$original_domain$& (see
11249 above), except that it refers to the immediately preceding parent address.
11250
11251 .vitem &$parent_local_part$&
11252 .vindex "&$parent_local_part$&"
11253 This variable is similar to &$original_local_part$&
11254 (see above), except that it refers to the immediately preceding parent address.
11255
11256 .vitem &$pid$&
11257 .cindex "pid (process id)" "of current process"
11258 .vindex "&$pid$&"
11259 This variable contains the current process id.
11260
11261 .vitem &$pipe_addresses$&
11262 .cindex "filter" "transport filter"
11263 .cindex "transport" "filter"
11264 .vindex "&$pipe_addresses$&"
11265 This is not an expansion variable, but is mentioned here because the string
11266 &`$pipe_addresses`& is handled specially in the command specification for the
11267 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11268 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11269 It cannot be used in general expansion strings, and provokes an &"unknown
11270 variable"& error if encountered.
11271
11272 .vitem &$primary_hostname$&
11273 .vindex "&$primary_hostname$&"
11274 This variable contains the value set by &%primary_hostname%& in the
11275 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11276 a single-component name, Exim calls &[gethostbyname()]& (or
11277 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11278 qualified host name. See also &$smtp_active_hostname$&.
11279
11280
11281 .vitem &$prvscheck_address$&
11282 This variable is used in conjunction with the &%prvscheck%& expansion item,
11283 which is described in sections &<<SECTexpansionitems>>& and
11284 &<<SECTverifyPRVS>>&.
11285
11286 .vitem &$prvscheck_keynum$&
11287 This variable is used in conjunction with the &%prvscheck%& expansion item,
11288 which is described in sections &<<SECTexpansionitems>>& and
11289 &<<SECTverifyPRVS>>&.
11290
11291 .vitem &$prvscheck_result$&
11292 This variable is used in conjunction with the &%prvscheck%& expansion item,
11293 which is described in sections &<<SECTexpansionitems>>& and
11294 &<<SECTverifyPRVS>>&.
11295
11296 .vitem &$qualify_domain$&
11297 .vindex "&$qualify_domain$&"
11298 The value set for the &%qualify_domain%& option in the configuration file.
11299
11300 .vitem &$qualify_recipient$&
11301 .vindex "&$qualify_recipient$&"
11302 The value set for the &%qualify_recipient%& option in the configuration file,
11303 or if not set, the value of &$qualify_domain$&.
11304
11305 .vitem &$rcpt_count$&
11306 .vindex "&$rcpt_count$&"
11307 When a message is being received by SMTP, this variable contains the number of
11308 RCPT commands received for the current message. If this variable is used in a
11309 RCPT ACL, its value includes the current command.
11310
11311 .vitem &$rcpt_defer_count$&
11312 .vindex "&$rcpt_defer_count$&"
11313 .cindex "4&'xx'& responses" "count of"
11314 When a message is being received by SMTP, this variable contains the number of
11315 RCPT commands in the current message that have previously been rejected with a
11316 temporary (4&'xx'&) response.
11317
11318 .vitem &$rcpt_fail_count$&
11319 .vindex "&$rcpt_fail_count$&"
11320 When a message is being received by SMTP, this variable contains the number of
11321 RCPT commands in the current message that have previously been rejected with a
11322 permanent (5&'xx'&) response.
11323
11324 .vitem &$received_count$&
11325 .vindex "&$received_count$&"
11326 This variable contains the number of &'Received:'& header lines in the message,
11327 including the one added by Exim (so its value is always greater than zero). It
11328 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11329 delivering.
11330
11331 .vitem &$received_for$&
11332 .vindex "&$received_for$&"
11333 If there is only a single recipient address in an incoming message, this
11334 variable contains that address when the &'Received:'& header line is being
11335 built. The value is copied after recipient rewriting has happened, but before
11336 the &[local_scan()]& function is run.
11337
11338 .vitem &$received_ip_address$&
11339 .vindex "&$received_ip_address$&"
11340 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11341 variable is set to the address of the local IP interface, and &$received_port$&
11342 is set to the local port number. (The remote IP address and port are in
11343 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11344 the port value is -1 unless it has been set using the &%-oMi%& command line
11345 option.
11346
11347 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11348 could be used, for example, to make the file name for a TLS certificate depend
11349 on which interface and/or port is being used for the incoming connection. The
11350 values of &$received_ip_address$& and &$received_port$& are saved with any
11351 messages that are received, thus making these variables available at delivery
11352 time.
11353
11354 &*Note:*& There are no equivalent variables for outgoing connections, because
11355 the values are unknown (unless they are explicitly set by options of the
11356 &(smtp)& transport).
11357
11358 .vitem &$received_port$&
11359 .vindex "&$received_port$&"
11360 See &$received_ip_address$&.
11361
11362 .vitem &$received_protocol$&
11363 .vindex "&$received_protocol$&"
11364 When a message is being processed, this variable contains the name of the
11365 protocol by which it was received. Most of the names used by Exim are defined
11366 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11367 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11368 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11369 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11370 connection and the client was successfully authenticated.
11371
11372 Exim uses the protocol name &"smtps"& for the case when encryption is
11373 automatically set up on connection without the use of STARTTLS (see
11374 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11375 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11376 where the client initially uses EHLO, sets up an encrypted connection using
11377 STARTTLS, and then uses HELO afterwards.
11378
11379 The &%-oMr%& option provides a way of specifying a custom protocol name for
11380 messages that are injected locally by trusted callers. This is commonly used to
11381 identify messages that are being re-injected after some kind of scanning.
11382
11383 .vitem &$received_time$&
11384 .vindex "&$received_time$&"
11385 This variable contains the date and time when the current message was received,
11386 as a number of seconds since the start of the Unix epoch.
11387
11388 .vitem &$recipient_data$&
11389 .vindex "&$recipient_data$&"
11390 This variable is set after an indexing lookup success in an ACL &%recipients%&
11391 condition. It contains the data from the lookup, and the value remains set
11392 until the next &%recipients%& test. Thus, you can do things like this:
11393 .display
11394 &`require recipients  = cdb*@;/some/file`&
11395 &`deny    `&&'some further test involving'& &`$recipient_data`&
11396 .endd
11397 &*Warning*&: This variable is set only when a lookup is used as an indexing
11398 method in the address list, using the semicolon syntax as in the example above.
11399 The variable is not set for a lookup that is used as part of the string
11400 expansion that all such lists undergo before being interpreted.
11401
11402 .vitem &$recipient_verify_failure$&
11403 .vindex "&$recipient_verify_failure$&"
11404 In an ACL, when a recipient verification fails, this variable contains
11405 information about the failure. It is set to one of the following words:
11406
11407 .ilist
11408 &"qualify"&: The address was unqualified (no domain), and the message
11409 was neither local nor came from an exempted host.
11410
11411 .next
11412 &"route"&: Routing failed.
11413
11414 .next
11415 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11416 or before the MAIL command (that is, on initial connection, HELO, or
11417 MAIL).
11418
11419 .next
11420 &"recipient"&: The RCPT command in a callout was rejected.
11421 .next
11422
11423 &"postmaster"&: The postmaster check in a callout was rejected.
11424 .endlist
11425
11426 The main use of this variable is expected to be to distinguish between
11427 rejections of MAIL and rejections of RCPT.
11428
11429 .vitem &$recipients$&
11430 .vindex "&$recipients$&"
11431 This variable contains a list of envelope recipients for a message. A comma and
11432 a space separate the addresses in the replacement text. However, the variable
11433 is not generally available, to prevent exposure of Bcc recipients in
11434 unprivileged users' filter files. You can use &$recipients$& only in these
11435 cases:
11436
11437 .olist
11438 In a system filter file.
11439 .next
11440 In the ACLs associated with the DATA command and with non-SMTP messages, that
11441 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11442 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11443 &%acl_not_smtp_mime%&.
11444 .next
11445 From within a &[local_scan()]& function.
11446 .endlist
11447
11448
11449 .vitem &$recipients_count$&
11450 .vindex "&$recipients_count$&"
11451 When a message is being processed, this variable contains the number of
11452 envelope recipients that came with the message. Duplicates are not excluded
11453 from the count. While a message is being received over SMTP, the number
11454 increases for each accepted recipient. It can be referenced in an ACL.
11455
11456
11457 .vitem &$regex_match_string$&
11458 .vindex "&$regex_match_string$&"
11459 This variable is set to contain the matching regular expression after a
11460 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11461
11462
11463 .vitem &$reply_address$&
11464 .vindex "&$reply_address$&"
11465 When a message is being processed, this variable contains the contents of the
11466 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11467 contents of the &'From:'& header line. Apart from the removal of leading
11468 white space, the value is not processed in any way. In particular, no RFC 2047
11469 decoding or character code translation takes place.
11470
11471 .vitem &$return_path$&
11472 .vindex "&$return_path$&"
11473 When a message is being delivered, this variable contains the return path &--
11474 the sender field that will be sent as part of the envelope. It is not enclosed
11475 in <> characters. At the start of routing an address, &$return_path$& has the
11476 same value as &$sender_address$&, but if, for example, an incoming message to a
11477 mailing list has been expanded by a router which specifies a different address
11478 for bounce messages, &$return_path$& subsequently contains the new bounce
11479 address, whereas &$sender_address$& always contains the original sender address
11480 that was received with the message. In other words, &$sender_address$& contains
11481 the incoming envelope sender, and &$return_path$& contains the outgoing
11482 envelope sender.
11483
11484 .vitem &$return_size_limit$&
11485 .vindex "&$return_size_limit$&"
11486 This is an obsolete name for &$bounce_return_size_limit$&.
11487
11488 .vitem &$runrc$&
11489 .cindex "return code" "from &%run%& expansion"
11490 .vindex "&$runrc$&"
11491 This variable contains the return code from a command that is run by the
11492 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11493 assume the order in which option values are expanded, except for those
11494 preconditions whose order of testing is documented. Therefore, you cannot
11495 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11496 another.
11497
11498 .vitem &$self_hostname$&
11499 .oindex "&%self%&" "value of host name"
11500 .vindex "&$self_hostname$&"
11501 When an address is routed to a supposedly remote host that turns out to be the
11502 local host, what happens is controlled by the &%self%& generic router option.
11503 One of its values causes the address to be passed to another router. When this
11504 happens, &$self_hostname$& is set to the name of the local host that the
11505 original router encountered. In other circumstances its contents are null.
11506
11507 .vitem &$sender_address$&
11508 .vindex "&$sender_address$&"
11509 When a message is being processed, this variable contains the sender's address
11510 that was received in the message's envelope. The case of letters in the address
11511 is retained, in both the local part and the domain. For bounce messages, the
11512 value of this variable is the empty string. See also &$return_path$&.
11513
11514 .vitem &$sender_address_data$&
11515 .vindex "&$address_data$&"
11516 .vindex "&$sender_address_data$&"
11517 If &$address_data$& is set when the routers are called from an ACL to verify a
11518 sender address, the final value is preserved in &$sender_address_data$&, to
11519 distinguish it from data from a recipient address. The value does not persist
11520 after the end of the current ACL statement. If you want to preserve it for
11521 longer, you can save it in an ACL variable.
11522
11523 .vitem &$sender_address_domain$&
11524 .vindex "&$sender_address_domain$&"
11525 The domain portion of &$sender_address$&.
11526
11527 .vitem &$sender_address_local_part$&
11528 .vindex "&$sender_address_local_part$&"
11529 The local part portion of &$sender_address$&.
11530
11531 .vitem &$sender_data$&
11532 .vindex "&$sender_data$&"
11533 This variable is set after a lookup success in an ACL &%senders%& condition or
11534 in a router &%senders%& option. It contains the data from the lookup, and the
11535 value remains set until the next &%senders%& test. Thus, you can do things like
11536 this:
11537 .display
11538 &`require senders      = cdb*@;/some/file`&
11539 &`deny    `&&'some further test involving'& &`$sender_data`&
11540 .endd
11541 &*Warning*&: This variable is set only when a lookup is used as an indexing
11542 method in the address list, using the semicolon syntax as in the example above.
11543 The variable is not set for a lookup that is used as part of the string
11544 expansion that all such lists undergo before being interpreted.
11545
11546 .vitem &$sender_fullhost$&
11547 .vindex "&$sender_fullhost$&"
11548 When a message is received from a remote host, this variable contains the host
11549 name and IP address in a single string. It ends with the IP address in square
11550 brackets, followed by a colon and a port number if the logging of ports is
11551 enabled. The format of the rest of the string depends on whether the host
11552 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11553 looking up its IP address. (Looking up the IP address can be forced by the
11554 &%host_lookup%& option, independent of verification.) A plain host name at the
11555 start of the string is a verified host name; if this is not present,
11556 verification either failed or was not requested. A host name in parentheses is
11557 the argument of a HELO or EHLO command. This is omitted if it is identical to
11558 the verified host name or to the host's IP address in square brackets.
11559
11560 .vitem &$sender_helo_name$&
11561 .vindex "&$sender_helo_name$&"
11562 When a message is received from a remote host that has issued a HELO or EHLO
11563 command, the argument of that command is placed in this variable. It is also
11564 set if HELO or EHLO is used when a message is received using SMTP locally via
11565 the &%-bs%& or &%-bS%& options.
11566
11567 .vitem &$sender_host_address$&
11568 .vindex "&$sender_host_address$&"
11569 When a message is received from a remote host, this variable contains that
11570 host's IP address. For locally submitted messages, it is empty.
11571
11572 .vitem &$sender_host_authenticated$&
11573 .vindex "&$sender_host_authenticated$&"
11574 This variable contains the name (not the public name) of the authenticator
11575 driver that successfully authenticated the client from which the message was
11576 received. It is empty if there was no successful authentication. See also
11577 &$authenticated_id$&.
11578
11579 .vitem &$sender_host_name$&
11580 .vindex "&$sender_host_name$&"
11581 When a message is received from a remote host, this variable contains the
11582 host's name as obtained by looking up its IP address. For messages received by
11583 other means, this variable is empty.
11584
11585 .vindex "&$host_lookup_failed$&"
11586 If the host name has not previously been looked up, a reference to
11587 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11588 A looked up name is accepted only if it leads back to the original IP address
11589 via a forward lookup. If either the reverse or the forward lookup fails to find
11590 any data, or if the forward lookup does not yield the original IP address,
11591 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11592
11593 .vindex "&$host_lookup_deferred$&"
11594 However, if either of the lookups cannot be completed (for example, there is a
11595 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11596 &$host_lookup_failed$& remains set to &"0"&.
11597
11598 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11599 host name again if there is a subsequent reference to &$sender_host_name$&
11600 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11601 is set to &"1"&.
11602
11603 Exim does not automatically look up every calling host's name. If you want
11604 maximum efficiency, you should arrange your configuration so that it avoids
11605 these lookups altogether. The lookup happens only if one or more of the
11606 following are true:
11607
11608 .ilist
11609 A string containing &$sender_host_name$& is expanded.
11610 .next
11611 The calling host matches the list in &%host_lookup%&. In the default
11612 configuration, this option is set to *, so it must be changed if lookups are
11613 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11614 .next
11615 Exim needs the host name in order to test an item in a host list. The items
11616 that require this are described in sections &<<SECThoslispatnam>>& and
11617 &<<SECThoslispatnamsk>>&.
11618 .next
11619 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11620 In this case, the host name is required to compare with the name quoted in any
11621 EHLO or HELO commands that the client issues.
11622 .next
11623 The remote host issues a EHLO or HELO command that quotes one of the
11624 domains in &%helo_lookup_domains%&. The default value of this option is
11625 . ==== As this is a nested list, any displays it contains must be indented
11626 . ==== as otherwise they are too far to the left.
11627 .code
11628   helo_lookup_domains = @ : @[]
11629 .endd
11630 which causes a lookup if a remote host (incorrectly) gives the server's name or
11631 IP address in an EHLO or HELO command.
11632 .endlist
11633
11634
11635 .vitem &$sender_host_port$&
11636 .vindex "&$sender_host_port$&"
11637 When a message is received from a remote host, this variable contains the port
11638 number that was used on the remote host.
11639
11640 .vitem &$sender_ident$&
11641 .vindex "&$sender_ident$&"
11642 When a message is received from a remote host, this variable contains the
11643 identification received in response to an RFC 1413 request. When a message has
11644 been received locally, this variable contains the login name of the user that
11645 called Exim.
11646
11647 .vitem &$sender_rate_$&&'xxx'&
11648 A number of variables whose names begin &$sender_rate_$& are set as part of the
11649 &%ratelimit%& ACL condition. Details are given in section
11650 &<<SECTratelimiting>>&.
11651
11652 .vitem &$sender_rcvhost$&
11653 .cindex "DNS" "reverse lookup"
11654 .cindex "reverse DNS lookup"
11655 .vindex "&$sender_rcvhost$&"
11656 This is provided specifically for use in &'Received:'& headers. It starts with
11657 either the verified host name (as obtained from a reverse DNS lookup) or, if
11658 there is no verified host name, the IP address in square brackets. After that
11659 there may be text in parentheses. When the first item is a verified host name,
11660 the first thing in the parentheses is the IP address in square brackets,
11661 followed by a colon and a port number if port logging is enabled. When the
11662 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11663 the parentheses.
11664
11665 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11666 was used and its argument was not identical to the real host name or IP
11667 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11668 all three items are present in the parentheses, a newline and tab are inserted
11669 into the string, to improve the formatting of the &'Received:'& header.
11670
11671 .vitem &$sender_verify_failure$&
11672 .vindex "&$sender_verify_failure$&"
11673 In an ACL, when a sender verification fails, this variable contains information
11674 about the failure. The details are the same as for
11675 &$recipient_verify_failure$&.
11676
11677 .vitem &$sending_ip_address$&
11678 .vindex "&$sending_ip_address$&"
11679 This variable is set whenever an outgoing SMTP connection to another host has
11680 been set up. It contains the IP address of the local interface that is being
11681 used. This is useful if a host that has more than one IP address wants to take
11682 on different personalities depending on which one is being used. For incoming
11683 connections, see &$received_ip_address$&.
11684
11685 .vitem &$sending_port$&
11686 .vindex "&$sending_port$&"
11687 This variable is set whenever an outgoing SMTP connection to another host has
11688 been set up. It contains the local port that is being used. For incoming
11689 connections, see &$received_port$&.
11690
11691 .vitem &$smtp_active_hostname$&
11692 .vindex "&$smtp_active_hostname$&"
11693 During an incoming SMTP session, this variable contains the value of the active
11694 host name, as specified by the &%smtp_active_hostname%& option. The value of
11695 &$smtp_active_hostname$& is saved with any message that is received, so its
11696 value can be consulted during routing and delivery.
11697
11698 .vitem &$smtp_command$&
11699 .vindex "&$smtp_command$&"
11700 During the processing of an incoming SMTP command, this variable contains the
11701 entire command. This makes it possible to distinguish between HELO and EHLO in
11702 the HELO ACL, and also to distinguish between commands such as these:
11703 .code
11704 MAIL FROM:<>
11705 MAIL FROM: <>
11706 .endd
11707 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11708 command, the address in &$smtp_command$& is the original address before any
11709 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11710 the address after SMTP-time rewriting.
11711
11712 .vitem &$smtp_command_argument$&
11713 .cindex "SMTP" "command, argument for"
11714 .vindex "&$smtp_command_argument$&"
11715 While an ACL is running to check an SMTP command, this variable contains the
11716 argument, that is, the text that follows the command name, with leading white
11717 space removed. Following the introduction of &$smtp_command$&, this variable is
11718 somewhat redundant, but is retained for backwards compatibility.
11719
11720 .vitem &$smtp_count_at_connection_start$&
11721 .vindex "&$smtp_count_at_connection_start$&"
11722 This variable is set greater than zero only in processes spawned by the Exim
11723 daemon for handling incoming SMTP connections. The name is deliberately long,
11724 in order to emphasize what the contents are. When the daemon accepts a new
11725 connection, it increments this variable. A copy of the variable is passed to
11726 the child process that handles the connection, but its value is fixed, and
11727 never changes. It is only an approximation of how many incoming connections
11728 there actually are, because many other connections may come and go while a
11729 single connection is being processed. When a child process terminates, the
11730 daemon decrements its copy of the variable.
11731
11732 .vitem "&$sn0$& &-- &$sn9$&"
11733 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11734 that were current at the end of the system filter file. This allows a system
11735 filter file to set values that can be tested in users' filter files. For
11736 example, a system filter could set a value indicating how likely it is that a
11737 message is junk mail.
11738
11739 .vitem &$spam_$&&'xxx'&
11740 A number of variables whose names start with &$spam$& are available when Exim
11741 is compiled with the content-scanning extension. For details, see section
11742 &<<SECTscanspamass>>&.
11743
11744
11745 .vitem &$spool_directory$&
11746 .vindex "&$spool_directory$&"
11747 The name of Exim's spool directory.
11748
11749 .vitem &$spool_inodes$&
11750 .vindex "&$spool_inodes$&"
11751 The number of free inodes in the disk partition where Exim's spool files are
11752 being written. The value is recalculated whenever the variable is referenced.
11753 If the relevant file system does not have the concept of inodes, the value of
11754 is -1. See also the &%check_spool_inodes%& option.
11755
11756 .vitem &$spool_space$&
11757 .vindex "&$spool_space$&"
11758 The amount of free space (as a number of kilobytes) in the disk partition where
11759 Exim's spool files are being written. The value is recalculated whenever the
11760 variable is referenced. If the operating system does not have the ability to
11761 find the amount of free space (only true for experimental systems), the space
11762 value is -1. For example, to check in an ACL that there is at least 50
11763 megabytes free on the spool, you could write:
11764 .code
11765 condition = ${if > {$spool_space}{50000}}
11766 .endd
11767 See also the &%check_spool_space%& option.
11768
11769
11770 .vitem &$thisaddress$&
11771 .vindex "&$thisaddress$&"
11772 This variable is set only during the processing of the &%foranyaddress%&
11773 command in a filter file. Its use is explained in the description of that
11774 command, which can be found in the separate document entitled &'Exim's
11775 interfaces to mail filtering'&.
11776
11777 .vitem &$tls_certificate_verified$&
11778 .vindex "&$tls_certificate_verified$&"
11779 This variable is set to &"1"& if a TLS certificate was verified when the
11780 message was received, and &"0"& otherwise.
11781
11782 .vitem &$tls_cipher$&
11783 .vindex "&$tls_cipher$&"
11784 When a message is received from a remote host over an encrypted SMTP
11785 connection, this variable is set to the cipher suite that was negotiated, for
11786 example DES-CBC3-SHA. In other circumstances, in particular, for message
11787 received over unencrypted connections, the variable is empty. Testing
11788 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11789 non-encrypted connections during ACL processing.
11790
11791 The &$tls_cipher$& variable retains its value during message delivery, except
11792 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11793 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11794 and then set to the outgoing cipher suite if one is negotiated. See chapter
11795 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11796 details of the &(smtp)& transport.
11797
11798 .vitem &$tls_peerdn$&
11799 .vindex "&$tls_peerdn$&"
11800 When a message is received from a remote host over an encrypted SMTP
11801 connection, and Exim is configured to request a certificate from the client,
11802 the value of the Distinguished Name of the certificate is made available in the
11803 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11804 value is retained during message delivery, except during outbound SMTP
11805 deliveries.
11806
11807 .vitem &$tod_bsdinbox$&
11808 .vindex "&$tod_bsdinbox$&"
11809 The time of day and the date, in the format required for BSD-style mailbox
11810 files, for example: Thu Oct 17 17:14:09 1995.
11811
11812 .vitem &$tod_epoch$&
11813 .vindex "&$tod_epoch$&"
11814 The time and date as a number of seconds since the start of the Unix epoch.
11815
11816 .vitem &$tod_full$&
11817 .vindex "&$tod_full$&"
11818 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11819 +0100. The timezone is always given as a numerical offset from UTC, with
11820 positive values used for timezones that are ahead (east) of UTC, and negative
11821 values for those that are behind (west).
11822
11823 .vitem &$tod_log$&
11824 .vindex "&$tod_log$&"
11825 The time and date in the format used for writing Exim's log files, for example:
11826 1995-10-12 15:32:29, but without a timezone.
11827
11828 .vitem &$tod_logfile$&
11829 .vindex "&$tod_logfile$&"
11830 This variable contains the date in the format yyyymmdd. This is the format that
11831 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11832 flag.
11833
11834 .vitem &$tod_zone$&
11835 .vindex "&$tod_zone$&"
11836 This variable contains the numerical value of the local timezone, for example:
11837 -0500.
11838
11839 .vitem &$tod_zulu$&
11840 .vindex "&$tod_zulu$&"
11841 This variable contains the UTC date and time in &"Zulu"& format, as specified
11842 by ISO 8601, for example: 20030221154023Z.
11843
11844 .vitem &$value$&
11845 .vindex "&$value$&"
11846 This variable contains the result of an expansion lookup, extraction operation,
11847 or external command, as described above. It is also used during a
11848 &*reduce*& expansion.
11849
11850 .vitem &$version_number$&
11851 .vindex "&$version_number$&"
11852 The version number of Exim.
11853
11854 .vitem &$warn_message_delay$&
11855 .vindex "&$warn_message_delay$&"
11856 This variable is set only during the creation of a message warning about a
11857 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11858
11859 .vitem &$warn_message_recipients$&
11860 .vindex "&$warn_message_recipients$&"
11861 This variable is set only during the creation of a message warning about a
11862 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11863 .endlist
11864 .ecindex IIDstrexp
11865
11866
11867
11868 . ////////////////////////////////////////////////////////////////////////////
11869 . ////////////////////////////////////////////////////////////////////////////
11870
11871 .chapter "Embedded Perl" "CHAPperl"
11872 .scindex IIDperl "Perl" "calling from Exim"
11873 Exim can be built to include an embedded Perl interpreter. When this is done,
11874 Perl subroutines can be called as part of the string expansion process. To make
11875 use of the Perl support, you need version 5.004 or later of Perl installed on
11876 your system. To include the embedded interpreter in the Exim binary, include
11877 the line
11878 .code
11879 EXIM_PERL = perl.o
11880 .endd
11881 in your &_Local/Makefile_& and then build Exim in the normal way.
11882
11883
11884 .section "Setting up so Perl can be used" "SECID85"
11885 .oindex "&%perl_startup%&"
11886 Access to Perl subroutines is via a global configuration option called
11887 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
11888 no &%perl_startup%& option in the Exim configuration file then no Perl
11889 interpreter is started and there is almost no overhead for Exim (since none of
11890 the Perl library will be paged in unless used). If there is a &%perl_startup%&
11891 option then the associated value is taken to be Perl code which is executed in
11892 a newly created Perl interpreter.
11893
11894 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
11895 need backslashes before any characters to escape special meanings. The option
11896 should usually be something like
11897 .code
11898 perl_startup = do '/etc/exim.pl'
11899 .endd
11900 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
11901 use from Exim. Exim can be configured either to start up a Perl interpreter as
11902 soon as it is entered, or to wait until the first time it is needed. Starting
11903 the interpreter at the beginning ensures that it is done while Exim still has
11904 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
11905 fact used in a particular run. Also, note that this does not mean that Exim is
11906 necessarily running as root when Perl is called at a later time. By default,
11907 the interpreter is started only when it is needed, but this can be changed in
11908 two ways:
11909
11910 .ilist
11911 .oindex "&%perl_at_start%&"
11912 Setting &%perl_at_start%& (a boolean option) in the configuration requests
11913 a startup when Exim is entered.
11914 .next
11915 The command line option &%-ps%& also requests a startup when Exim is entered,
11916 overriding the setting of &%perl_at_start%&.
11917 .endlist
11918
11919 There is also a command line option &%-pd%& (for delay) which suppresses the
11920 initial startup, even if &%perl_at_start%& is set.
11921
11922
11923 .section "Calling Perl subroutines" "SECID86"
11924 When the configuration file includes a &%perl_startup%& option you can make use
11925 of the string expansion item to call the Perl subroutines that are defined
11926 by the &%perl_startup%& code. The operator is used in any of the following
11927 forms:
11928 .code
11929 ${perl{foo}}
11930 ${perl{foo}{argument}}
11931 ${perl{foo}{argument1}{argument2} ... }
11932 .endd
11933 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
11934 arguments may be passed. Passing more than this results in an expansion failure
11935 with an error message of the form
11936 .code
11937 Too many arguments passed to Perl subroutine "foo" (max is 8)
11938 .endd
11939 The return value of the Perl subroutine is evaluated in a scalar context before
11940 it is passed back to Exim to be inserted into the expanded string. If the
11941 return value is &'undef'&, the expansion is forced to fail in the same way as
11942 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
11943 by obeying Perl's &%die%& function, the expansion fails with the error message
11944 that was passed to &%die%&.
11945
11946
11947 .section "Calling Exim functions from Perl" "SECID87"
11948 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
11949 is available to call back into Exim's string expansion function. For example,
11950 the Perl code
11951 .code
11952 my $lp = Exim::expand_string('$local_part');
11953 .endd
11954 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
11955 Note those are single quotes and not double quotes to protect against
11956 &$local_part$& being interpolated as a Perl variable.
11957
11958 If the string expansion is forced to fail by a &"fail"& item, the result of
11959 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
11960 expansion string, the Perl call from the original expansion string fails with
11961 an appropriate error message, in the same way as if &%die%& were used.
11962
11963 .cindex "debugging" "from embedded Perl"
11964 .cindex "log" "writing from embedded Perl"
11965 Two other Exim functions are available for use from within Perl code.
11966 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
11967 debugging is enabled. If you want a newline at the end, you must supply it.
11968 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
11969 timestamp. In this case, you should not supply a terminating newline.
11970
11971
11972 .section "Use of standard output and error by Perl" "SECID88"
11973 .cindex "Perl" "standard output and error"
11974 You should not write to the standard error or output streams from within your
11975 Perl code, as it is not defined how these are set up. In versions of Exim
11976 before 4.50, it is possible for the standard output or error to refer to the
11977 SMTP connection during message reception via the daemon. Writing to this stream
11978 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
11979 error streams are connected to &_/dev/null_& in the daemon. The chaos is
11980 avoided, but the output is lost.
11981
11982 .cindex "Perl" "use of &%warn%&"
11983 The Perl &%warn%& statement writes to the standard error stream by default.
11984 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
11985 you have no control. When Exim starts up the Perl interpreter, it arranges for
11986 output from the &%warn%& statement to be written to the Exim main log. You can
11987 change this by including appropriate Perl magic somewhere in your Perl code.
11988 For example, to discard &%warn%& output completely, you need this:
11989 .code
11990 $SIG{__WARN__} = sub { };
11991 .endd
11992 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
11993 example, the code for the subroutine is empty, so it does nothing, but you can
11994 include any Perl code that you like. The text of the &%warn%& message is passed
11995 as the first subroutine argument.
11996 .ecindex IIDperl
11997
11998
11999 . ////////////////////////////////////////////////////////////////////////////
12000 . ////////////////////////////////////////////////////////////////////////////
12001
12002 .chapter "Starting the daemon and the use of network interfaces" &&&
12003          "CHAPinterfaces" &&&
12004          "Starting the daemon"
12005 .cindex "daemon" "starting"
12006 .cindex "interface" "listening"
12007 .cindex "network interface"
12008 .cindex "interface" "network"
12009 .cindex "IP address" "for listening"
12010 .cindex "daemon" "listening IP addresses"
12011 .cindex "TCP/IP" "setting listening interfaces"
12012 .cindex "TCP/IP" "setting listening ports"
12013 A host that is connected to a TCP/IP network may have one or more physical
12014 hardware network interfaces. Each of these interfaces may be configured as one
12015 or more &"logical"& interfaces, which are the entities that a program actually
12016 works with. Each of these logical interfaces is associated with an IP address.
12017 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12018 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12019 knowledge about the host's interfaces for use in three different circumstances:
12020
12021 .olist
12022 When a listening daemon is started, Exim needs to know which interfaces
12023 and ports to listen on.
12024 .next
12025 When Exim is routing an address, it needs to know which IP addresses
12026 are associated with local interfaces. This is required for the correct
12027 processing of MX lists by removing the local host and others with the
12028 same or higher priority values. Also, Exim needs to detect cases
12029 when an address is routed to an IP address that in fact belongs to the
12030 local host. Unless the &%self%& router option or the &%allow_localhost%&
12031 option of the smtp transport is set (as appropriate), this is treated
12032 as an error situation.
12033 .next
12034 When Exim connects to a remote host, it may need to know which interface to use
12035 for the outgoing connection.
12036 .endlist
12037
12038
12039 Exim's default behaviour is likely to be appropriate in the vast majority
12040 of cases. If your host has only one interface, and you want all its IP
12041 addresses to be treated in the same way, and you are using only the
12042 standard SMTP port, you should not need to take any special action. The
12043 rest of this chapter does not apply to you.
12044
12045 In a more complicated situation you may want to listen only on certain
12046 interfaces, or on different ports, and for this reason there are a number of
12047 options that can be used to influence Exim's behaviour. The rest of this
12048 chapter describes how they operate.
12049
12050 When a message is received over TCP/IP, the interface and port that were
12051 actually used are set in &$received_ip_address$& and &$received_port$&.
12052
12053
12054
12055 .section "Starting a listening daemon" "SECID89"
12056 When a listening daemon is started (by means of the &%-bd%& command line
12057 option), the interfaces and ports on which it listens are controlled by the
12058 following options:
12059
12060 .ilist
12061 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12062 compatibility, this option can also be specified in the singular.)
12063 .next
12064 &%local_interfaces%& contains list of interface IP addresses on which to
12065 listen. Each item may optionally also specify a port.
12066 .endlist
12067
12068 The default list separator in both cases is a colon, but this can be changed as
12069 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12070 it is usually best to change the separator to avoid having to double all the
12071 colons. For example:
12072 .code
12073 local_interfaces = <; 127.0.0.1 ; \
12074                       192.168.23.65 ; \
12075                       ::1 ; \
12076                       3ffe:ffff:836f::fe86:a061
12077 .endd
12078 There are two different formats for specifying a port along with an IP address
12079 in &%local_interfaces%&:
12080
12081 .olist
12082 The port is added onto the address with a dot separator. For example, to listen
12083 on port 1234 on two different IP addresses:
12084 .code
12085 local_interfaces = <; 192.168.23.65.1234 ; \
12086                       3ffe:ffff:836f::fe86:a061.1234
12087 .endd
12088 .next
12089 The IP address is enclosed in square brackets, and the port is added
12090 with a colon separator, for example:
12091 .code
12092 local_interfaces = <; [192.168.23.65]:1234 ; \
12093                       [3ffe:ffff:836f::fe86:a061]:1234
12094 .endd
12095 .endlist
12096
12097 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12098 default setting contains just one port:
12099 .code
12100 daemon_smtp_ports = smtp
12101 .endd
12102 If more than one port is listed, each interface that does not have its own port
12103 specified listens on all of them. Ports that are listed in
12104 &%daemon_smtp_ports%& can be identified either by name (defined in
12105 &_/etc/services_&) or by number. However, when ports are given with individual
12106 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12107
12108
12109
12110 .section "Special IP listening addresses" "SECID90"
12111 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12112 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12113 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12114 instead of setting up separate listening sockets for each interface. The
12115 default value of &%local_interfaces%& is
12116 .code
12117 local_interfaces = 0.0.0.0
12118 .endd
12119 when Exim is built without IPv6 support; otherwise it is:
12120 .code
12121 local_interfaces = <; ::0 ; 0.0.0.0
12122 .endd
12123 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12124
12125
12126
12127 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12128 The &%-oX%& command line option can be used to override the values of
12129 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12130 instance. Another way of doing this would be to use macros and the &%-D%&
12131 option. However, &%-oX%& can be used by any admin user, whereas modification of
12132 the runtime configuration by &%-D%& is allowed only when the caller is root or
12133 exim.
12134
12135 The value of &%-oX%& is a list of items. The default colon separator can be
12136 changed in the usual way if required. If there are any items that do not
12137 contain dots or colons (that is, are not IP addresses), the value of
12138 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12139 items that do contain dots or colons, the value of &%local_interfaces%& is
12140 replaced by those items. Thus, for example,
12141 .code
12142 -oX 1225
12143 .endd
12144 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12145 whereas
12146 .code
12147 -oX 192.168.34.5.1125
12148 .endd
12149 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12150 (However, since &%local_interfaces%& now contains no items without ports, the
12151 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12152
12153
12154
12155 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12156 .cindex "ssmtp protocol"
12157 .cindex "smtps protocol"
12158 .cindex "SMTP" "ssmtp protocol"
12159 .cindex "SMTP" "smtps protocol"
12160 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12161 before the STARTTLS command was standardized for SMTP. Some legacy clients
12162 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12163 list of port numbers, connections to those ports must use SSMTP. The most
12164 common use of this option is expected to be
12165 .code
12166 tls_on_connect_ports = 465
12167 .endd
12168 because 465 is the usual port number used by the legacy clients. There is also
12169 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12170 this way when a daemon is started.
12171
12172 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12173 daemon to listen on those ports. You must still specify them in
12174 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12175 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12176 connections via the daemon.)
12177
12178
12179
12180
12181 .section "IPv6 address scopes" "SECID92"
12182 .cindex "IPv6" "address scopes"
12183 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12184 can, in principle, have the same link-local IPv6 address on different
12185 interfaces. Thus, additional information is needed, over and above the IP
12186 address, to distinguish individual interfaces. A convention of using a
12187 percent sign followed by something (often the interface name) has been
12188 adopted in some cases, leading to addresses like this:
12189 .code
12190 fe80::202:b3ff:fe03:45c1%eth0
12191 .endd
12192 To accommodate this usage, a percent sign followed by an arbitrary string is
12193 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12194 to convert a textual IPv6 address for actual use. This function recognizes the
12195 percent convention in operating systems that support it, and it processes the
12196 address appropriately. Unfortunately, some older libraries have problems with
12197 &[getaddrinfo()]&. If
12198 .code
12199 IPV6_USE_INET_PTON=yes
12200 .endd
12201 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12202 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12203 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12204 function.) Of course, this means that the additional functionality of
12205 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12206
12207 .section "Disabling IPv6" "SECID93"
12208 .cindex "IPv6" "disabling"
12209 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12210 run on a host whose kernel does not support IPv6. The binary will fall back to
12211 using IPv4, but it may waste resources looking up AAAA records, and trying to
12212 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12213 .oindex "&%disable_ipv6%&"
12214 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12215 activities take place. AAAA records are never looked up, and any IPv6 addresses
12216 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12217 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12218 to handle IPv6 literal addresses.
12219
12220 On the other hand, when IPv6 is in use, there may be times when you want to
12221 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12222 option to globally suppress the lookup of AAAA records for specified domains,
12223 and you can use the &%ignore_target_hosts%& generic router option to ignore
12224 IPv6 addresses in an individual router.
12225
12226
12227
12228 .section "Examples of starting a listening daemon" "SECID94"
12229 The default case in an IPv6 environment is
12230 .code
12231 daemon_smtp_ports = smtp
12232 local_interfaces = <; ::0 ; 0.0.0.0
12233 .endd
12234 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12235 Either one or two sockets may be used, depending on the characteristics of
12236 the TCP/IP stack. (This is complicated and messy; for more information,
12237 read the comments in the &_daemon.c_& source file.)
12238
12239 To specify listening on ports 25 and 26 on all interfaces:
12240 .code
12241 daemon_smtp_ports = 25 : 26
12242 .endd
12243 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12244 .code
12245 local_interfaces = <; ::0.25     ; ::0.26 \
12246                       0.0.0.0.25 ; 0.0.0.0.26
12247 .endd
12248 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12249 IPv4 loopback address only:
12250 .code
12251 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12252 .endd
12253 To specify listening on the default port on specific interfaces only:
12254 .code
12255 local_interfaces = 192.168.34.67 : 192.168.34.67
12256 .endd
12257 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12258
12259
12260
12261 .section "Recognizing the local host" "SECTreclocipadd"
12262 The &%local_interfaces%& option is also used when Exim needs to determine
12263 whether or not an IP address refers to the local host. That is, the IP
12264 addresses of all the interfaces on which a daemon is listening are always
12265 treated as local.
12266
12267 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12268 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12269 available interfaces from the operating system, and extracts the relevant
12270 (that is, IPv4 or IPv6) addresses to use for checking.
12271
12272 Some systems set up large numbers of virtual interfaces in order to provide
12273 many virtual web servers. In this situation, you may want to listen for
12274 email on only a few of the available interfaces, but nevertheless treat all
12275 interfaces as local when routing. You can do this by setting
12276 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12277 &"all"& wildcard values. These addresses are recognized as local, but are not
12278 used for listening. Consider this example:
12279 .code
12280 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12281                       192.168.53.235 ; \
12282                       3ffe:2101:12:1:a00:20ff:fe86:a061
12283
12284 extra_local_interfaces = <; ::0 ; 0.0.0.0
12285 .endd
12286 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12287 address, but all available interface addresses are treated as local when
12288 Exim is routing.
12289
12290 In some environments the local host name may be in an MX list, but with an IP
12291 address that is not assigned to any local interface. In other cases it may be
12292 desirable to treat other host names as if they referred to the local host. Both
12293 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12294 This contains host names rather than IP addresses. When a host is referenced
12295 during routing, either via an MX record or directly, it is treated as the local
12296 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12297 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12298
12299
12300
12301 .section "Delivering to a remote host" "SECID95"
12302 Delivery to a remote host is handled by the smtp transport. By default, it
12303 allows the system's TCP/IP functions to choose which interface to use (if
12304 there is more than one) when connecting to a remote host. However, the
12305 &%interface%& option can be set to specify which interface is used. See the
12306 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12307 details.
12308
12309
12310
12311
12312 . ////////////////////////////////////////////////////////////////////////////
12313 . ////////////////////////////////////////////////////////////////////////////
12314
12315 .chapter "Main configuration" "CHAPmainconfig"
12316 .scindex IIDconfima "configuration file" "main section"
12317 .scindex IIDmaiconf "main configuration"
12318 The first part of the run time configuration file contains three types of item:
12319
12320 .ilist
12321 Macro definitions: These lines start with an upper case letter. See section
12322 &<<SECTmacrodefs>>& for details of macro processing.
12323 .next
12324 Named list definitions: These lines start with one of the words &"domainlist"&,
12325 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12326 section &<<SECTnamedlists>>&.
12327 .next
12328 Main configuration settings: Each setting occupies one line of the file
12329 (with possible continuations). If any setting is preceded by the word
12330 &"hide"&, the &%-bP%& command line option displays its value to admin users
12331 only. See section &<<SECTcos>>& for a description of the syntax of these option
12332 settings.
12333 .endlist
12334
12335 This chapter specifies all the main configuration options, along with their
12336 types and default values. For ease of finding a particular option, they appear
12337 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12338 are now so many options, they are first listed briefly in functional groups, as
12339 an aid to finding the name of the option you are looking for. Some options are
12340 listed in more than one group.
12341
12342 .section "Miscellaneous" "SECID96"
12343 .table2
12344 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12345 .row &%disable_ipv6%&                "do no IPv6 processing"
12346 .row &%keep_malformed%&              "for broken files &-- should not happen"
12347 .row &%localhost_number%&            "for unique message ids in clusters"
12348 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12349 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12350 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12351 .row &%print_topbitchars%&           "top-bit characters are printing"
12352 .row &%timezone%&                    "force time zone"
12353 .endtable
12354
12355
12356 .section "Exim parameters" "SECID97"
12357 .table2
12358 .row &%exim_group%&                  "override compiled-in value"
12359 .row &%exim_path%&                   "override compiled-in value"
12360 .row &%exim_user%&                   "override compiled-in value"
12361 .row &%primary_hostname%&            "default from &[uname()]&"
12362 .row &%split_spool_directory%&       "use multiple directories"
12363 .row &%spool_directory%&             "override compiled-in value"
12364 .endtable
12365
12366
12367
12368 .section "Privilege controls" "SECID98"
12369 .table2
12370 .row &%admin_groups%&                "groups that are Exim admin users"
12371 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12372 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12373 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12374 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12375 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12376 .row &%never_users%&                 "do not run deliveries as these"
12377 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12378 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12379 .row &%trusted_groups%&              "groups that are trusted"
12380 .row &%trusted_users%&               "users that are trusted"
12381 .endtable
12382
12383
12384
12385 .section "Logging" "SECID99"
12386 .table2
12387 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12388 .row &%log_file_path%&               "override compiled-in value"
12389 .row &%log_selector%&                "set/unset optional logging"
12390 .row &%log_timezone%&                "add timezone to log lines"
12391 .row &%message_logs%&                "create per-message logs"
12392 .row &%preserve_message_logs%&       "after message completion"
12393 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12394 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12395 .row &%syslog_facility%&             "set syslog &""facility""& field"
12396 .row &%syslog_processname%&          "set syslog &""ident""& field"
12397 .row &%syslog_timestamp%&            "timestamp syslog lines"
12398 .row &%write_rejectlog%&             "control use of message log"
12399 .endtable
12400
12401
12402
12403 .section "Frozen messages" "SECID100"
12404 .table2
12405 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12406 .row &%freeze_tell%&                 "send message when freezing"
12407 .row &%move_frozen_messages%&        "to another directory"
12408 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12409 .endtable
12410
12411
12412
12413 .section "Data lookups" "SECID101"
12414 .table2
12415 .row &%ibase_servers%&               "InterBase servers"
12416 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12417 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12418 .row &%ldap_cert_file%&              "client cert file for LDAP"
12419 .row &%ldap_cert_key%&               "client key file for LDAP"
12420 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12421 .row &%ldap_default_servers%&        "used if no server in query"
12422 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12423 .row &%ldap_start_tls%&              "require TLS within LDAP"
12424 .row &%ldap_version%&                "set protocol version"
12425 .row &%lookup_open_max%&             "lookup files held open"
12426 .row &%mysql_servers%&               "default MySQL servers"
12427 .row &%oracle_servers%&              "Oracle servers"
12428 .row &%pgsql_servers%&               "default PostgreSQL servers"
12429 .row &%sqlite_lock_timeout%&         "as it says"
12430 .endtable
12431
12432
12433
12434 .section "Message ids" "SECID102"
12435 .table2
12436 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12437 .row &%message_id_header_text%&      "ditto"
12438 .endtable
12439
12440
12441
12442 .section "Embedded Perl Startup" "SECID103"
12443 .table2
12444 .row &%perl_at_start%&               "always start the interpreter"
12445 .row &%perl_startup%&                "code to obey when starting Perl"
12446 .endtable
12447
12448
12449
12450 .section "Daemon" "SECID104"
12451 .table2
12452 .row &%daemon_smtp_ports%&           "default ports"
12453 .row &%daemon_startup_retries%&      "number of times to retry"
12454 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12455 .row &%extra_local_interfaces%&      "not necessarily listened on"
12456 .row &%local_interfaces%&            "on which to listen, with optional ports"
12457 .row &%pid_file_path%&               "override compiled-in value"
12458 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12459 .endtable
12460
12461
12462
12463 .section "Resource control" "SECID105"
12464 .table2
12465 .row &%check_log_inodes%&            "before accepting a message"
12466 .row &%check_log_space%&             "before accepting a message"
12467 .row &%check_spool_inodes%&          "before accepting a message"
12468 .row &%check_spool_space%&           "before accepting a message"
12469 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12470 .row &%queue_only_load%&             "queue incoming if load high"
12471 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12472 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12473 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12474 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12475 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12476 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12477 .row &%smtp_accept_max_per_connection%& "messages per connection"
12478 .row &%smtp_accept_max_per_host%&    "connections from one host"
12479 .row &%smtp_accept_queue%&           "queue mail if more connections"
12480 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12481                                            connection"
12482 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12483 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12484 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12485 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12486 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12487 .endtable
12488
12489
12490
12491 .section "Policy controls" "SECID106"
12492 .table2
12493 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12494 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12495 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12496 .row &%acl_smtp_auth%&               "ACL for AUTH"
12497 .row &%acl_smtp_connect%&            "ACL for connection"
12498 .row &%acl_smtp_data%&               "ACL for DATA"
12499 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12500 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12501 .row &%acl_smtp_expn%&               "ACL for EXPN"
12502 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12503 .row &%acl_smtp_mail%&               "ACL for MAIL"
12504 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12505 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12506 .row &%acl_smtp_predata%&            "ACL for start of data"
12507 .row &%acl_smtp_quit%&               "ACL for QUIT"
12508 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12509 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12510 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12511 .row &%av_scanner%&                  "specify virus scanner"
12512 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12513                                       words""&"
12514 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12515 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12516 .row &%header_maxsize%&              "total size of message header"
12517 .row &%header_line_maxsize%&         "individual header line limit"
12518 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12519 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12520 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12521 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12522 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12523 .row &%host_lookup%&                 "host name looked up for these hosts"
12524 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12525 .row &%host_reject_connection%&      "reject connection from these hosts"
12526 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12527 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12528 .row &%message_size_limit%&          "for all messages"
12529 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12530 .row &%spamd_address%&               "set interface to SpamAssassin"
12531 .row &%strict_acl_vars%&             "object to unset ACL variables"
12532 .endtable
12533
12534
12535
12536 .section "Callout cache" "SECID107"
12537 .table2
12538 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12539                                          item"
12540 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12541                                          item"
12542 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12543 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12544 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12545 .endtable
12546
12547
12548
12549 .section "TLS" "SECID108"
12550 .table2
12551 .row &%gnutls_require_kx%&           "control GnuTLS key exchanges"
12552 .row &%gnutls_require_mac%&          "control GnuTLS MAC algorithms"
12553 .row &%gnutls_require_protocols%&    "control GnuTLS protocols"
12554 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12555 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12556 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12557 .row &%tls_certificate%&             "location of server certificate"
12558 .row &%tls_crl%&                     "certificate revocation list"
12559 .row &%tls_dhparam%&                 "DH parameters for server"
12560 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12561 .row &%tls_privatekey%&              "location of server private key"
12562 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12563 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12564 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12565 .row &%tls_verify_certificates%&     "expected client certificates"
12566 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12567 .endtable
12568
12569
12570
12571 .section "Local user handling" "SECID109"
12572 .table2
12573 .row &%finduser_retries%&            "useful in NIS environments"
12574 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12575 .row &%gecos_pattern%&               "ditto"
12576 .row &%max_username_length%&         "for systems that truncate"
12577 .row &%unknown_login%&               "used when no login name found"
12578 .row &%unknown_username%&            "ditto"
12579 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12580 .row &%uucp_from_sender%&            "ditto"
12581 .endtable
12582
12583
12584
12585 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12586 .table2
12587 .row &%header_maxsize%&              "total size of message header"
12588 .row &%header_line_maxsize%&         "individual header line limit"
12589 .row &%message_size_limit%&          "applies to all messages"
12590 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12591 .row &%received_header_text%&        "expanded to make &'Received:'&"
12592 .row &%received_headers_max%&        "for mail loop detection"
12593 .row &%recipients_max%&              "limit per message"
12594 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12595 .endtable
12596
12597
12598
12599
12600 .section "Non-SMTP incoming messages" "SECID111"
12601 .table2
12602 .row &%receive_timeout%&             "for non-SMTP messages"
12603 .endtable
12604
12605
12606
12607
12608
12609 .section "Incoming SMTP messages" "SECID112"
12610 See also the &'Policy controls'& section above.
12611
12612 .table2
12613 .row &%host_lookup%&                 "host name looked up for these hosts"
12614 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12615 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12616 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12617 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12618 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12619 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12620 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12621 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12622 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12623 .row &%smtp_accept_max_per_connection%& "messages per connection"
12624 .row &%smtp_accept_max_per_host%&    "connections from one host"
12625 .row &%smtp_accept_queue%&           "queue mail if more connections"
12626 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12627                                            connection"
12628 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12629 .row &%smtp_active_hostname%&        "host name to use in messages"
12630 .row &%smtp_banner%&                 "text for welcome banner"
12631 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12632 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12633 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12634 .row &%smtp_etrn_command%&           "what to run for ETRN"
12635 .row &%smtp_etrn_serialize%&         "only one at once"
12636 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12637 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12638 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12639 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12640 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12641 .row &%smtp_receive_timeout%&        "per command or data line"
12642 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12643 .row &%smtp_return_error_details%&   "give detail on rejections"
12644 .endtable
12645
12646
12647
12648 .section "SMTP extensions" "SECID113"
12649 .table2
12650 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12651 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12652 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12653 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12654 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12655 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12656 .endtable
12657
12658
12659
12660 .section "Processing messages" "SECID114"
12661 .table2
12662 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12663 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12664 .row &%allow_utf8_domains%&          "in addresses"
12665 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12666                                       words""&"
12667 .row &%delivery_date_remove%&        "from incoming messages"
12668 .row &%envelope_to_remove%&          "from incoming messages"
12669 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12670 .row &%headers_charset%&             "default for translations"
12671 .row &%qualify_domain%&              "default for senders"
12672 .row &%qualify_recipient%&           "default for recipients"
12673 .row &%return_path_remove%&          "from incoming messages"
12674 .row &%strip_excess_angle_brackets%& "in addresses"
12675 .row &%strip_trailing_dot%&          "at end of addresses"
12676 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12677 .endtable
12678
12679
12680
12681 .section "System filter" "SECID115"
12682 .table2
12683 .row &%system_filter%&               "locate system filter"
12684 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12685                                             directory"
12686 .row &%system_filter_file_transport%& "transport for delivery to a file"
12687 .row &%system_filter_group%&         "group for filter running"
12688 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12689 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12690 .row &%system_filter_user%&          "user for filter running"
12691 .endtable
12692
12693
12694
12695 .section "Routing and delivery" "SECID116"
12696 .table2
12697 .row &%disable_ipv6%&                "do no IPv6 processing"
12698 .row &%dns_again_means_nonexist%&    "for broken domains"
12699 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12700 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12701 .row &%dns_retrans%&                 "parameter for resolver"
12702 .row &%dns_retry%&                   "parameter for resolver"
12703 .row &%dns_use_edns0%&               "parameter for resolver"
12704 .row &%hold_domains%&                "hold delivery for these domains"
12705 .row &%local_interfaces%&            "for routing checks"
12706 .row &%queue_domains%&               "no immediate delivery for these"
12707 .row &%queue_only%&                  "no immediate delivery at all"
12708 .row &%queue_only_file%&             "no immediate delivery if file exists"
12709 .row &%queue_only_load%&             "no immediate delivery if load is high"
12710 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12711 .row &%queue_only_override%&         "allow command line to override"
12712 .row &%queue_run_in_order%&          "order of arrival"
12713 .row &%queue_run_max%&               "of simultaneous queue runners"
12714 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12715 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12716 .row &%remote_sort_domains%&         "order of remote deliveries"
12717 .row &%retry_data_expire%&           "timeout for retry data"
12718 .row &%retry_interval_max%&          "safety net for retry rules"
12719 .endtable
12720
12721
12722
12723 .section "Bounce and warning messages" "SECID117"
12724 .table2
12725 .row &%bounce_message_file%&         "content of bounce"
12726 .row &%bounce_message_text%&         "content of bounce"
12727 .row &%bounce_return_body%&          "include body if returning message"
12728 .row &%bounce_return_message%&       "include original message in bounce"
12729 .row &%bounce_return_size_limit%&    "limit on returned message"
12730 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12731 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12732 .row &%errors_copy%&                 "copy bounce messages"
12733 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12734 .row &%delay_warning%&               "time schedule"
12735 .row &%delay_warning_condition%&     "condition for warning messages"
12736 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12737 .row &%smtp_return_error_details%&   "give detail on rejections"
12738 .row &%warn_message_file%&           "content of warning message"
12739 .endtable
12740
12741
12742
12743 .section "Alphabetical list of main options" "SECTalomo"
12744 Those options that undergo string expansion before use are marked with
12745 &dagger;.
12746
12747 .option accept_8bitmime main boolean false
12748 .cindex "8BITMIME"
12749 .cindex "8-bit characters"
12750 This option causes Exim to send 8BITMIME in its response to an SMTP
12751 EHLO command, and to accept the BODY= parameter on MAIL commands.
12752 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12753 takes no steps to do anything special with messages received by this route.
12754 Consequently, this option is turned off by default.
12755
12756 .option acl_not_smtp main string&!! unset
12757 .cindex "&ACL;" "for non-SMTP messages"
12758 .cindex "non-SMTP messages" "ACLs for"
12759 This option defines the ACL that is run when a non-SMTP message has been
12760 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12761 further details.
12762
12763 .option acl_not_smtp_mime main string&!! unset
12764 This option defines the ACL that is run for individual MIME parts of non-SMTP
12765 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12766 SMTP messages.
12767
12768 .option acl_not_smtp_start main string&!! unset
12769 .cindex "&ACL;" "at start of non-SMTP message"
12770 .cindex "non-SMTP messages" "ACLs for"
12771 This option defines the ACL that is run before Exim starts reading a
12772 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12773
12774 .option acl_smtp_auth main string&!! unset
12775 .cindex "&ACL;" "setting up for SMTP commands"
12776 .cindex "AUTH" "ACL for"
12777 This option defines the ACL that is run when an SMTP AUTH command is
12778 received. See chapter &<<CHAPACL>>& for further details.
12779
12780 .option acl_smtp_connect main string&!! unset
12781 .cindex "&ACL;" "on SMTP connection"
12782 This option defines the ACL that is run when an SMTP connection is received.
12783 See chapter &<<CHAPACL>>& for further details.
12784
12785 .option acl_smtp_data main string&!! unset
12786 .cindex "DATA" "ACL for"
12787 This option defines the ACL that is run after an SMTP DATA command has been
12788 processed and the message itself has been received, but before the final
12789 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12790
12791 .option acl_smtp_etrn main string&!! unset
12792 .cindex "ETRN" "ACL for"
12793 This option defines the ACL that is run when an SMTP ETRN command is
12794 received. See chapter &<<CHAPACL>>& for further details.
12795
12796 .option acl_smtp_expn main string&!! unset
12797 .cindex "EXPN" "ACL for"
12798 This option defines the ACL that is run when an SMTP EXPN command is
12799 received. See chapter &<<CHAPACL>>& for further details.
12800
12801 .option acl_smtp_helo main string&!! unset
12802 .cindex "EHLO" "ACL for"
12803 .cindex "HELO" "ACL for"
12804 This option defines the ACL that is run when an SMTP EHLO or HELO
12805 command is received. See chapter &<<CHAPACL>>& for further details.
12806
12807
12808 .option acl_smtp_mail main string&!! unset
12809 .cindex "MAIL" "ACL for"
12810 This option defines the ACL that is run when an SMTP MAIL command is
12811 received. See chapter &<<CHAPACL>>& for further details.
12812
12813 .option acl_smtp_mailauth main string&!! unset
12814 .cindex "AUTH" "on MAIL command"
12815 This option defines the ACL that is run when there is an AUTH parameter on
12816 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12817 &<<CHAPSMTPAUTH>>& for details of authentication.
12818
12819 .option acl_smtp_mime main string&!! unset
12820 .cindex "MIME content scanning" "ACL for"
12821 This option is available when Exim is built with the content-scanning
12822 extension. It defines the ACL that is run for each MIME part in a message. See
12823 section &<<SECTscanmimepart>>& for details.
12824
12825 .option acl_smtp_predata main string&!! unset
12826 This option defines the ACL that is run when an SMTP DATA command is
12827 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12828 further details.
12829
12830 .option acl_smtp_quit main string&!! unset
12831 .cindex "QUIT, ACL for"
12832 This option defines the ACL that is run when an SMTP QUIT command is
12833 received. See chapter &<<CHAPACL>>& for further details.
12834
12835 .option acl_smtp_rcpt main string&!! unset
12836 .cindex "RCPT" "ACL for"
12837 This option defines the ACL that is run when an SMTP RCPT command is
12838 received. See chapter &<<CHAPACL>>& for further details.
12839
12840 .option acl_smtp_starttls main string&!! unset
12841 .cindex "STARTTLS, ACL for"
12842 This option defines the ACL that is run when an SMTP STARTTLS command is
12843 received. See chapter &<<CHAPACL>>& for further details.
12844
12845 .option acl_smtp_vrfy main string&!! unset
12846 .cindex "VRFY" "ACL for"
12847 This option defines the ACL that is run when an SMTP VRFY command is
12848 received. See chapter &<<CHAPACL>>& for further details.
12849
12850 .option admin_groups main "string list&!!" unset
12851 .cindex "admin user"
12852 This option is expanded just once, at the start of Exim's processing. If the
12853 current group or any of the supplementary groups of an Exim caller is in this
12854 colon-separated list, the caller has admin privileges. If all your system
12855 programmers are in a specific group, for example, you can give them all Exim
12856 admin privileges by putting that group in &%admin_groups%&. However, this does
12857 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12858 To permit this, you have to add individuals to the Exim group.
12859
12860 .option allow_domain_literals main boolean false
12861 .cindex "domain literal"
12862 If this option is set, the RFC 2822 domain literal format is permitted in
12863 email addresses. The option is not set by default, because the domain literal
12864 format is not normally required these days, and few people know about it. It
12865 has, however, been exploited by mail abusers.
12866
12867 Unfortunately, it seems that some DNS black list maintainers are using this
12868 format to report black listing to postmasters. If you want to accept messages
12869 addressed to your hosts by IP address, you need to set
12870 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
12871 domains (defined in the named domain list &%local_domains%& in the default
12872 configuration). This &"magic string"& matches the domain literal form of all
12873 the local host's IP addresses.
12874
12875
12876 .option allow_mx_to_ip main boolean false
12877 .cindex "MX record" "pointing to IP address"
12878 It appears that more and more DNS zone administrators are breaking the rules
12879 and putting domain names that look like IP addresses on the right hand side of
12880 MX records. Exim follows the rules and rejects this, giving an error message
12881 that explains the mis-configuration. However, some other MTAs support this
12882 practice, so to avoid &"Why can't Exim do this?"& complaints,
12883 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
12884 recommended, except when you have no other choice.
12885
12886 .option allow_utf8_domains main boolean false
12887 .cindex "domain" "UTF-8 characters in"
12888 .cindex "UTF-8" "in domain name"
12889 Lots of discussion is going on about internationalized domain names. One
12890 camp is strongly in favour of just using UTF-8 characters, and it seems
12891 that at least two other MTAs permit this. This option allows Exim users to
12892 experiment if they wish.
12893
12894 If it is set true, Exim's domain parsing function allows valid
12895 UTF-8 multicharacters to appear in domain name components, in addition to
12896 letters, digits, and hyphens. However, just setting this option is not
12897 enough; if you want to look up these domain names in the DNS, you must also
12898 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
12899 suitable setting is:
12900 .code
12901 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
12902   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
12903 .endd
12904 Alternatively, you can just disable this feature by setting
12905 .code
12906 dns_check_names_pattern =
12907 .endd
12908 That is, set the option to an empty string so that no check is done.
12909
12910
12911 .option auth_advertise_hosts main "host list&!!" *
12912 .cindex "authentication" "advertising"
12913 .cindex "AUTH" "advertising"
12914 If any server authentication mechanisms are configured, Exim advertises them in
12915 response to an EHLO command only if the calling host matches this list.
12916 Otherwise, Exim does not advertise AUTH.
12917 Exim does not accept AUTH commands from clients to which it has not
12918 advertised the availability of AUTH. The advertising of individual
12919 authentication mechanisms can be controlled by the use of the
12920 &%server_advertise_condition%& generic authenticator option on the individual
12921 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
12922
12923 Certain mail clients (for example, Netscape) require the user to provide a name
12924 and password for authentication if AUTH is advertised, even though it may
12925 not be needed (the host may accept messages from hosts on its local LAN without
12926 authentication, for example). The &%auth_advertise_hosts%& option can be used
12927 to make these clients more friendly by excluding them from the set of hosts to
12928 which Exim advertises AUTH.
12929
12930 .cindex "AUTH" "advertising when encrypted"
12931 If you want to advertise the availability of AUTH only when the connection
12932 is encrypted using TLS, you can make use of the fact that the value of this
12933 option is expanded, with a setting like this:
12934 .code
12935 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
12936 .endd
12937 .vindex "&$tls_cipher$&"
12938 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
12939 the expansion is empty, thus matching no hosts. Otherwise, the result of the
12940 expansion is *, which matches all hosts.
12941
12942
12943 .option auto_thaw main time 0s
12944 .cindex "thawing messages"
12945 .cindex "unfreezing messages"
12946 If this option is set to a time greater than zero, a queue runner will try a
12947 new delivery attempt on any frozen message, other than a bounce message, if
12948 this much time has passed since it was frozen. This may result in the message
12949 being re-frozen if nothing has changed since the last attempt. It is a way of
12950 saying &"keep on trying, even though there are big problems"&.
12951
12952 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
12953 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
12954 thought to be very useful any more, and its use should probably be avoided.
12955
12956
12957 .option av_scanner main string "see below"
12958 This option is available if Exim is built with the content-scanning extension.
12959 It specifies which anti-virus scanner to use. The default value is:
12960 .code
12961 sophie:/var/run/sophie
12962 .endd
12963 If the value of &%av_scanner%& starts with a dollar character, it is expanded
12964 before use. See section &<<SECTscanvirus>>& for further details.
12965
12966
12967 .option bi_command main string unset
12968 .oindex "&%-bi%&"
12969 This option supplies the name of a command that is run when Exim is called with
12970 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
12971 just the command name, it is not a complete command line. If an argument is
12972 required, it must come from the &%-oA%& command line option.
12973
12974
12975 .option bounce_message_file main string unset
12976 .cindex "bounce message" "customizing"
12977 .cindex "customizing" "bounce message"
12978 This option defines a template file containing paragraphs of text to be used
12979 for constructing bounce messages.  Details of the file's contents are given in
12980 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
12981
12982
12983 .option bounce_message_text main string unset
12984 When this option is set, its contents are included in the default bounce
12985 message immediately after &"This message was created automatically by mail
12986 delivery software."& It is not used if &%bounce_message_file%& is set.
12987
12988 .option bounce_return_body main boolean true
12989 .cindex "bounce message" "including body"
12990 This option controls whether the body of an incoming message is included in a
12991 bounce message when &%bounce_return_message%& is true. The default setting
12992 causes the entire message, both header and body, to be returned (subject to the
12993 value of &%bounce_return_size_limit%&). If this option is false, only the
12994 message header is included. In the case of a non-SMTP message containing an
12995 error that is detected during reception, only those header lines preceding the
12996 point at which the error was detected are returned.
12997 .cindex "bounce message" "including original"
12998
12999 .option bounce_return_message main boolean true
13000 If this option is set false, none of the original message is included in
13001 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13002 &%bounce_return_body%&.
13003
13004
13005 .option bounce_return_size_limit main integer 100K
13006 .cindex "size" "of bounce, limit"
13007 .cindex "bounce message" "size limit"
13008 .cindex "limit" "bounce message size"
13009 This option sets a limit in bytes on the size of messages that are returned to
13010 senders as part of bounce messages when &%bounce_return_message%& is true. The
13011 limit should be less than the value of the global &%message_size_limit%& and of
13012 any &%message_size_limit%& settings on transports, to allow for the bounce text
13013 that Exim generates. If this option is set to zero there is no limit.
13014
13015 When the body of any message that is to be included in a bounce message is
13016 greater than the limit, it is truncated, and a comment pointing this out is
13017 added at the top. The actual cutoff may be greater than the value given, owing
13018 to the use of buffering for transferring the message in chunks (typically 8K in
13019 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13020 messages.
13021
13022 .option bounce_sender_authentication main string unset
13023 .cindex "bounce message" "sender authentication"
13024 .cindex "authentication" "bounce message"
13025 .cindex "AUTH" "on bounce message"
13026 This option provides an authenticated sender address that is sent with any
13027 bounce messages generated by Exim that are sent over an authenticated SMTP
13028 connection. A typical setting might be:
13029 .code
13030 bounce_sender_authentication = mailer-daemon@my.domain.example
13031 .endd
13032 which would cause bounce messages to be sent using the SMTP command:
13033 .code
13034 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13035 .endd
13036 The value of &%bounce_sender_authentication%& must always be a complete email
13037 address.
13038
13039 .option callout_domain_negative_expire main time 3h
13040 .cindex "caching" "callout timeouts"
13041 .cindex "callout" "caching timeouts"
13042 This option specifies the expiry time for negative callout cache data for a
13043 domain. See section &<<SECTcallver>>& for details of callout verification, and
13044 section &<<SECTcallvercache>>& for details of the caching.
13045
13046
13047 .option callout_domain_positive_expire main time 7d
13048 This option specifies the expiry time for positive callout cache data for a
13049 domain. See section &<<SECTcallver>>& for details of callout verification, and
13050 section &<<SECTcallvercache>>& for details of the caching.
13051
13052
13053 .option callout_negative_expire main time 2h
13054 This option specifies the expiry time for negative callout cache data for an
13055 address. See section &<<SECTcallver>>& for details of callout verification, and
13056 section &<<SECTcallvercache>>& for details of the caching.
13057
13058
13059 .option callout_positive_expire main time 24h
13060 This option specifies the expiry time for positive callout cache data for an
13061 address. See section &<<SECTcallver>>& for details of callout verification, and
13062 section &<<SECTcallvercache>>& for details of the caching.
13063
13064
13065 .option callout_random_local_part main string&!! "see below"
13066 This option defines the &"random"& local part that can be used as part of
13067 callout verification. The default value is
13068 .code
13069 $primary_host_name-$tod_epoch-testing
13070 .endd
13071 See section &<<CALLaddparcall>>& for details of how this value is used.
13072
13073
13074 .option check_log_inodes main integer 0
13075 See &%check_spool_space%& below.
13076
13077
13078 .option check_log_space main integer 0
13079 See &%check_spool_space%& below.
13080
13081 .oindex "&%check_rfc2047_length%&"
13082 .cindex "RFC 2047" "disabling length check"
13083 .option check_rfc2047_length main boolean true
13084 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13085 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13086 word; strings to be encoded that exceed this length are supposed to use
13087 multiple encoded words. By default, Exim does not recognize encoded words that
13088 exceed the maximum length. However, it seems that some software, in violation
13089 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13090 set false, Exim recognizes encoded words of any length.
13091
13092
13093 .option check_spool_inodes main integer 0
13094 See &%check_spool_space%& below.
13095
13096
13097 .option check_spool_space main integer 0
13098 .cindex "checking disk space"
13099 .cindex "disk space, checking"
13100 .cindex "spool directory" "checking space"
13101 The four &%check_...%& options allow for checking of disk resources before a
13102 message is accepted.
13103
13104 .vindex "&$log_inodes$&"
13105 .vindex "&$log_space$&"
13106 .vindex "&$spool_inodes$&"
13107 .vindex "&$spool_space$&"
13108 When any of these options are set, they apply to all incoming messages. If you
13109 want to apply different checks to different kinds of message, you can do so by
13110 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13111 &$spool_space$& in an ACL with appropriate additional conditions.
13112
13113
13114 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13115 either value is greater than zero, for example:
13116 .code
13117 check_spool_space = 10M
13118 check_spool_inodes = 100
13119 .endd
13120 The spool partition is the one that contains the directory defined by
13121 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13122 transit.
13123
13124 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13125 files are written if either is greater than zero. These should be set only if
13126 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13127
13128 If there is less space or fewer inodes than requested, Exim refuses to accept
13129 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13130 error response to the MAIL command. If ESMTP is in use and there was a
13131 SIZE parameter on the MAIL command, its value is added to the
13132 &%check_spool_space%& value, and the check is performed even if
13133 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13134
13135 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13136 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13137
13138 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13139 failure a message is written to stderr and Exim exits with a non-zero code, as
13140 it obviously cannot send an error message of any kind.
13141
13142 .option daemon_smtp_ports main string &`smtp`&
13143 .cindex "port" "for daemon"
13144 .cindex "TCP/IP" "setting listening ports"
13145 This option specifies one or more default SMTP ports on which the Exim daemon
13146 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13147 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13148
13149 .option daemon_startup_retries main integer 9
13150 .cindex "daemon startup, retrying"
13151 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13152 the daemon at startup when it cannot immediately bind a listening socket
13153 (typically because the socket is already in use): &%daemon_startup_retries%&
13154 defines the number of retries after the first failure, and
13155 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13156
13157 .option daemon_startup_sleep main time 30s
13158 See &%daemon_startup_retries%&.
13159
13160 .option delay_warning main "time list" 24h
13161 .cindex "warning of delay"
13162 .cindex "delay warning, specifying"
13163 When a message is delayed, Exim sends a warning message to the sender at
13164 intervals specified by this option. The data is a colon-separated list of times
13165 after which to send warning messages. If the value of the option is an empty
13166 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13167 message has been on the queue for longer than the last time, the last interval
13168 between the times is used to compute subsequent warning times. For example,
13169 with
13170 .code
13171 delay_warning = 4h:8h:24h
13172 .endd
13173 the first message is sent after 4 hours, the second after 8 hours, and
13174 the third one after 24 hours. After that, messages are sent every 16 hours,
13175 because that is the interval between the last two times on the list. If you set
13176 just one time, it specifies the repeat interval. For example, with:
13177 .code
13178 delay_warning = 6h
13179 .endd
13180 messages are repeated every six hours. To stop warnings after a given time, set
13181 a very large time at the end of the list. For example:
13182 .code
13183 delay_warning = 2h:12h:99d
13184 .endd
13185
13186 .option delay_warning_condition main string&!! "see below"
13187 .vindex "&$domain$&"
13188 The string is expanded at the time a warning message might be sent. If all the
13189 deferred addresses have the same domain, it is set in &$domain$& during the
13190 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13191 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13192 &"false"& (the comparison being done caselessly) then the warning message is
13193 not sent. The default is:
13194 .code
13195 delay_warning_condition = ${if or {\
13196   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13197   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13198   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13199   } {no}{yes}}
13200 .endd
13201 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13202 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13203 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13204 &"auto-replied"& in an &'Auto-Submitted:'& header.
13205
13206 .option deliver_drop_privilege main boolean false
13207 .cindex "unprivileged delivery"
13208 .cindex "delivery" "unprivileged"
13209 If this option is set true, Exim drops its root privilege at the start of a
13210 delivery process, and runs as the Exim user throughout. This severely restricts
13211 the kinds of local delivery that are possible, but is viable in certain types
13212 of configuration. There is a discussion about the use of root privilege in
13213 chapter &<<CHAPsecurity>>&.
13214
13215 .option deliver_queue_load_max main fixed-point unset
13216 .cindex "load average"
13217 .cindex "queue runner" "abandoning"
13218 When this option is set, a queue run is abandoned if the system load average
13219 becomes greater than the value of the option. The option has no effect on
13220 ancient operating systems on which Exim cannot determine the load average.
13221 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13222
13223
13224 .option delivery_date_remove main boolean true
13225 .cindex "&'Delivery-date:'& header line"
13226 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13227 message when it is delivered, in exactly the same way as &'Return-path:'& is
13228 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13229 should not be present in incoming messages, and this option causes them to be
13230 removed at the time the message is received, to avoid any problems that might
13231 occur when a delivered message is subsequently sent on to some other recipient.
13232
13233 .option disable_fsync main boolean false
13234 .cindex "&[fsync()]&, disabling"
13235 This option is available only if Exim was built with the compile-time option
13236 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13237 a runtime configuration generates an &"unknown option"& error. You should not
13238 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13239 really, really, really understand what you are doing. &'No pre-compiled
13240 distributions of Exim should ever make this option available.'&
13241
13242 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13243 updated files' data to be written to disc before continuing. Unexpected events
13244 such as crashes and power outages may cause data to be lost or scrambled.
13245 Here be Dragons. &*Beware.*&
13246
13247
13248 .option disable_ipv6 main boolean false
13249 .cindex "IPv6" "disabling"
13250 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13251 activities take place. AAAA records are never looked up, and any IPv6 addresses
13252 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13253 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13254 to handle IPv6 literal addresses.
13255
13256
13257 .option dns_again_means_nonexist main "domain list&!!" unset
13258 .cindex "DNS" "&""try again""& response; overriding"
13259 DNS lookups give a &"try again"& response for the DNS errors
13260 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13261 keep trying to deliver a message, or to give repeated temporary errors to
13262 incoming mail. Sometimes the effect is caused by a badly set up name server and
13263 may persist for a long time. If a domain which exhibits this problem matches
13264 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13265 This option should be used with care. You can make it apply to reverse lookups
13266 by a setting such as this:
13267 .code
13268 dns_again_means_nonexist = *.in-addr.arpa
13269 .endd
13270 This option applies to all DNS lookups that Exim does. It also applies when the
13271 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13272 since these are most likely to be caused by DNS lookup problems. The
13273 &(dnslookup)& router has some options of its own for controlling what happens
13274 when lookups for MX or SRV records give temporary errors. These more specific
13275 options are applied after this global option.
13276
13277 .option dns_check_names_pattern main string "see below"
13278 .cindex "DNS" "pre-check of name syntax"
13279 When this option is set to a non-empty string, it causes Exim to check domain
13280 names for characters that are not allowed in host names before handing them to
13281 the DNS resolver, because some resolvers give temporary errors for names that
13282 contain unusual characters. If a domain name contains any unwanted characters,
13283 a &"not found"& result is forced, and the resolver is not called. The check is
13284 done by matching the domain name against a regular expression, which is the
13285 value of this option. The default pattern is
13286 .code
13287 dns_check_names_pattern = \
13288   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13289 .endd
13290 which permits only letters, digits, slashes, and hyphens in components, but
13291 they must start and end with a letter or digit. Slashes are not, in fact,
13292 permitted in host names, but they are found in certain NS records (which can be
13293 accessed in Exim by using a &%dnsdb%& lookup). If you set
13294 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13295 empty string.
13296
13297 .option dns_csa_search_limit main integer 5
13298 This option controls the depth of parental searching for CSA SRV records in the
13299 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13300
13301 .option dns_csa_use_reverse main boolean true
13302 This option controls whether or not an IP address, given as a CSA domain, is
13303 reversed and looked up in the reverse DNS, as described in more detail in
13304 section &<<SECTverifyCSA>>&.
13305
13306 .option dns_ipv4_lookup main "domain list&!!" unset
13307 .cindex "IPv6" "DNS lookup for AAAA records"
13308 .cindex "DNS" "IPv6 lookup for AAAA records"
13309 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13310 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13311 (A records) when trying to find IP addresses for hosts, unless the host's
13312 domain matches this list.
13313
13314 This is a fudge to help with name servers that give big delays or otherwise do
13315 not work for the AAAA record type. In due course, when the world's name
13316 servers have all been upgraded, there should be no need for this option.
13317
13318
13319 .option dns_retrans main time 0s
13320 .cindex "DNS" "resolver options"
13321 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13322 retransmission and retry parameters for DNS lookups. Values of zero (the
13323 defaults) leave the system default settings unchanged. The first value is the
13324 time between retries, and the second is the number of retries. It isn't
13325 totally clear exactly how these settings affect the total time a DNS lookup may
13326 take. I haven't found any documentation about timeouts on DNS lookups; these
13327 parameter values are available in the external resolver interface structure,
13328 but nowhere does it seem to describe how they are used or what you might want
13329 to set in them.
13330
13331
13332 .option dns_retry main integer 0
13333 See &%dns_retrans%& above.
13334
13335
13336 .new
13337 .option dns_use_edns0 main integer -1
13338 .cindex "DNS" "resolver options"
13339 .cindex "DNS" "EDNS0"
13340 If this option is set to a non-negative number then Exim will initialise the
13341 DNS resolver library to either use or not use EDNS0 extensions, overriding
13342 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13343 on.
13344
13345 If the resolver library does not support EDNS0 then this option has no effect.
13346 .wen
13347
13348
13349 .option drop_cr main boolean false
13350 This is an obsolete option that is now a no-op. It used to affect the way Exim
13351 handled CR and LF characters in incoming messages. What happens now is
13352 described in section &<<SECTlineendings>>&.
13353
13354 .option dsn_from main "string&!!" "see below"
13355 .cindex "&'From:'& header line" "in bounces"
13356 .cindex "bounce messages" "&'From:'& line, specifying"
13357 This option can be used to vary the contents of &'From:'& header lines in
13358 bounces and other automatically generated messages (&"Delivery Status
13359 Notifications"& &-- hence the name of the option). The default setting is:
13360 .code
13361 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13362 .endd
13363 The value is expanded every time it is needed. If the expansion fails, a
13364 panic is logged, and the default value is used.
13365
13366 .option envelope_to_remove main boolean true
13367 .cindex "&'Envelope-to:'& header line"
13368 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13369 message when it is delivered, in exactly the same way as &'Return-path:'& is
13370 handled. &'Envelope-to:'& records the original recipient address from the
13371 messages's envelope that caused the delivery to happen. Such headers should not
13372 be present in incoming messages, and this option causes them to be removed at
13373 the time the message is received, to avoid any problems that might occur when a
13374 delivered message is subsequently sent on to some other recipient.
13375
13376
13377 .option errors_copy main "string list&!!" unset
13378 .cindex "bounce message" "copy to other address"
13379 .cindex "copy of bounce message"
13380 Setting this option causes Exim to send bcc copies of bounce messages that it
13381 generates to other addresses. &*Note*&: This does not apply to bounce messages
13382 coming from elsewhere. The value of the option is a colon-separated list of
13383 items. Each item consists of a pattern, terminated by white space, followed by
13384 a comma-separated list of email addresses. If a pattern contains spaces, it
13385 must be enclosed in double quotes.
13386
13387 Each pattern is processed in the same way as a single item in an address list
13388 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13389 the bounce message, the message is copied to the addresses on the list. The
13390 items are scanned in order, and once a matching one is found, no further items
13391 are examined. For example:
13392 .code
13393 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13394               rqps@mydomain   hostmaster@mydomain.example,\
13395                               postmaster@mydomain.example
13396 .endd
13397 .vindex "&$domain$&"
13398 .vindex "&$local_part$&"
13399 The address list is expanded before use. The expansion variables &$local_part$&
13400 and &$domain$& are set from the original recipient of the error message, and if
13401 there was any wildcard matching in the pattern, the expansion
13402 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13403 variables &$0$&, &$1$&, etc. are set in the normal way.
13404
13405
13406 .option errors_reply_to main string unset
13407 .cindex "bounce message" "&'Reply-to:'& in"
13408 By default, Exim's bounce and delivery warning messages contain the header line
13409 .display
13410 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13411 .endd
13412 .oindex &%quota_warn_message%&
13413 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13414 A warning message that is generated by the &%quota_warn_message%& option in an
13415 &(appendfile)& transport may contain its own &'From:'& header line that
13416 overrides the default.
13417
13418 Experience shows that people reply to bounce messages. If the
13419 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13420 and warning messages. For example:
13421 .code
13422 errors_reply_to = postmaster@my.domain.example
13423 .endd
13424 The value of the option is not expanded. It must specify a valid RFC 2822
13425 address. However, if a warning message that is generated by the
13426 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13427 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13428 not used.
13429
13430
13431 .option exim_group main string "compile-time configured"
13432 .cindex "gid (group id)" "Exim's own"
13433 .cindex "Exim group"
13434 This option changes the gid under which Exim runs when it gives up root
13435 privilege. The default value is compiled into the binary. The value of this
13436 option is used only when &%exim_user%& is also set. Unless it consists entirely
13437 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13438 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13439 security issues.
13440
13441
13442 .option exim_path main string "see below"
13443 .cindex "Exim binary, path name"
13444 This option specifies the path name of the Exim binary, which is used when Exim
13445 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13446 the directory configured at compile time by the BIN_DIRECTORY setting. It
13447 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13448 other place.
13449 &*Warning*&: Do not use a macro to define the value of this option, because
13450 you will break those Exim utilities that scan the configuration file to find
13451 where the binary is. (They then use the &%-bP%& option to extract option
13452 settings such as the value of &%spool_directory%&.)
13453
13454
13455 .option exim_user main string "compile-time configured"
13456 .cindex "uid (user id)" "Exim's own"
13457 .cindex "Exim user"
13458 This option changes the uid under which Exim runs when it gives up root
13459 privilege. The default value is compiled into the binary. Ownership of the run
13460 time configuration file and the use of the &%-C%& and &%-D%& command line
13461 options is checked against the values in the binary, not what is set here.
13462
13463 Unless it consists entirely of digits, the string is looked up using
13464 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13465 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13466 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13467
13468
13469 .option extra_local_interfaces main "string list" unset
13470 This option defines network interfaces that are to be considered local when
13471 routing, but which are not used for listening by the daemon. See section
13472 &<<SECTreclocipadd>>& for details.
13473
13474
13475 . Allow this long option name to split; give it unsplit as a fifth argument
13476 . for the automatic .oindex that is generated by .option.
13477
13478 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13479          extract_addresses_remove_arguments
13480 .oindex "&%-t%&"
13481 .cindex "command line" "addresses with &%-t%&"
13482 .cindex "Sendmail compatibility" "&%-t%& option"
13483 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13484 are present on the command line when the &%-t%& option is used to build an
13485 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13486 line addresses are removed from the recipients list. This is also how Smail
13487 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13488 command line addresses are added to those obtained from the header lines. When
13489 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13490 argument headers. If it is set false, Exim adds rather than removes argument
13491 addresses.
13492
13493
13494 .option finduser_retries main integer 0
13495 .cindex "NIS, retrying user lookups"
13496 On systems running NIS or other schemes in which user and group information is
13497 distributed from a remote system, there can be times when &[getpwnam()]& and
13498 related functions fail, even when given valid data, because things time out.
13499 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13500 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13501 many extra times to find a user or a group, waiting for one second between
13502 retries.
13503
13504 .cindex "&_/etc/passwd_&" "multiple reading of"
13505 You should not set this option greater than zero if your user information is in
13506 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13507 search the file multiple times for non-existent users, and also cause delay.
13508
13509
13510
13511 .option freeze_tell main "string list, comma separated" unset
13512 .cindex "freezing messages" "sending a message when freezing"
13513 On encountering certain errors, or when configured to do so in a system filter,
13514 ACL, or special router, Exim freezes a message. This means that no further
13515 delivery attempts take place until an administrator thaws the message, or the
13516 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13517 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13518 warning message whenever it freezes something, unless the message it is
13519 freezing is a locally-generated bounce message. (Without this exception there
13520 is the possibility of looping.) The warning message is sent to the addresses
13521 supplied as the comma-separated value of this option. If several of the
13522 message's addresses cause freezing, only a single message is sent. If the
13523 freezing was automatic, the reason(s) for freezing can be found in the message
13524 log. If you configure freezing in a filter or ACL, you must arrange for any
13525 logging that you require.
13526
13527
13528 .option gecos_name main string&!! unset
13529 .cindex "HP-UX"
13530 .cindex "&""gecos""& field, parsing"
13531 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13532 password file to hold other information in addition to users' real names. Exim
13533 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13534 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13535 of the field are used unchanged, except that, if an ampersand is encountered,
13536 it is replaced by the user's login name with the first character forced to
13537 upper case, since this is a convention that is observed on many systems.
13538
13539 When these options are set, &%gecos_pattern%& is treated as a regular
13540 expression that is to be applied to the field (again with && replaced by the
13541 login name), and if it matches, &%gecos_name%& is expanded and used as the
13542 user's name.
13543
13544 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13545 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13546 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13547 name terminates at the first comma, the following can be used:
13548 .code
13549 gecos_pattern = ([^,]*)
13550 gecos_name = $1
13551 .endd
13552
13553 .option gecos_pattern main string unset
13554 See &%gecos_name%& above.
13555
13556
13557 .option gnutls_require_kx main string unset
13558 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
13559 server. For details, see section &<<SECTreqciphgnu>>&.
13560
13561 .option gnutls_require_mac main string unset
13562 This option controls the MAC algorithms when GnuTLS is used in an Exim
13563 server. For details, see section &<<SECTreqciphgnu>>&.
13564
13565 .option gnutls_require_protocols main string unset
13566 This option controls the protocols when GnuTLS is used in an Exim
13567 server. For details, see section &<<SECTreqciphgnu>>&.
13568
13569 .option gnutls_compat_mode main boolean unset
13570 This option controls whether GnuTLS is used in compatibility mode in an Exim
13571 server. This reduces security slightly, but improves interworking with older
13572 implementations of TLS.
13573
13574 .option headers_charset main string "see below"
13575 This option sets a default character set for translating from encoded MIME
13576 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13577 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13578 ultimate default is ISO-8859-1. For more details see the description of header
13579 insertions in section &<<SECTexpansionitems>>&.
13580
13581
13582
13583 .option header_maxsize main integer "see below"
13584 .cindex "header section" "maximum size of"
13585 .cindex "limit" "size of message header section"
13586 This option controls the overall maximum size of a message's header
13587 section. The default is the value of HEADER_MAXSIZE in
13588 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13589 sections are rejected.
13590
13591
13592 .option header_line_maxsize main integer 0
13593 .cindex "header lines" "maximum size of"
13594 .cindex "limit" "size of one header line"
13595 This option limits the length of any individual header line in a message, after
13596 all the continuations have been joined together. Messages with individual
13597 header lines that are longer than the limit are rejected. The default value of
13598 zero means &"no limit"&.
13599
13600
13601
13602
13603 .option helo_accept_junk_hosts main "host list&!!" unset
13604 .cindex "HELO" "accepting junk data"
13605 .cindex "EHLO" "accepting junk data"
13606 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13607 mail, and gives an error response for invalid data. Unfortunately, there are
13608 some SMTP clients that send syntactic junk. They can be accommodated by setting
13609 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13610 if you want to do semantic checking.
13611 See also &%helo_allow_chars%& for a way of extending the permitted character
13612 set.
13613
13614
13615 .option helo_allow_chars main string unset
13616 .cindex "HELO" "underscores in"
13617 .cindex "EHLO" "underscores in"
13618 .cindex "underscore in EHLO/HELO"
13619 This option can be set to a string of rogue characters that are permitted in
13620 all EHLO and HELO names in addition to the standard letters, digits,
13621 hyphens, and dots. If you really must allow underscores, you can set
13622 .code
13623 helo_allow_chars = _
13624 .endd
13625 Note that the value is one string, not a list.
13626
13627
13628 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13629 .cindex "HELO" "forcing reverse lookup"
13630 .cindex "EHLO" "forcing reverse lookup"
13631 If the domain given by a client in a HELO or EHLO command matches this
13632 list, a reverse lookup is done in order to establish the host's true name. The
13633 default forces a lookup if the client host gives the server's name or any of
13634 its IP addresses (in brackets), something that broken clients have been seen to
13635 do.
13636
13637
13638 .option helo_try_verify_hosts main "host list&!!" unset
13639 .cindex "HELO verifying" "optional"
13640 .cindex "EHLO" "verifying, optional"
13641 By default, Exim just checks the syntax of HELO and EHLO commands (see
13642 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13643 to do more extensive checking of the data supplied by these commands. The ACL
13644 condition &`verify = helo`& is provided to make this possible.
13645 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13646 to force the check to occur. From release 4.53 onwards, this is no longer
13647 necessary. If the check has not been done before &`verify = helo`& is
13648 encountered, it is done at that time. Consequently, this option is obsolete.
13649 Its specification is retained here for backwards compatibility.
13650
13651 When an EHLO or HELO command is received, if the calling host matches
13652 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13653 EHLO command either:
13654
13655 .ilist
13656 is an IP literal matching the calling address of the host, or
13657 .next
13658 .cindex "DNS" "reverse lookup"
13659 .cindex "reverse DNS lookup"
13660 matches the host name that Exim obtains by doing a reverse lookup of the
13661 calling host address, or
13662 .next
13663 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13664 available) yields the calling host address.
13665 .endlist
13666
13667 However, the EHLO or HELO command is not rejected if any of the checks
13668 fail. Processing continues, but the result of the check is remembered, and can
13669 be detected later in an ACL by the &`verify = helo`& condition.
13670
13671 .option helo_verify_hosts main "host list&!!" unset
13672 .cindex "HELO verifying" "mandatory"
13673 .cindex "EHLO" "verifying, mandatory"
13674 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13675 backwards compatibility. For hosts that match this option, Exim checks the host
13676 name given in the HELO or EHLO in the same way as for
13677 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13678 rejected with a 550 error, and entries are written to the main and reject logs.
13679 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13680 error.
13681
13682 .option hold_domains main "domain list&!!" unset
13683 .cindex "domain" "delaying delivery"
13684 .cindex "delivery" "delaying certain domains"
13685 This option allows mail for particular domains to be held on the queue
13686 manually. The option is overridden if a message delivery is forced with the
13687 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13688 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13689 item in &%hold_domains%&, no routing or delivery for that address is done, and
13690 it is deferred every time the message is looked at.
13691
13692 This option is intended as a temporary operational measure for delaying the
13693 delivery of mail while some problem is being sorted out, or some new
13694 configuration tested. If you just want to delay the processing of some
13695 domains until a queue run occurs, you should use &%queue_domains%& or
13696 &%queue_smtp_domains%&, not &%hold_domains%&.
13697
13698 A setting of &%hold_domains%& does not override Exim's code for removing
13699 messages from the queue if they have been there longer than the longest retry
13700 time in any retry rule. If you want to hold messages for longer than the normal
13701 retry times, insert a dummy retry rule with a long retry time.
13702
13703
13704 .option host_lookup main "host list&!!" unset
13705 .cindex "host name" "lookup, forcing"
13706 Exim does not look up the name of a calling host from its IP address unless it
13707 is required to compare against some host list, or the host matches
13708 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13709 option (which normally contains IP addresses rather than host names). The
13710 default configuration file contains
13711 .code
13712 host_lookup = *
13713 .endd
13714 which causes a lookup to happen for all hosts. If the expense of these lookups
13715 is felt to be too great, the setting can be changed or removed.
13716
13717 After a successful reverse lookup, Exim does a forward lookup on the name it
13718 has obtained, to verify that it yields the IP address that it started with. If
13719 this check fails, Exim behaves as if the name lookup failed.
13720
13721 .vindex "&$host_lookup_failed$&"
13722 .vindex "&$sender_host_name$&"
13723 After any kind of failure, the host name (in &$sender_host_name$&) remains
13724 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13725 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13726 &`verify = reverse_host_lookup`& in ACLs.
13727
13728
13729 .option host_lookup_order main "string list" &`bydns:byaddr`&
13730 This option specifies the order of different lookup methods when Exim is trying
13731 to find a host name from an IP address. The default is to do a DNS lookup
13732 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13733 if that fails. You can change the order of these lookups, or omit one entirely,
13734 if you want.
13735
13736 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13737 multiple PTR records in the DNS and the IP address is not listed in
13738 &_/etc/hosts_&. Different operating systems give different results in this
13739 case. That is why the default tries a DNS lookup first.
13740
13741
13742
13743 .option host_reject_connection main "host list&!!" unset
13744 .cindex "host" "rejecting connections from"
13745 If this option is set, incoming SMTP calls from the hosts listed are rejected
13746 as soon as the connection is made.
13747 This option is obsolete, and retained only for backward compatibility, because
13748 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13749 connections immediately.
13750
13751 The ability to give an immediate rejection (either by this option or using an
13752 ACL) is provided for use in unusual cases. Many hosts will just try again,
13753 sometimes without much delay. Normally, it is better to use an ACL to reject
13754 incoming messages at a later stage, such as after RCPT commands. See
13755 chapter &<<CHAPACL>>&.
13756
13757
13758 .option hosts_connection_nolog main "host list&!!" unset
13759 .cindex "host" "not logging connections from"
13760 This option defines a list of hosts for which connection logging does not
13761 happen, even though the &%smtp_connection%& log selector is set. For example,
13762 you might want not to log SMTP connections from local processes, or from
13763 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13764 the daemon; you should therefore strive to restrict its value to a short inline
13765 list of IP addresses and networks. To disable logging SMTP connections from
13766 local processes, you must create a host list with an empty item. For example:
13767 .code
13768 hosts_connection_nolog = :
13769 .endd
13770 If the &%smtp_connection%& log selector is not set, this option has no effect.
13771
13772
13773
13774 .option hosts_treat_as_local main "domain list&!!" unset
13775 .cindex "local host" "domains treated as"
13776 .cindex "host" "treated as local"
13777 If this option is set, any host names that match the domain list are treated as
13778 if they were the local host when Exim is scanning host lists obtained from MX
13779 records
13780 or other sources. Note that the value of this option is a domain list, not a
13781 host list, because it is always used to check host names, not IP addresses.
13782
13783 This option also applies when Exim is matching the special items
13784 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13785 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13786 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13787 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13788 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13789 interfaces and recognizing the local host.
13790
13791
13792 .option ibase_servers main "string list" unset
13793 .cindex "InterBase" "server list"
13794 This option provides a list of InterBase servers and associated connection data,
13795 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13796 The option is available only if Exim has been built with InterBase support.
13797
13798
13799
13800 .option ignore_bounce_errors_after main time 10w
13801 .cindex "bounce message" "discarding"
13802 .cindex "discarding bounce message"
13803 This option affects the processing of bounce messages that cannot be delivered,
13804 that is, those that suffer a permanent delivery failure. (Bounce messages that
13805 suffer temporary delivery failures are of course retried in the usual way.)
13806
13807 After a permanent delivery failure, bounce messages are frozen,
13808 because there is no sender to whom they can be returned. When a frozen bounce
13809 message has been on the queue for more than the given time, it is unfrozen at
13810 the next queue run, and a further delivery is attempted. If delivery fails
13811 again, the bounce message is discarded. This makes it possible to keep failed
13812 bounce messages around for a shorter time than the normal maximum retry time
13813 for frozen messages. For example,
13814 .code
13815 ignore_bounce_errors_after = 12h
13816 .endd
13817 retries failed bounce message deliveries after 12 hours, discarding any further
13818 failures. If the value of this option is set to a zero time period, bounce
13819 failures are discarded immediately. Setting a very long time (as in the default
13820 value) has the effect of disabling this option. For ways of automatically
13821 dealing with other kinds of frozen message, see &%auto_thaw%& and
13822 &%timeout_frozen_after%&.
13823
13824
13825 .option ignore_fromline_hosts main "host list&!!" unset
13826 .cindex "&""From""& line"
13827 .cindex "UUCP" "&""From""& line"
13828 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13829 the headers of a message. By default this is treated as the start of the
13830 message's body, which means that any following headers are not recognized as
13831 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13832 match those hosts that insist on sending it. If the sender is actually a local
13833 process rather than a remote host, and is using &%-bs%& to inject the messages,
13834 &%ignore_fromline_local%& must be set to achieve this effect.
13835
13836
13837 .option ignore_fromline_local main boolean false
13838 See &%ignore_fromline_hosts%& above.
13839
13840
13841 .option keep_malformed main time 4d
13842 This option specifies the length of time to keep messages whose spool files
13843 have been corrupted in some way. This should, of course, never happen. At the
13844 next attempt to deliver such a message, it gets removed. The incident is
13845 logged.
13846
13847
13848 .option ldap_ca_cert_dir main string unset
13849 .cindex "LDAP", "TLS CA certificate directory"
13850 This option indicates which directory contains CA certificates for verifying
13851 a TLS certificate presented by an LDAP server.
13852 While Exim does not provide a default value, your SSL library may.
13853 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13854 and constrained to be a directory.
13855
13856
13857 .option ldap_ca_cert_file main string unset
13858 .cindex "LDAP", "TLS CA certificate file"
13859 This option indicates which file contains CA certificates for verifying
13860 a TLS certificate presented by an LDAP server.
13861 While Exim does not provide a default value, your SSL library may.
13862 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13863 and constrained to be a file.
13864
13865
13866 .option ldap_cert_file main string unset
13867 .cindex "LDAP" "TLS client certificate file"
13868 This option indicates which file contains an TLS client certificate which
13869 Exim should present to the LDAP server during TLS negotiation.
13870 Should be used together with &%ldap_cert_key%&.
13871
13872
13873 .option ldap_cert_key main string unset
13874 .cindex "LDAP" "TLS client key file"
13875 This option indicates which file contains the secret/private key to use
13876 to prove identity to the LDAP server during TLS negotiation.
13877 Should be used together with &%ldap_cert_file%&, which contains the
13878 identity to be proven.
13879
13880
13881 .option ldap_cipher_suite main string unset
13882 .cindex "LDAP" "TLS cipher suite"
13883 This controls the TLS cipher-suite negotiation during TLS negotiation with
13884 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
13885 cipher-suite options with OpenSSL (as used by LDAP client libraries).
13886
13887
13888 .option ldap_default_servers main "string list" unset
13889 .cindex "LDAP" "default servers"
13890 This option provides a list of LDAP servers which are tried in turn when an
13891 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
13892 details of LDAP queries. This option is available only when Exim has been built
13893 with LDAP support.
13894
13895
13896 .option ldap_require_cert main string unset.
13897 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
13898 This should be one of the values "hard", "demand", "allow", "try" or "never".
13899 A value other than one of these is interpreted as "never".
13900 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
13901 Although Exim does not set a default, the LDAP library probably defaults
13902 to hard/demand.
13903
13904
13905 .option ldap_start_tls main boolean false
13906 .cindex "LDAP" "whether or not to negotiate TLS"
13907 If set, Exim will attempt to negotiate TLS with the LDAP server when
13908 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
13909 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
13910 of SSL-on-connect.
13911 In the event of failure to negotiate TLS, the action taken is controlled
13912 by &%ldap_require_cert%&.
13913
13914
13915 .option ldap_version main integer unset
13916 .cindex "LDAP" "protocol version, forcing"
13917 This option can be used to force Exim to set a specific protocol version for
13918 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
13919 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
13920 the LDAP headers; otherwise it is 2. This option is available only when Exim
13921 has been built with LDAP support.
13922
13923
13924
13925 .option local_from_check main boolean true
13926 .cindex "&'Sender:'& header line" "disabling addition of"
13927 .cindex "&'From:'& header line" "disabling checking of"
13928 When a message is submitted locally (that is, not over a TCP/IP connection) by
13929 an untrusted user, Exim removes any existing &'Sender:'& header line, and
13930 checks that the &'From:'& header line matches the login of the calling user and
13931 the domain specified by &%qualify_domain%&.
13932
13933 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
13934 locally submitted message is automatically qualified by Exim, unless the
13935 &%-bnq%& command line option is used.
13936
13937 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
13938 on the local part. If the &'From:'& header line does not match, Exim adds a
13939 &'Sender:'& header with an address constructed from the calling user's login
13940 and the default qualify domain.
13941
13942 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
13943 and no &'Sender:'& header is ever added. If, in addition, you want to retain
13944 &'Sender:'& header lines supplied by untrusted users, you must also set
13945 &%local_sender_retain%& to be true.
13946
13947 .cindex "envelope sender"
13948 These options affect only the header lines in the message. The envelope sender
13949 is still forced to be the login id at the qualify domain unless
13950 &%untrusted_set_sender%& permits the user to supply an envelope sender.
13951
13952 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
13953 request similar header line checking. See section &<<SECTthesenhea>>&, which
13954 has more details about &'Sender:'& processing.
13955
13956
13957
13958
13959 .option local_from_prefix main string unset
13960 When Exim checks the &'From:'& header line of locally submitted messages for
13961 matching the login id (see &%local_from_check%& above), it can be configured to
13962 ignore certain prefixes and suffixes in the local part of the address. This is
13963 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
13964 appropriate lists, in the same form as the &%local_part_prefix%& and
13965 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
13966 example, if
13967 .code
13968 local_from_prefix = *-
13969 .endd
13970 is set, a &'From:'& line containing
13971 .code
13972 From: anything-user@your.domain.example
13973 .endd
13974 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
13975 matches the actual sender address that is constructed from the login name and
13976 qualify domain.
13977
13978
13979 .option local_from_suffix main string unset
13980 See &%local_from_prefix%& above.
13981
13982
13983 .option local_interfaces main "string list" "see below"
13984 This option controls which network interfaces are used by the daemon for
13985 listening; they are also used to identify the local host when routing. Chapter
13986 &<<CHAPinterfaces>>& contains a full description of this option and the related
13987 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
13988 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
13989 &%local_interfaces%& is
13990 .code
13991 local_interfaces = 0.0.0.0
13992 .endd
13993 when Exim is built without IPv6 support; otherwise it is
13994 .code
13995 local_interfaces = <; ::0 ; 0.0.0.0
13996 .endd
13997
13998 .option local_scan_timeout main time 5m
13999 .cindex "timeout" "for &[local_scan()]& function"
14000 .cindex "&[local_scan()]& function" "timeout"
14001 This timeout applies to the &[local_scan()]& function (see chapter
14002 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14003 the incoming message is rejected with a temporary error if it is an SMTP
14004 message. For a non-SMTP message, the message is dropped and Exim ends with a
14005 non-zero code. The incident is logged on the main and reject logs.
14006
14007
14008
14009 .option local_sender_retain main boolean false
14010 .cindex "&'Sender:'& header line" "retaining from local submission"
14011 When a message is submitted locally (that is, not over a TCP/IP connection) by
14012 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14013 do not want this to happen, you must set &%local_sender_retain%&, and you must
14014 also set &%local_from_check%& to be false (Exim will complain if you do not).
14015 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14016 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14017
14018
14019
14020
14021 .option localhost_number main string&!! unset
14022 .cindex "host" "locally unique number for"
14023 .cindex "message ids" "with multiple hosts"
14024 .vindex "&$localhost_number$&"
14025 Exim's message ids are normally unique only within the local host. If
14026 uniqueness among a set of hosts is required, each host must set a different
14027 value for the &%localhost_number%& option. The string is expanded immediately
14028 after reading the configuration file (so that a number can be computed from the
14029 host name, for example) and the result of the expansion must be a number in the
14030 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14031 systems). This is available in subsequent string expansions via the variable
14032 &$localhost_number$&. When &%localhost_number is set%&, the final two
14033 characters of the message id, instead of just being a fractional part of the
14034 time, are computed from the time and the local host number as described in
14035 section &<<SECTmessiden>>&.
14036
14037
14038
14039 .option log_file_path main "string list&!!" "set at compile time"
14040 .cindex "log" "file path for"
14041 This option sets the path which is used to determine the names of Exim's log
14042 files, or indicates that logging is to be to syslog, or both. It is expanded
14043 when Exim is entered, so it can, for example, contain a reference to the host
14044 name. If no specific path is set for the log files at compile or run time, they
14045 are written in a sub-directory called &_log_& in Exim's spool directory.
14046 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14047 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14048 used. If this string is fixed at your installation (contains no expansion
14049 variables) it is recommended that you do not set this option in the
14050 configuration file, but instead supply the path using LOG_FILE_PATH in
14051 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14052 early on &-- in particular, failure to read the configuration file.
14053
14054
14055 .option log_selector main string unset
14056 .cindex "log" "selectors"
14057 This option can be used to reduce or increase the number of things that Exim
14058 writes to its log files. Its argument is made up of names preceded by plus or
14059 minus characters. For example:
14060 .code
14061 log_selector = +arguments -retry_defer
14062 .endd
14063 A list of possible names and what they control is given in the chapter on
14064 logging, in section &<<SECTlogselector>>&.
14065
14066
14067 .option log_timezone main boolean false
14068 .cindex "log" "timezone for entries"
14069 .vindex "&$tod_log$&"
14070 .vindex "&$tod_zone$&"
14071 By default, the timestamps on log lines are in local time without the
14072 timezone. This means that if your timezone changes twice a year, the timestamps
14073 in log lines are ambiguous for an hour when the clocks go back. One way of
14074 avoiding this problem is to set the timezone to UTC. An alternative is to set
14075 &%log_timezone%& true. This turns on the addition of the timezone offset to
14076 timestamps in log lines. Turning on this option can add quite a lot to the size
14077 of log files because each line is extended by 6 characters. Note that the
14078 &$tod_log$& variable contains the log timestamp without the zone, but there is
14079 another variable called &$tod_zone$& that contains just the timezone offset.
14080
14081
14082 .option lookup_open_max main integer 25
14083 .cindex "too many open files"
14084 .cindex "open files, too many"
14085 .cindex "file" "too many open"
14086 .cindex "lookup" "maximum open files"
14087 .cindex "limit" "open files for lookups"
14088 This option limits the number of simultaneously open files for single-key
14089 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14090 Exim normally keeps these files open during routing, because often the same
14091 file is required several times. If the limit is reached, Exim closes the least
14092 recently used file. Note that if you are using the &'ndbm'& library, it
14093 actually opens two files for each logical DBM database, though it still counts
14094 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14095 open files"& errors with NDBM, you need to reduce the value of
14096 &%lookup_open_max%&.
14097
14098
14099 .option max_username_length main integer 0
14100 .cindex "length of login name"
14101 .cindex "user name" "maximum length"
14102 .cindex "limit" "user name length"
14103 Some operating systems are broken in that they truncate long arguments to
14104 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14105 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14106 an argument that is longer behaves as if &[getpwnam()]& failed.
14107
14108
14109 .option message_body_newlines main bool false
14110 .cindex "message body" "newlines in variables"
14111 .cindex "newline" "in message body variables"
14112 .vindex "&$message_body$&"
14113 .vindex "&$message_body_end$&"
14114 By default, newlines in the message body are replaced by spaces when setting
14115 the &$message_body$& and &$message_body_end$& expansion variables. If this
14116 option is set true, this no longer happens.
14117
14118
14119 .option message_body_visible main integer 500
14120 .cindex "body of message" "visible size"
14121 .cindex "message body" "visible size"
14122 .vindex "&$message_body$&"
14123 .vindex "&$message_body_end$&"
14124 This option specifies how much of a message's body is to be included in the
14125 &$message_body$& and &$message_body_end$& expansion variables.
14126
14127
14128 .option message_id_header_domain main string&!! unset
14129 .cindex "&'Message-ID:'& header line"
14130 If this option is set, the string is expanded and used as the right hand side
14131 (domain) of the &'Message-ID:'& header that Exim creates if a
14132 locally-originated incoming message does not have one. &"Locally-originated"&
14133 means &"not received over TCP/IP."&
14134 Otherwise, the primary host name is used.
14135 Only letters, digits, dot and hyphen are accepted; any other characters are
14136 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14137 empty string, the option is ignored.
14138
14139
14140 .option message_id_header_text main string&!! unset
14141 If this variable is set, the string is expanded and used to augment the text of
14142 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14143 message does not have one. The text of this header is required by RFC 2822 to
14144 take the form of an address. By default, Exim uses its internal message id as
14145 the local part, and the primary host name as the domain. If this option is set,
14146 it is expanded, and provided the expansion is not forced to fail, and does not
14147 yield an empty string, the result is inserted into the header immediately
14148 before the @, separated from the internal message id by a dot. Any characters
14149 that are illegal in an address are automatically converted into hyphens. This
14150 means that variables such as &$tod_log$& can be used, because the spaces and
14151 colons will become hyphens.
14152
14153
14154 .option message_logs main boolean true
14155 .cindex "message logs" "disabling"
14156 .cindex "log" "message log; disabling"
14157 If this option is turned off, per-message log files are not created in the
14158 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14159 Exim, by reducing the number of files involved in handling a message from a
14160 minimum of four (header spool file, body spool file, delivery journal, and
14161 per-message log) to three. The other major I/O activity is Exim's main log,
14162 which is not affected by this option.
14163
14164
14165 .option message_size_limit main string&!! 50M
14166 .cindex "message" "size limit"
14167 .cindex "limit" "message size"
14168 .cindex "size" "of message, limit"
14169 This option limits the maximum size of message that Exim will process. The
14170 value is expanded for each incoming connection so, for example, it can be made
14171 to depend on the IP address of the remote host for messages arriving via
14172 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14173 optionally followed by K or M.
14174
14175 &*Note*&: This limit cannot be made to depend on a message's sender or any
14176 other properties of an individual message, because it has to be advertised in
14177 the server's response to EHLO. String expansion failure causes a temporary
14178 error. A value of zero means no limit, but its use is not recommended. See also
14179 &%bounce_return_size_limit%&.
14180
14181 Incoming SMTP messages are failed with a 552 error if the limit is
14182 exceeded; locally-generated messages either get a stderr message or a delivery
14183 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14184 an oversized message is logged in both the main and the reject logs. See also
14185 the generic transport option &%message_size_limit%&, which limits the size of
14186 message that an individual transport can process.
14187
14188 If you use a virus-scanner and set this option to to a value larger than the
14189 maximum size that your virus-scanner is configured to support, you may get
14190 failures triggered by large mails.  The right size to configure for the
14191 virus-scanner depends upon what data is passed and the options in use but it's
14192 probably safest to just set it to a little larger than this value.  Eg, with a
14193 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14194 some problems may result.
14195
14196 A value of 0 will disable size limit checking; Exim will still advertise the
14197 SIZE extension in an EHLO response, but without a limit, so as to permit
14198 SMTP clients to still indicate the message size along with the MAIL verb.
14199
14200
14201 .option move_frozen_messages main boolean false
14202 .cindex "frozen messages" "moving"
14203 This option, which is available only if Exim has been built with the setting
14204 .code
14205 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14206 .endd
14207 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14208 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14209 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14210 standard utilities for handling such moved messages, and they do not show up in
14211 lists generated by &%-bp%& or by the Exim monitor.
14212
14213
14214 .option mua_wrapper main boolean false
14215 Setting this option true causes Exim to run in a very restrictive mode in which
14216 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14217 contains a full description of this facility.
14218
14219
14220
14221 .option mysql_servers main "string list" unset
14222 .cindex "MySQL" "server list"
14223 This option provides a list of MySQL servers and associated connection data, to
14224 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14225 option is available only if Exim has been built with MySQL support.
14226
14227
14228 .option never_users main "string list&!!" unset
14229 This option is expanded just once, at the start of Exim's processing. Local
14230 message deliveries are normally run in processes that are setuid to the
14231 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14232 It is usually desirable to prevent any deliveries from running as root, as a
14233 safety precaution.
14234
14235 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14236 list of users that must not be used for local deliveries. This list is fixed in
14237 the binary and cannot be overridden by the configuration file. By default, it
14238 contains just the single user name &"root"&. The &%never_users%& runtime option
14239 can be used to add more users to the fixed list.
14240
14241 If a message is to be delivered as one of the users on the fixed list or the
14242 &%never_users%& list, an error occurs, and delivery is deferred. A common
14243 example is
14244 .code
14245 never_users = root:daemon:bin
14246 .endd
14247 Including root is redundant if it is also on the fixed list, but it does no
14248 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14249 transport driver.
14250
14251
14252 .option openssl_options main "string list" +dont_insert_empty_fragments
14253 .cindex "OpenSSL "compatibility options"
14254 This option allows an administrator to adjust the SSL options applied
14255 by OpenSSL to connections.  It is given as a space-separated list of items,
14256 each one to be +added or -subtracted from the current value.  The default
14257 value is one option which happens to have been set historically.  You can
14258 remove all options with:
14259 .code
14260 openssl_options = -all
14261 .endd
14262 This option is only available if Exim is built against OpenSSL.  The values
14263 available for this option vary according to the age of your OpenSSL install.
14264 The &"all"& value controls a subset of flags which are available, typically
14265 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14266 list the values known on your system and Exim should support all the
14267 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14268 names lose the leading &"SSL_OP_"& and are lower-cased.
14269
14270 Note that adjusting the options can have severe impact upon the security of
14271 SSL as used by Exim.  It is possible to disable safety checks and shoot
14272 yourself in the foot in various unpleasant ways.  This option should not be
14273 adjusted lightly.  An unrecognised item will be detected at by invoking Exim
14274 with the &%-bV%& flag.
14275
14276 An example:
14277 .code
14278 openssl_options = -all +microsoft_big_sslv3_buffer
14279 .endd
14280
14281
14282 .option oracle_servers main "string list" unset
14283 .cindex "Oracle" "server list"
14284 This option provides a list of Oracle servers and associated connection data,
14285 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14286 The option is available only if Exim has been built with Oracle support.
14287
14288
14289 .option percent_hack_domains main "domain list&!!" unset
14290 .cindex "&""percent hack""&"
14291 .cindex "source routing" "in email address"
14292 .cindex "address" "source-routed"
14293 The &"percent hack"& is the convention whereby a local part containing a
14294 percent sign is re-interpreted as a new email address, with the percent
14295 replaced by @. This is sometimes called &"source routing"&, though that term is
14296 also applied to RFC 2822 addresses that begin with an @ character. If this
14297 option is set, Exim implements the percent facility for those domains listed,
14298 but no others. This happens before an incoming SMTP address is tested against
14299 an ACL.
14300
14301 &*Warning*&: The &"percent hack"& has often been abused by people who are
14302 trying to get round relaying restrictions. For this reason, it is best avoided
14303 if at all possible. Unfortunately, a number of less security-conscious MTAs
14304 implement it unconditionally. If you are running Exim on a gateway host, and
14305 routing mail through to internal MTAs without processing the local parts, it is
14306 a good idea to reject recipient addresses with percent characters in their
14307 local parts. Exim's default configuration does this.
14308
14309
14310 .option perl_at_start main boolean false
14311 This option is available only when Exim is built with an embedded Perl
14312 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14313
14314
14315 .option perl_startup main string unset
14316 This option is available only when Exim is built with an embedded Perl
14317 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14318
14319
14320 .option pgsql_servers main "string list" unset
14321 .cindex "PostgreSQL lookup type" "server list"
14322 This option provides a list of PostgreSQL servers and associated connection
14323 data, to be used in conjunction with &(pgsql)& lookups (see section
14324 &<<SECID72>>&). The option is available only if Exim has been built with
14325 PostgreSQL support.
14326
14327
14328 .option pid_file_path main string&!! "set at compile time"
14329 .cindex "daemon" "pid file path"
14330 .cindex "pid file, path for"
14331 This option sets the name of the file to which the Exim daemon writes its
14332 process id. The string is expanded, so it can contain, for example, references
14333 to the host name:
14334 .code
14335 pid_file_path = /var/log/$primary_hostname/exim.pid
14336 .endd
14337 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14338 spool directory.
14339 The value set by the option can be overridden by the &%-oP%& command line
14340 option. A pid file is not written if a &"non-standard"& daemon is run by means
14341 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14342
14343
14344 .option pipelining_advertise_hosts main "host list&!!" *
14345 .cindex "PIPELINING" "suppressing advertising"
14346 This option can be used to suppress the advertisement of the SMTP
14347 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14348 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14349 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14350 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14351 that clients will use it; &"out of order"& commands that are &"expected"& do
14352 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14353
14354
14355 .option preserve_message_logs main boolean false
14356 .cindex "message logs" "preserving"
14357 If this option is set, message log files are not deleted when messages are
14358 completed. Instead, they are moved to a sub-directory of the spool directory
14359 called &_msglog.OLD_&, where they remain available for statistical or debugging
14360 purposes. This is a dangerous option to set on systems with any appreciable
14361 volume of mail. Use with care!
14362
14363
14364 .option primary_hostname main string "see below"
14365 .cindex "name" "of local host"
14366 .cindex "host" "name of local"
14367 .cindex "local host" "name of"
14368 .vindex "&$primary_hostname$&"
14369 This specifies the name of the current host. It is used in the default EHLO or
14370 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14371 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14372 The value is also used by default in some SMTP response messages from an Exim
14373 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14374
14375 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14376 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14377 contains only one component, Exim passes it to &[gethostbyname()]& (or
14378 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14379 version. The variable &$primary_hostname$& contains the host name, whether set
14380 explicitly by this option, or defaulted.
14381
14382
14383 .option print_topbitchars main boolean false
14384 .cindex "printing characters"
14385 .cindex "8-bit characters"
14386 By default, Exim considers only those characters whose codes lie in the range
14387 32&--126 to be printing characters. In a number of circumstances (for example,
14388 when writing log entries) non-printing characters are converted into escape
14389 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14390 is set, code values of 128 and above are also considered to be printing
14391 characters.
14392
14393 This option also affects the header syntax checks performed by the
14394 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14395 the user's full name when constructing From: and Sender: addresses (as
14396 described in section &<<SECTconstr>>&). Setting this option can cause
14397 Exim to generate eight bit message headers that do not conform to the
14398 standards.
14399
14400
14401 .option process_log_path main string unset
14402 .cindex "process log path"
14403 .cindex "log" "process log"
14404 .cindex "&'exiwhat'&"
14405 This option sets the name of the file to which an Exim process writes its
14406 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14407 utility script. If this option is unset, the file called &_exim-process.info_&
14408 in Exim's spool directory is used. The ability to specify the name explicitly
14409 can be useful in environments where two different Exims are running, using
14410 different spool directories.
14411
14412
14413 .option prod_requires_admin main boolean true
14414 .oindex "&%-M%&"
14415 .oindex "&%-R%&"
14416 .oindex "&%-q%&"
14417 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14418 admin user unless &%prod_requires_admin%& is set false. See also
14419 &%queue_list_requires_admin%&.
14420
14421
14422 .option qualify_domain main string "see below"
14423 .cindex "domain" "for qualifying addresses"
14424 .cindex "address" "qualification"
14425 This option specifies the domain name that is added to any envelope sender
14426 addresses that do not have a domain qualification. It also applies to
14427 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14428 are accepted by default only for locally-generated messages. Qualification is
14429 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14430 locally-generated messages, unless the &%-bnq%& command line option is used.
14431
14432 Messages from external sources must always contain fully qualified addresses,
14433 unless the sending host matches &%sender_unqualified_hosts%& or
14434 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14435 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14436 necessary. Internally, Exim always works with fully qualified envelope
14437 addresses. If &%qualify_domain%& is not set, it defaults to the
14438 &%primary_hostname%& value.
14439
14440
14441 .option qualify_recipient main string "see below"
14442 This option allows you to specify a different domain for qualifying recipient
14443 addresses to the one that is used for senders. See &%qualify_domain%& above.
14444
14445
14446
14447 .option queue_domains main "domain list&!!" unset
14448 .cindex "domain" "specifying non-immediate delivery"
14449 .cindex "queueing incoming messages"
14450 .cindex "message" "queueing certain domains"
14451 This option lists domains for which immediate delivery is not required.
14452 A delivery process is started whenever a message is received, but only those
14453 domains that do not match are processed. All other deliveries wait until the
14454 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14455
14456
14457 .option queue_list_requires_admin main boolean true
14458 .oindex "&%-bp%&"
14459 The &%-bp%& command-line option, which lists the messages that are on the
14460 queue, requires the caller to be an admin user unless
14461 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14462
14463
14464 .option queue_only main boolean false
14465 .cindex "queueing incoming messages"
14466 .cindex "message" "queueing unconditionally"
14467 If &%queue_only%& is set, a delivery process is not automatically started
14468 whenever a message is received. Instead, the message waits on the queue for the
14469 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14470 delivered immediately when certain conditions (such as heavy load) occur.
14471
14472 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14473 and &%-odi%& command line options override &%queue_only%& unless
14474 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14475 &%queue_only_load%&, and &%smtp_accept_queue%&.
14476
14477
14478 .option queue_only_file main string unset
14479 .cindex "queueing incoming messages"
14480 .cindex "message" "queueing by file existence"
14481 This option can be set to a colon-separated list of absolute path names, each
14482 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14483 it tests for the existence of each listed path using a call to &[stat()]&. For
14484 each path that exists, the corresponding queueing option is set.
14485 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14486 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14487 .code
14488 queue_only_file = smtp/some/file
14489 .endd
14490 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14491 &_/some/file_& exists.
14492
14493
14494 .option queue_only_load main fixed-point unset
14495 .cindex "load average"
14496 .cindex "queueing incoming messages"
14497 .cindex "message" "queueing by load"
14498 If the system load average is higher than this value, incoming messages from
14499 all sources are queued, and no automatic deliveries are started. If this
14500 happens during local or remote SMTP input, all subsequent messages received on
14501 the same SMTP connection are queued by default, whatever happens to the load in
14502 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14503 false.
14504
14505 Deliveries will subsequently be performed by queue runner processes. This
14506 option has no effect on ancient operating systems on which Exim cannot
14507 determine the load average. See also &%deliver_queue_load_max%& and
14508 &%smtp_load_reserve%&.
14509
14510
14511 .option queue_only_load_latch main boolean true
14512 .cindex "load average" "re-evaluating per message"
14513 When this option is true (the default), once one message has been queued
14514 because the load average is higher than the value set by &%queue_only_load%&,
14515 all subsequent messages received on the same SMTP connection are also queued.
14516 This is a deliberate choice; even though the load average may fall below the
14517 threshold, it doesn't seem right to deliver later messages on the same
14518 connection when not delivering earlier ones. However, there are special
14519 circumstances such as very long-lived connections from scanning appliances
14520 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14521 should be set false. This causes the value of the load average to be
14522 re-evaluated for each message.
14523
14524
14525 .option queue_only_override main boolean true
14526 .cindex "queueing incoming messages"
14527 When this option is true, the &%-od%&&'x'& command line options override the
14528 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14529 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14530 to override; they are accepted, but ignored.
14531
14532
14533 .option queue_run_in_order main boolean false
14534 .cindex "queue runner" "processing messages in order"
14535 If this option is set, queue runs happen in order of message arrival instead of
14536 in an arbitrary order. For this to happen, a complete list of the entire queue
14537 must be set up before the deliveries start. When the queue is all held in a
14538 single directory (the default), a single list is created for both the ordered
14539 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14540 single list is not created when &%queue_run_in_order%& is false. In this case,
14541 the sub-directories are processed one at a time (in a random order), and this
14542 avoids setting up one huge list for the whole queue. Thus, setting
14543 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14544 when the queue is large, because of the extra work in setting up the single,
14545 large list. In most situations, &%queue_run_in_order%& should not be set.
14546
14547
14548
14549 .option queue_run_max main integer 5
14550 .cindex "queue runner" "maximum number of"
14551 This controls the maximum number of queue runner processes that an Exim daemon
14552 can run simultaneously. This does not mean that it starts them all at once,
14553 but rather that if the maximum number are still running when the time comes to
14554 start another one, it refrains from starting another one. This can happen with
14555 very large queues and/or very sluggish deliveries. This option does not,
14556 however, interlock with other processes, so additional queue runners can be
14557 started by other means, or by killing and restarting the daemon.
14558
14559 Setting this option to zero does not suppress queue runs; rather, it disables
14560 the limit, allowing any number of simultaneous queue runner processes to be
14561 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14562 the daemon's command line.
14563
14564 .option queue_smtp_domains main "domain list&!!" unset
14565 .cindex "queueing incoming messages"
14566 .cindex "message" "queueing remote deliveries"
14567 When this option is set, a delivery process is started whenever a message is
14568 received, routing is performed, and local deliveries take place.
14569 However, if any SMTP deliveries are required for domains that match
14570 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14571 message waits on the queue for the next queue run. Since routing of the message
14572 has taken place, Exim knows to which remote hosts it must be delivered, and so
14573 when the queue run happens, multiple messages for the same host are delivered
14574 over a single SMTP connection. The &%-odqs%& command line option causes all
14575 SMTP deliveries to be queued in this way, and is equivalent to setting
14576 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14577 &%queue_domains%&.
14578
14579
14580 .option receive_timeout main time 0s
14581 .cindex "timeout" "for non-SMTP input"
14582 This option sets the timeout for accepting a non-SMTP message, that is, the
14583 maximum time that Exim waits when reading a message on the standard input. If
14584 the value is zero, it will wait for ever. This setting is overridden by the
14585 &%-or%& command line option. The timeout for incoming SMTP messages is
14586 controlled by &%smtp_receive_timeout%&.
14587
14588 .option received_header_text main string&!! "see below"
14589 .cindex "customizing" "&'Received:'& header"
14590 .cindex "&'Received:'& header line" "customizing"
14591 This string defines the contents of the &'Received:'& message header that is
14592 added to each message, except for the timestamp, which is automatically added
14593 on at the end (preceded by a semicolon). The string is expanded each time it is
14594 used. If the expansion yields an empty string, no &'Received:'& header line is
14595 added to the message. Otherwise, the string should start with the text
14596 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14597 header lines. The default setting is:
14598
14599 .code
14600 received_header_text = Received: \
14601   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14602   {${if def:sender_ident \
14603   {from ${quote_local_part:$sender_ident} }}\
14604   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14605   by $primary_hostname \
14606   ${if def:received_protocol {with $received_protocol}} \
14607   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14608   (Exim $version_number)\n\t\
14609   ${if def:sender_address \
14610   {(envelope-from <$sender_address>)\n\t}}\
14611   id $message_exim_id\
14612   ${if def:received_for {\n\tfor $received_for}}
14613 .endd
14614
14615 The reference to the TLS cipher is omitted when Exim is built without TLS
14616 support. The use of conditional expansions ensures that this works for both
14617 locally generated messages and messages received from remote hosts, giving
14618 header lines such as the following:
14619 .code
14620 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14621 by marley.carol.example with esmtp (Exim 4.00)
14622 (envelope-from <bob@carol.example>)
14623 id 16IOWa-00019l-00
14624 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14625 Received: by scrooge.carol.example with local (Exim 4.00)
14626 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14627 .endd
14628 Until the body of the message has been received, the timestamp is the time when
14629 the message started to be received. Once the body has arrived, and all policy
14630 checks have taken place, the timestamp is updated to the time at which the
14631 message was accepted.
14632
14633
14634 .option received_headers_max main integer 30
14635 .cindex "loop" "prevention"
14636 .cindex "mail loop prevention"
14637 .cindex "&'Received:'& header line" "counting"
14638 When a message is to be delivered, the number of &'Received:'& headers is
14639 counted, and if it is greater than this parameter, a mail loop is assumed to
14640 have occurred, the delivery is abandoned, and an error message is generated.
14641 This applies to both local and remote deliveries.
14642
14643
14644 .option recipient_unqualified_hosts main "host list&!!" unset
14645 .cindex "unqualified addresses"
14646 .cindex "host" "unqualified addresses from"
14647 This option lists those hosts from which Exim is prepared to accept unqualified
14648 recipient addresses in message envelopes. The addresses are made fully
14649 qualified by the addition of the &%qualify_recipient%& value. This option also
14650 affects message header lines. Exim does not reject unqualified recipient
14651 addresses in headers, but it qualifies them only if the message came from a
14652 host that matches &%recipient_unqualified_hosts%&,
14653 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14654 option was not set.
14655
14656
14657 .option recipients_max main integer 0
14658 .cindex "limit" "number of recipients"
14659 .cindex "recipient" "maximum number"
14660 If this option is set greater than zero, it specifies the maximum number of
14661 original recipients for any message. Additional recipients that are generated
14662 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14663 all recipients over the limit; earlier recipients are delivered as normal.
14664 Non-SMTP messages with too many recipients are failed, and no deliveries are
14665 done.
14666
14667 .cindex "RCPT" "maximum number of incoming"
14668 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14669 RCPT commands in a single message.
14670
14671
14672 .option recipients_max_reject main boolean false
14673 If this option is set true, Exim rejects SMTP messages containing too many
14674 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14675 error to the eventual DATA command. Otherwise (the default) it gives a 452
14676 error to the surplus RCPT commands and accepts the message on behalf of the
14677 initial set of recipients. The remote server should then re-send the message
14678 for the remaining recipients at a later time.
14679
14680
14681 .option remote_max_parallel main integer 2
14682 .cindex "delivery" "parallelism for remote"
14683 This option controls parallel delivery of one message to a number of remote
14684 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14685 does all the remote deliveries for a message one by one. Otherwise, if a single
14686 message has to be delivered to more than one remote host, or if several copies
14687 have to be sent to the same remote host, up to &%remote_max_parallel%&
14688 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14689 deliveries are required, the maximum number of processes are started, and as
14690 each one finishes, another is begun. The order of starting processes is the
14691 same as if sequential delivery were being done, and can be controlled by the
14692 &%remote_sort_domains%& option. If parallel delivery takes place while running
14693 with debugging turned on, the debugging output from each delivery process is
14694 tagged with its process id.
14695
14696 This option controls only the maximum number of parallel deliveries for one
14697 message in one Exim delivery process. Because Exim has no central queue
14698 manager, there is no way of controlling the total number of simultaneous
14699 deliveries if the configuration allows a delivery attempt as soon as a message
14700 is received.
14701
14702 .cindex "number of deliveries"
14703 .cindex "delivery" "maximum number of"
14704 If you want to control the total number of deliveries on the system, you
14705 need to set the &%queue_only%& option. This ensures that all incoming messages
14706 are added to the queue without starting a delivery process. Then set up an Exim
14707 daemon to start queue runner processes at appropriate intervals (probably
14708 fairly often, for example, every minute), and limit the total number of queue
14709 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14710 delivers only one message at a time, the maximum number of deliveries that can
14711 then take place at once is &%queue_run_max%& multiplied by
14712 &%remote_max_parallel%&.
14713
14714 If it is purely remote deliveries you want to control, use
14715 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14716 doing the SMTP routing before queueing, so that several messages for the same
14717 host will eventually get delivered down the same connection.
14718
14719
14720 .option remote_sort_domains main "domain list&!!" unset
14721 .cindex "sorting remote deliveries"
14722 .cindex "delivery" "sorting remote"
14723 When there are a number of remote deliveries for a message, they are sorted by
14724 domain into the order given by this list. For example,
14725 .code
14726 remote_sort_domains = *.cam.ac.uk:*.uk
14727 .endd
14728 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14729 then to those in the &%uk%& domain, then to any others.
14730
14731
14732 .option retry_data_expire main time 7d
14733 .cindex "hints database" "data expiry"
14734 This option sets a &"use before"& time on retry information in Exim's hints
14735 database. Any older retry data is ignored. This means that, for example, once a
14736 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14737 past failures.
14738
14739
14740 .option retry_interval_max main time 24h
14741 .cindex "retry" "limit on interval"
14742 .cindex "limit" "on retry interval"
14743 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14744 intervals between delivery attempts for messages that cannot be delivered
14745 straight away. This option sets an overall limit to the length of time between
14746 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14747 the default value.
14748
14749
14750 .option return_path_remove main boolean true
14751 .cindex "&'Return-path:'& header line" "removing"
14752 RFC 2821, section 4.4, states that an SMTP server must insert a
14753 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14754 The &'Return-path:'& header preserves the sender address as received in the
14755 MAIL command. This description implies that this header should not be present
14756 in an incoming message. If &%return_path_remove%& is true, any existing
14757 &'Return-path:'& headers are removed from messages at the time they are
14758 received. Exim's transports have options for adding &'Return-path:'& headers at
14759 the time of delivery. They are normally used only for final local deliveries.
14760
14761
14762 .option return_size_limit main integer 100K
14763 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14764
14765
14766 .option rfc1413_hosts main "host list&!!" *
14767 .cindex "RFC 1413"
14768 .cindex "host" "for RFC 1413 calls"
14769 RFC 1413 identification calls are made to any client host which matches an item
14770 in the list.
14771
14772 .option rfc1413_query_timeout main time 5s
14773 .cindex "RFC 1413" "query timeout"
14774 .cindex "timeout" "for RFC 1413 call"
14775 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14776 no RFC 1413 calls are ever made.
14777
14778
14779 .option sender_unqualified_hosts main "host list&!!" unset
14780 .cindex "unqualified addresses"
14781 .cindex "host" "unqualified addresses from"
14782 This option lists those hosts from which Exim is prepared to accept unqualified
14783 sender addresses. The addresses are made fully qualified by the addition of
14784 &%qualify_domain%&. This option also affects message header lines. Exim does
14785 not reject unqualified addresses in headers that contain sender addresses, but
14786 it qualifies them only if the message came from a host that matches
14787 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14788 using TCP/IP), and the &%-bnq%& option was not set.
14789
14790
14791 .option smtp_accept_keepalive main boolean true
14792 .cindex "keepalive" "on incoming connection"
14793 This option controls the setting of the SO_KEEPALIVE option on incoming
14794 TCP/IP socket connections. When set, it causes the kernel to probe idle
14795 connections periodically, by sending packets with &"old"& sequence numbers. The
14796 other end of the connection should send an acknowledgment if the connection is
14797 still okay or a reset if the connection has been aborted. The reason for doing
14798 this is that it has the beneficial effect of freeing up certain types of
14799 connection that can get stuck when the remote host is disconnected without
14800 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14801 hours to detect unreachable hosts.
14802
14803
14804
14805 .option smtp_accept_max main integer 20
14806 .cindex "limit" "incoming SMTP connections"
14807 .cindex "SMTP" "incoming connection count"
14808 .cindex "inetd"
14809 This option specifies the maximum number of simultaneous incoming SMTP calls
14810 that Exim will accept. It applies only to the listening daemon; there is no
14811 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
14812 value is set to zero, no limit is applied. However, it is required to be
14813 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
14814 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
14815
14816 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
14817 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
14818 that limit has not been reached for the client host, &%smtp_accept_reserve%&
14819 and &%smtp_load_reserve%& are then checked before accepting the connection.
14820
14821
14822 .option smtp_accept_max_nonmail main integer 10
14823 .cindex "limit" "non-mail SMTP commands"
14824 .cindex "SMTP" "limiting non-mail commands"
14825 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
14826 the connection if there are too many. This option defines &"too many"&. The
14827 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
14828 client looping sending EHLO, for example. The check is applied only if the
14829 client host matches &%smtp_accept_max_nonmail_hosts%&.
14830
14831 When a new message is expected, one occurrence of RSET is not counted. This
14832 allows a client to send one RSET between messages (this is not necessary,
14833 but some clients do it). Exim also allows one uncounted occurrence of HELO
14834 or EHLO, and one occurrence of STARTTLS between messages. After
14835 starting up a TLS session, another EHLO is expected, and so it too is not
14836 counted. The first occurrence of AUTH in a connection, or immediately
14837 following STARTTLS is not counted. Otherwise, all commands other than
14838 MAIL, RCPT, DATA, and QUIT are counted.
14839
14840
14841 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
14842 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
14843 check by setting this option. The default value makes it apply to all hosts. By
14844 changing the value, you can exclude any badly-behaved hosts that you have to
14845 live with.
14846
14847
14848 . Allow this long option name to split; give it unsplit as a fifth argument
14849 . for the automatic .oindex that is generated by .option.
14850
14851 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
14852          smtp_accept_max_per_connection
14853 .cindex "SMTP" "limiting incoming message count"
14854 .cindex "limit" "messages per SMTP connection"
14855 The value of this option limits the number of MAIL commands that Exim is
14856 prepared to accept over a single SMTP connection, whether or not each command
14857 results in the transfer of a message. After the limit is reached, a 421
14858 response is given to subsequent MAIL commands. This limit is a safety
14859 precaution against a client that goes mad (incidents of this type have been
14860 seen).
14861
14862
14863 .option smtp_accept_max_per_host main string&!! unset
14864 .cindex "limit" "SMTP connections from one host"
14865 .cindex "host" "limiting SMTP connections from"
14866 This option restricts the number of simultaneous IP connections from a single
14867 host (strictly, from a single IP address) to the Exim daemon. The option is
14868 expanded, to enable different limits to be applied to different hosts by
14869 reference to &$sender_host_address$&. Once the limit is reached, additional
14870 connection attempts from the same host are rejected with error code 421. This
14871 is entirely independent of &%smtp_accept_reserve%&. The option's default value
14872 of zero imposes no limit. If this option is set greater than zero, it is
14873 required that &%smtp_accept_max%& be non-zero.
14874
14875 &*Warning*&: When setting this option you should not use any expansion
14876 constructions that take an appreciable amount of time. The expansion and test
14877 happen in the main daemon loop, in order to reject additional connections
14878 without forking additional processes (otherwise a denial-of-service attack
14879 could cause a vast number or processes to be created). While the daemon is
14880 doing this processing, it cannot accept any other incoming connections.
14881
14882
14883
14884 .option smtp_accept_queue main integer 0
14885 .cindex "SMTP" "incoming connection count"
14886 .cindex "queueing incoming messages"
14887 .cindex "message" "queueing by SMTP connection count"
14888 If the number of simultaneous incoming SMTP connections being handled via the
14889 listening daemon exceeds this value, messages received by SMTP are just placed
14890 on the queue; no delivery processes are started automatically. The count is
14891 fixed at the start of an SMTP connection. It cannot be updated in the
14892 subprocess that receives messages, and so the queueing or not queueing applies
14893 to all messages received in the same connection.
14894
14895 A value of zero implies no limit, and clearly any non-zero value is useful only
14896 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
14897 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
14898 various &%-od%&&'x'& command line options.
14899
14900
14901 . Allow this long option name to split; give it unsplit as a fifth argument
14902 . for the automatic .oindex that is generated by .option.
14903
14904 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
14905          smtp_accept_queue_per_connection
14906 .cindex "queueing incoming messages"
14907 .cindex "message" "queueing by message count"
14908 This option limits the number of delivery processes that Exim starts
14909 automatically when receiving messages via SMTP, whether via the daemon or by
14910 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
14911 and the number of messages received in a single SMTP session exceeds this
14912 number, subsequent messages are placed on the queue, but no delivery processes
14913 are started. This helps to limit the number of Exim processes when a server
14914 restarts after downtime and there is a lot of mail waiting for it on other
14915 systems. On large systems, the default should probably be increased, and on
14916 dial-in client systems it should probably be set to zero (that is, disabled).
14917
14918
14919 .option smtp_accept_reserve main integer 0
14920 .cindex "SMTP" "incoming call count"
14921 .cindex "host" "reserved"
14922 When &%smtp_accept_max%& is set greater than zero, this option specifies a
14923 number of SMTP connections that are reserved for connections from the hosts
14924 that are specified in &%smtp_reserve_hosts%&. The value set in
14925 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
14926 restricted to this number of connections; the option specifies a minimum number
14927 of connection slots for them, not a maximum. It is a guarantee that this group
14928 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
14929 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
14930 individual host.
14931
14932 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
14933 set to 5, once there are 45 active connections (from any hosts), new
14934 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
14935 provided the other criteria for acceptance are met.
14936
14937
14938 .option smtp_active_hostname main string&!! unset
14939 .cindex "host" "name in SMTP responses"
14940 .cindex "SMTP" "host name in responses"
14941 .vindex "&$primary_hostname$&"
14942 This option is provided for multi-homed servers that want to masquerade as
14943 several different hosts. At the start of an incoming SMTP connection, its value
14944 is expanded and used instead of the value of &$primary_hostname$& in SMTP
14945 responses. For example, it is used as domain name in the response to an
14946 incoming HELO or EHLO command.
14947
14948 .vindex "&$smtp_active_hostname$&"
14949 The active hostname is placed in the &$smtp_active_hostname$& variable, which
14950 is saved with any messages that are received. It is therefore available for use
14951 in routers and transports when the message is later delivered.
14952
14953 If this option is unset, or if its expansion is forced to fail, or if the
14954 expansion results in an empty string, the value of &$primary_hostname$& is
14955 used. Other expansion failures cause a message to be written to the main and
14956 panic logs, and the SMTP command receives a temporary error. Typically, the
14957 value of &%smtp_active_hostname%& depends on the incoming interface address.
14958 For example:
14959 .code
14960 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
14961   {cox.mydomain}{box.mydomain}}
14962 .endd
14963
14964 Although &$smtp_active_hostname$& is primarily concerned with incoming
14965 messages, it is also used as the default for HELO commands in callout
14966 verification if there is no remote transport from which to obtain a
14967 &%helo_data%& value.
14968
14969 .option smtp_banner main string&!! "see below"
14970 .cindex "SMTP" "welcome banner"
14971 .cindex "banner for SMTP"
14972 .cindex "welcome banner for SMTP"
14973 .cindex "customizing" "SMTP banner"
14974 This string, which is expanded every time it is used, is output as the initial
14975 positive response to an SMTP connection. The default setting is:
14976 .code
14977 smtp_banner = $smtp_active_hostname ESMTP Exim \
14978   $version_number $tod_full
14979 .endd
14980 Failure to expand the string causes a panic error. If you want to create a
14981 multiline response to the initial SMTP connection, use &"\n"& in the string at
14982 appropriate points, but not at the end. Note that the 220 code is not included
14983 in this string. Exim adds it automatically (several times in the case of a
14984 multiline response).
14985
14986
14987 .option smtp_check_spool_space main boolean true
14988 .cindex "checking disk space"
14989 .cindex "disk space, checking"
14990 .cindex "spool directory" "checking space"
14991 When this option is set, if an incoming SMTP session encounters the SIZE
14992 option on a MAIL command, it checks that there is enough space in the
14993 spool directory's partition to accept a message of that size, while still
14994 leaving free the amount specified by &%check_spool_space%& (even if that value
14995 is zero). If there isn't enough space, a temporary error code is returned.
14996
14997
14998 .option smtp_connect_backlog main integer 20
14999 .cindex "connection backlog"
15000 .cindex "SMTP" "connection backlog"
15001 .cindex "backlog of connections"
15002 This option specifies a maximum number of waiting SMTP connections. Exim passes
15003 this value to the TCP/IP system when it sets up its listener. Once this number
15004 of connections are waiting for the daemon's attention, subsequent connection
15005 attempts are refused at the TCP/IP level. At least, that is what the manuals
15006 say; in some circumstances such connection attempts have been observed to time
15007 out instead. For large systems it is probably a good idea to increase the
15008 value (to 50, say). It also gives some protection against denial-of-service
15009 attacks by SYN flooding.
15010
15011
15012 .option smtp_enforce_sync main boolean true
15013 .cindex "SMTP" "synchronization checking"
15014 .cindex "synchronization checking in SMTP"
15015 The SMTP protocol specification requires the client to wait for a response from
15016 the server at certain points in the dialogue. Without PIPELINING these
15017 synchronization points are after every command; with PIPELINING they are
15018 fewer, but they still exist.
15019
15020 Some spamming sites send out a complete set of SMTP commands without waiting
15021 for any response. Exim protects against this by rejecting a message if the
15022 client has sent further input when it should not have. The error response &"554
15023 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15024 for this error cannot be perfect because of transmission delays (unexpected
15025 input may be on its way but not yet received when Exim checks). However, it
15026 does detect many instances.
15027
15028 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15029 If you want to disable the check selectively (for example, only for certain
15030 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15031 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15032
15033
15034
15035 .option smtp_etrn_command main string&!! unset
15036 .cindex "ETRN" "command to be run"
15037 .vindex "&$domain$&"
15038 If this option is set, the given command is run whenever an SMTP ETRN
15039 command is received from a host that is permitted to issue such commands (see
15040 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15041 are independently expanded. The expansion variable &$domain$& is set to the
15042 argument of the ETRN command, and no syntax checking is done on it. For
15043 example:
15044 .code
15045 smtp_etrn_command = /etc/etrn_command $domain \
15046                     $sender_host_address
15047 .endd
15048 A new process is created to run the command, but Exim does not wait for it to
15049 complete. Consequently, its status cannot be checked. If the command cannot be
15050 run, a line is written to the panic log, but the ETRN caller still receives
15051 a 250 success response. Exim is normally running under its own uid when
15052 receiving SMTP, so it is not possible for it to change the uid before running
15053 the command.
15054
15055
15056 .option smtp_etrn_serialize main boolean true
15057 .cindex "ETRN" "serializing"
15058 When this option is set, it prevents the simultaneous execution of more than
15059 one identical command as a result of ETRN in an SMTP connection. See
15060 section &<<SECTETRN>>& for details.
15061
15062
15063 .option smtp_load_reserve main fixed-point unset
15064 .cindex "load average"
15065 If the system load average ever gets higher than this, incoming SMTP calls are
15066 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15067 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15068 the load is over the limit. The option has no effect on ancient operating
15069 systems on which Exim cannot determine the load average. See also
15070 &%deliver_queue_load_max%& and &%queue_only_load%&.
15071
15072
15073
15074 .option smtp_max_synprot_errors main integer 3
15075 .cindex "SMTP" "limiting syntax and protocol errors"
15076 .cindex "limit" "SMTP syntax and protocol errors"
15077 Exim rejects SMTP commands that contain syntax or protocol errors. In
15078 particular, a syntactically invalid email address, as in this command:
15079 .code
15080 RCPT TO:<abc xyz@a.b.c>
15081 .endd
15082 causes immediate rejection of the command, before any other tests are done.
15083 (The ACL cannot be run if there is no valid address to set up for it.) An
15084 example of a protocol error is receiving RCPT before MAIL. If there are
15085 too many syntax or protocol errors in one SMTP session, the connection is
15086 dropped. The limit is set by this option.
15087
15088 .cindex "PIPELINING" "expected errors"
15089 When the PIPELINING extension to SMTP is in use, some protocol errors are
15090 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15091 Exim assumes that PIPELINING will be used if it advertises it (see
15092 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15093 not count towards the limit.
15094
15095
15096
15097 .option smtp_max_unknown_commands main integer 3
15098 .cindex "SMTP" "limiting unknown commands"
15099 .cindex "limit" "unknown SMTP commands"
15100 If there are too many unrecognized commands in an incoming SMTP session, an
15101 Exim server drops the connection. This is a defence against some kinds of abuse
15102 that subvert web
15103 clients
15104 into making connections to SMTP ports; in these circumstances, a number of
15105 non-SMTP command lines are sent first.
15106
15107
15108
15109 .option smtp_ratelimit_hosts main "host list&!!" unset
15110 .cindex "SMTP" "rate limiting"
15111 .cindex "limit" "rate of message arrival"
15112 .cindex "RCPT" "rate limiting"
15113 Some sites find it helpful to be able to limit the rate at which certain hosts
15114 can send them messages, and the rate at which an individual message can specify
15115 recipients.
15116
15117 Exim has two rate-limiting facilities. This section describes the older
15118 facility, which can limit rates within a single connection. The newer
15119 &%ratelimit%& ACL condition can limit rates across all connections. See section
15120 &<<SECTratelimiting>>& for details of the newer facility.
15121
15122 When a host matches &%smtp_ratelimit_hosts%&, the values of
15123 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15124 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15125 respectively. Each option, if set, must contain a set of four comma-separated
15126 values:
15127
15128 .ilist
15129 A threshold, before which there is no rate limiting.
15130 .next
15131 An initial time delay. Unlike other times in Exim, numbers with decimal
15132 fractional parts are allowed here.
15133 .next
15134 A factor by which to increase the delay each time.
15135 .next
15136 A maximum value for the delay. This should normally be less than 5 minutes,
15137 because after that time, the client is liable to timeout the SMTP command.
15138 .endlist
15139
15140 For example, these settings have been used successfully at the site which
15141 first suggested this feature, for controlling mail from their customers:
15142 .code
15143 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15144 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15145 .endd
15146 The first setting specifies delays that are applied to MAIL commands after
15147 two have been received over a single connection. The initial delay is 0.5
15148 seconds, increasing by a factor of 1.05 each time. The second setting applies
15149 delays to RCPT commands when more than four occur in a single message.
15150
15151
15152 .option smtp_ratelimit_mail main string unset
15153 See &%smtp_ratelimit_hosts%& above.
15154
15155
15156 .option smtp_ratelimit_rcpt main string unset
15157 See &%smtp_ratelimit_hosts%& above.
15158
15159
15160 .option smtp_receive_timeout main time 5m
15161 .cindex "timeout" "for SMTP input"
15162 .cindex "SMTP" "input timeout"
15163 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15164 input, including batch SMTP. If a line of input (either an SMTP command or a
15165 data line) is not received within this time, the SMTP connection is dropped and
15166 the message is abandoned.
15167 A line is written to the log containing one of the following messages:
15168 .code
15169 SMTP command timeout on connection from...
15170 SMTP data timeout on connection from...
15171 .endd
15172 The former means that Exim was expecting to read an SMTP command; the latter
15173 means that it was in the DATA phase, reading the contents of a message.
15174
15175
15176 .oindex "&%-os%&"
15177 The value set by this option can be overridden by the
15178 &%-os%& command-line option. A setting of zero time disables the timeout, but
15179 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15180 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15181 timeout is controlled by &%receive_timeout%& and &%-or%&.
15182
15183
15184 .option smtp_reserve_hosts main "host list&!!" unset
15185 This option defines hosts for which SMTP connections are reserved; see
15186 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15187
15188
15189 .option smtp_return_error_details main boolean false
15190 .cindex "SMTP" "details policy failures"
15191 .cindex "policy control" "rejection, returning details"
15192 In the default state, Exim uses bland messages such as
15193 &"Administrative prohibition"& when it rejects SMTP commands for policy
15194 reasons. Many sysadmins like this because it gives away little information
15195 to spammers. However, some other sysadmins who are applying strict checking
15196 policies want to give out much fuller information about failures. Setting
15197 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15198 example, instead of &"Administrative prohibition"&, it might give:
15199 .code
15200 550-Rejected after DATA: '>' missing at end of address:
15201 550 failing address in "From" header is: <user@dom.ain
15202 .endd
15203
15204 .option spamd_address main string "see below"
15205 This option is available when Exim is compiled with the content-scanning
15206 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15207 The default value is
15208 .code
15209 127.0.0.1 783
15210 .endd
15211 See section &<<SECTscanspamass>>& for more details.
15212
15213
15214
15215 .option split_spool_directory main boolean false
15216 .cindex "multiple spool directories"
15217 .cindex "spool directory" "split"
15218 .cindex "directories, multiple"
15219 If this option is set, it causes Exim to split its input directory into 62
15220 subdirectories, each with a single alphanumeric character as its name. The
15221 sixth character of the message id is used to allocate messages to
15222 subdirectories; this is the least significant base-62 digit of the time of
15223 arrival of the message.
15224
15225 Splitting up the spool in this way may provide better performance on systems
15226 where there are long mail queues, by reducing the number of files in any one
15227 directory. The msglog directory is also split up in a similar way to the input
15228 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15229 are still placed in the single directory &_msglog.OLD_&.
15230
15231 It is not necessary to take any special action for existing messages when
15232 changing &%split_spool_directory%&. Exim notices messages that are in the
15233 &"wrong"& place, and continues to process them. If the option is turned off
15234 after a period of being on, the subdirectories will eventually empty and be
15235 automatically deleted.
15236
15237 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15238 changes. Instead of creating a list of all messages in the queue, and then
15239 trying to deliver each one in turn, it constructs a list of those in one
15240 sub-directory and tries to deliver them, before moving on to the next
15241 sub-directory. The sub-directories are processed in a random order. This
15242 spreads out the scanning of the input directories, and uses less memory. It is
15243 particularly beneficial when there are lots of messages on the queue. However,
15244 if &%queue_run_in_order%& is set, none of this new processing happens. The
15245 entire queue has to be scanned and sorted before any deliveries can start.
15246
15247
15248 .option spool_directory main string&!! "set at compile time"
15249 .cindex "spool directory" "path to"
15250 This defines the directory in which Exim keeps its spool, that is, the messages
15251 it is waiting to deliver. The default value is taken from the compile-time
15252 configuration setting, if there is one. If not, this option must be set. The
15253 string is expanded, so it can contain, for example, a reference to
15254 &$primary_hostname$&.
15255
15256 If the spool directory name is fixed on your installation, it is recommended
15257 that you set it at build time rather than from this option, particularly if the
15258 log files are being written to the spool directory (see &%log_file_path%&).
15259 Otherwise log files cannot be used for errors that are detected early on, such
15260 as failures in the configuration file.
15261
15262 By using this option to override the compiled-in path, it is possible to run
15263 tests of Exim without using the standard spool.
15264
15265 .option sqlite_lock_timeout main time 5s
15266 .cindex "sqlite lookup type" "lock timeout"
15267 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15268 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15269
15270 .option strict_acl_vars main boolean false
15271 .cindex "&ACL;" "variables, handling unset"
15272 This option controls what happens if a syntactically valid but undefined ACL
15273 variable is referenced. If it is false (the default), an empty string
15274 is substituted; if it is true, an error is generated. See section
15275 &<<SECTaclvariables>>& for details of ACL variables.
15276
15277 .option strip_excess_angle_brackets main boolean false
15278 .cindex "angle brackets, excess"
15279 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15280 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15281 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15282 passed on to another MTA, the excess angle brackets are not passed on. If this
15283 option is not set, multiple pairs of angle brackets cause a syntax error.
15284
15285
15286 .option strip_trailing_dot main boolean false
15287 .cindex "trailing dot on domain"
15288 .cindex "dot" "trailing on domain"
15289 If this option is set, a trailing dot at the end of a domain in an address is
15290 ignored. If this is in the envelope and the message is passed on to another
15291 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15292 domain causes a syntax error.
15293 However, addresses in header lines are checked only when an ACL requests header
15294 syntax checking.
15295
15296
15297 .option syslog_duplication main boolean true
15298 .cindex "syslog" "duplicate log lines; suppressing"
15299 When Exim is logging to syslog, it writes the log lines for its three
15300 separate logs at different syslog priorities so that they can in principle
15301 be separated on the logging hosts. Some installations do not require this
15302 separation, and in those cases, the duplication of certain log lines is a
15303 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15304 particular log line is written to syslog. For lines that normally go to
15305 both the main log and the reject log, the reject log version (possibly
15306 containing message header lines) is written, at LOG_NOTICE priority.
15307 Lines that normally go to both the main and the panic log are written at
15308 the LOG_ALERT priority.
15309
15310
15311 .option syslog_facility main string unset
15312 .cindex "syslog" "facility; setting"
15313 This option sets the syslog &"facility"& name, used when Exim is logging to
15314 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15315 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15316 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15317 details of Exim's logging.
15318
15319
15320
15321 .option syslog_processname main string &`exim`&
15322 .cindex "syslog" "process name; setting"
15323 This option sets the syslog &"ident"& name, used when Exim is logging to
15324 syslog. The value must be no longer than 32 characters. See chapter
15325 &<<CHAPlog>>& for details of Exim's logging.
15326
15327
15328
15329 .option syslog_timestamp main boolean true
15330 .cindex "syslog" "timestamps"
15331 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15332 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15333 details of Exim's logging.
15334
15335
15336 .option system_filter main string&!! unset
15337 .cindex "filter" "system filter"
15338 .cindex "system filter" "specifying"
15339 .cindex "Sieve filter" "not available for system filter"
15340 This option specifies an Exim filter file that is applied to all messages at
15341 the start of each delivery attempt, before any routing is done. System filters
15342 must be Exim filters; they cannot be Sieve filters. If the system filter
15343 generates any deliveries to files or pipes, or any new mail messages, the
15344 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15345 which transports are to be used. Details of this facility are given in chapter
15346 &<<CHAPsystemfilter>>&.
15347
15348
15349 .option system_filter_directory_transport main string&!! unset
15350 .vindex "&$address_file$&"
15351 This sets the name of the transport driver that is to be used when the
15352 &%save%& command in a system message filter specifies a path ending in &"/"&,
15353 implying delivery of each message into a separate file in some directory.
15354 During the delivery, the variable &$address_file$& contains the path name.
15355
15356
15357 .option system_filter_file_transport main string&!! unset
15358 .cindex "file" "transport for system filter"
15359 This sets the name of the transport driver that is to be used when the &%save%&
15360 command in a system message filter specifies a path not ending in &"/"&. During
15361 the delivery, the variable &$address_file$& contains the path name.
15362
15363 .option system_filter_group main string unset
15364 .cindex "gid (group id)" "system filter"
15365 This option is used only when &%system_filter_user%& is also set. It sets the
15366 gid under which the system filter is run, overriding any gid that is associated
15367 with the user. The value may be numerical or symbolic.
15368
15369 .option system_filter_pipe_transport main string&!! unset
15370 .cindex "&(pipe)& transport" "for system filter"
15371 .vindex "&$address_pipe$&"
15372 This specifies the transport driver that is to be used when a &%pipe%& command
15373 is used in a system filter. During the delivery, the variable &$address_pipe$&
15374 contains the pipe command.
15375
15376
15377 .option system_filter_reply_transport main string&!! unset
15378 .cindex "&(autoreply)& transport" "for system filter"
15379 This specifies the transport driver that is to be used when a &%mail%& command
15380 is used in a system filter.
15381
15382
15383 .option system_filter_user main string unset
15384 .cindex "uid (user id)" "system filter"
15385 If this option is set to root, the system filter is run in the main Exim
15386 delivery process, as root.  Otherwise, the system filter runs in a separate
15387 process, as the given user, defaulting to the Exim run-time user.
15388 Unless the string consists entirely of digits, it
15389 is looked up in the password data. Failure to find the named user causes a
15390 configuration error. The gid is either taken from the password data, or
15391 specified by &%system_filter_group%&. When the uid is specified numerically,
15392 &%system_filter_group%& is required to be set.
15393
15394 If the system filter generates any pipe, file, or reply deliveries, the uid
15395 under which the filter is run is used when transporting them, unless a
15396 transport option overrides.
15397
15398
15399 .option tcp_nodelay main boolean true
15400 .cindex "daemon" "TCP_NODELAY on sockets"
15401 .cindex "Nagle algorithm"
15402 .cindex "TCP_NODELAY on listening sockets"
15403 If this option is set false, it stops the Exim daemon setting the
15404 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15405 turns off the &"Nagle algorithm"&, which is a way of improving network
15406 performance in interactive (character-by-character) situations. Turning it off
15407 should improve Exim's performance a bit, so that is what happens by default.
15408 However, it appears that some broken clients cannot cope, and time out. Hence
15409 this option. It affects only those sockets that are set up for listening by the
15410 daemon. Sockets created by the smtp transport for delivering mail always set
15411 TCP_NODELAY.
15412
15413
15414 .option timeout_frozen_after main time 0s
15415 .cindex "frozen messages" "timing out"
15416 .cindex "timeout" "frozen messages"
15417 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15418 message of any kind that has been on the queue for longer than the given time
15419 is automatically cancelled at the next queue run. If the frozen message is a
15420 bounce message, it is just discarded; otherwise, a bounce is sent to the
15421 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15422 If you want to timeout frozen bounce messages earlier than other kinds of
15423 frozen message, see &%ignore_bounce_errors_after%&.
15424
15425 &*Note:*& the default value of zero means no timeouts; with this setting,
15426 frozen messages remain on the queue forever (except for any frozen bounce
15427 messages that are released by &%ignore_bounce_errors_after%&).
15428
15429
15430 .option timezone main string unset
15431 .cindex "timezone, setting"
15432 The value of &%timezone%& is used to set the environment variable TZ while
15433 running Exim (if it is different on entry). This ensures that all timestamps
15434 created by Exim are in the required timezone. If you want all your timestamps
15435 to be in UTC (aka GMT) you should set
15436 .code
15437 timezone = UTC
15438 .endd
15439 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15440 or, if that is not set, from the value of the TZ environment variable when Exim
15441 is built. If &%timezone%& is set to the empty string, either at build or run
15442 time, any existing TZ variable is removed from the environment when Exim
15443 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15444 unfortunately not all, operating systems.
15445
15446
15447 .option tls_advertise_hosts main "host list&!!" unset
15448 .cindex "TLS" "advertising"
15449 .cindex "encryption" "on SMTP connection"
15450 .cindex "SMTP" "encrypted connection"
15451 When Exim is built with support for TLS encrypted connections, the availability
15452 of the STARTTLS command to set up an encrypted session is advertised in
15453 response to EHLO only to those client hosts that match this option. See
15454 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15455
15456
15457 .option tls_certificate main string&!! unset
15458 .cindex "TLS" "server certificate; location of"
15459 .cindex "certificate" "server, location of"
15460 The value of this option is expanded, and must then be the absolute path to a
15461 file which contains the server's certificates. The server's private key is also
15462 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15463 &<<CHAPTLS>>& for further details.
15464
15465 &*Note*&: The certificates defined by this option are used only when Exim is
15466 receiving incoming messages as a server. If you want to supply certificates for
15467 use when sending messages as a client, you must set the &%tls_certificate%&
15468 option in the relevant &(smtp)& transport.
15469
15470
15471 .option tls_crl main string&!! unset
15472 .cindex "TLS" "server certificate revocation list"
15473 .cindex "certificate" "revocation list for server"
15474 This option specifies a certificate revocation list. The expanded value must
15475 be the name of a file that contains a CRL in PEM format.
15476
15477
15478 .option tls_dhparam main string&!! unset
15479 .cindex "TLS" "D-H parameters for server"
15480 The value of this option is expanded, and must then be the absolute path to
15481 a file which contains the server's DH parameter values.
15482 This is used only for OpenSSL. When Exim is linked with GnuTLS, this option is
15483 ignored. See section &<<SECTopenvsgnu>>& for further details.
15484
15485
15486 .option tls_on_connect_ports main "string list" unset
15487 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15488 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15489 set up without waiting for the client to issue a STARTTLS command. For
15490 further details, see section &<<SECTsupobssmt>>&.
15491
15492
15493
15494 .option tls_privatekey main string&!! unset
15495 .cindex "TLS" "server private key; location of"
15496 The value of this option is expanded, and must then be the absolute path to a
15497 file which contains the server's private key. If this option is unset, or if
15498 the expansion is forced to fail, or the result is an empty string, the private
15499 key is assumed to be in the same file as the server's certificates. See chapter
15500 &<<CHAPTLS>>& for further details.
15501
15502
15503 .option tls_remember_esmtp main boolean false
15504 .cindex "TLS" "esmtp state; remembering"
15505 .cindex "TLS" "broken clients"
15506 If this option is set true, Exim violates the RFCs by remembering that it is in
15507 &"esmtp"& state after successfully negotiating a TLS session. This provides
15508 support for broken clients that fail to send a new EHLO after starting a
15509 TLS session.
15510
15511
15512 .option tls_require_ciphers main string&!! unset
15513 .cindex "TLS" "requiring specific ciphers"
15514 .cindex "cipher" "requiring specific"
15515 This option controls which ciphers can be used for incoming TLS connections.
15516 The &(smtp)& transport has an option of the same name for controlling outgoing
15517 connections. This option is expanded for each connection, so can be varied for
15518 different clients if required. The value of this option must be a list of
15519 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15520 in somewhat different ways. If GnuTLS is being used, the client controls the
15521 preference order of the available ciphers. Details are given in sections
15522 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15523
15524
15525 .option tls_try_verify_hosts main "host list&!!" unset
15526 .cindex "TLS" "client certificate verification"
15527 .cindex "certificate" "verification of client"
15528 See &%tls_verify_hosts%& below.
15529
15530
15531 .option tls_verify_certificates main string&!! unset
15532 .cindex "TLS" "client certificate verification"
15533 .cindex "certificate" "verification of client"
15534 The value of this option is expanded, and must then be the absolute path to
15535 a file containing permitted certificates for clients that
15536 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15537 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15538 directory containing certificate files. This does not work with GnuTLS; the
15539 option must be set to the name of a single file if you are using GnuTLS.
15540
15541 These certificates should be for the certificate authorities trusted, rather
15542 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
15543 the value is a file then the certificates are sent by Exim as a server to
15544 connecting clients, defining the list of accepted certificate authorities.
15545 Thus the values defined should be considered public data.  To avoid this,
15546 use OpenSSL with a directory.
15547
15548
15549 .option tls_verify_hosts main "host list&!!" unset
15550 .cindex "TLS" "client certificate verification"
15551 .cindex "certificate" "verification of client"
15552 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15553 certificates from clients. The expected certificates are defined by
15554 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15555 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15556 &%tls_verify_certificates%& is not set.
15557
15558 Any client that matches &%tls_verify_hosts%& is constrained by
15559 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15560 present one of the listed certificates. If it does not, the connection is
15561 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15562 the host to use TLS. It can still send SMTP commands through unencrypted
15563 connections. Forcing a client to use TLS has to be done separately using an
15564 ACL to reject inappropriate commands when the connection is not encrypted.
15565
15566 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15567 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15568 certificate and checks it against &%tls_verify_certificates%&, but does not
15569 abort the connection if there is no certificate or if it does not match. This
15570 state can be detected in an ACL, which makes it possible to implement policies
15571 such as &"accept for relay only if a verified certificate has been received,
15572 but accept for local delivery if encrypted, even without a verified
15573 certificate"&.
15574
15575 Client hosts that match neither of these lists are not asked to present
15576 certificates.
15577
15578
15579 .option trusted_groups main "string list&!!" unset
15580 .cindex "trusted groups"
15581 .cindex "groups" "trusted"
15582 This option is expanded just once, at the start of Exim's processing. If this
15583 option is set, any process that is running in one of the listed groups, or
15584 which has one of them as a supplementary group, is trusted. The groups can be
15585 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15586 details of what trusted callers are permitted to do. If neither
15587 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15588 are trusted.
15589
15590 .option trusted_users main "string list&!!" unset
15591 .cindex "trusted users"
15592 .cindex "user" "trusted"
15593 This option is expanded just once, at the start of Exim's processing. If this
15594 option is set, any process that is running as one of the listed users is
15595 trusted. The users can be specified numerically or by name. See section
15596 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15597 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15598 Exim user are trusted.
15599
15600 .option unknown_login main string&!! unset
15601 .cindex "uid (user id)" "unknown caller"
15602 .vindex "&$caller_uid$&"
15603 This is a specialized feature for use in unusual configurations. By default, if
15604 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15605 gives up. The &%unknown_login%& option can be used to set a login name to be
15606 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15607 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15608 is used for the user's real name (gecos field), unless this has been set by the
15609 &%-F%& option.
15610
15611 .option unknown_username main string unset
15612 See &%unknown_login%&.
15613
15614 .option untrusted_set_sender main "address list&!!" unset
15615 .cindex "trusted users"
15616 .cindex "sender" "setting by untrusted user"
15617 .cindex "untrusted user setting sender"
15618 .cindex "user" "untrusted setting sender"
15619 .cindex "envelope sender"
15620 When an untrusted user submits a message to Exim using the standard input, Exim
15621 normally creates an envelope sender address from the user's login and the
15622 default qualification domain. Data from the &%-f%& option (for setting envelope
15623 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15624 is used) is ignored.
15625
15626 However, untrusted users are permitted to set an empty envelope sender address,
15627 to declare that a message should never generate any bounces. For example:
15628 .code
15629 exim -f '<>' user@domain.example
15630 .endd
15631 .vindex "&$sender_ident$&"
15632 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15633 other envelope sender addresses in a controlled way. When it is set, untrusted
15634 users are allowed to set envelope sender addresses that match any of the
15635 patterns in the list. Like all address lists, the string is expanded. The
15636 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15637 users to setting senders that start with their login ids
15638 followed by a hyphen
15639 by a setting like this:
15640 .code
15641 untrusted_set_sender = ^$sender_ident-
15642 .endd
15643 If you want to allow untrusted users to set envelope sender addresses without
15644 restriction, you can use
15645 .code
15646 untrusted_set_sender = *
15647 .endd
15648 The &%untrusted_set_sender%& option applies to all forms of local input, but
15649 only to the setting of the envelope sender. It does not permit untrusted users
15650 to use the other options which trusted user can use to override message
15651 parameters. Furthermore, it does not stop Exim from removing an existing
15652 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15653 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15654 overriding these actions. The handling of the &'Sender:'& header is also
15655 described in section &<<SECTthesenhea>>&.
15656
15657 The log line for a message's arrival shows the envelope sender following
15658 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15659 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15660 envelope sender address, the user's login is shown in parentheses after the
15661 sender address.
15662
15663
15664 .option uucp_from_pattern main string "see below"
15665 .cindex "&""From""& line"
15666 .cindex "UUCP" "&""From""& line"
15667 Some applications that pass messages to an MTA via a command line interface use
15668 an initial line starting with &"From&~"& to pass the envelope sender. In
15669 particular, this is used by UUCP software. Exim recognizes such a line by means
15670 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15671 matches, the sender address is constructed by expanding the contents of
15672 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15673 default pattern recognizes lines in the following two forms:
15674 .code
15675 From ph10 Fri Jan  5 12:35 GMT 1996
15676 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15677 .endd
15678 The pattern can be seen by running
15679 .code
15680 exim -bP uucp_from_pattern
15681 .endd
15682 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15683 year in the second case. The first word after &"From&~"& is matched in the
15684 regular expression by a parenthesized subpattern. The default value for
15685 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15686 (&"ph10"& in the example above) as the message's sender. See also
15687 &%ignore_fromline_hosts%&.
15688
15689
15690 .option uucp_from_sender main string&!! &`$1`&
15691 See &%uucp_from_pattern%& above.
15692
15693
15694 .option warn_message_file main string unset
15695 .cindex "warning of delay" "customizing the message"
15696 .cindex "customizing" "warning message"
15697 This option defines a template file containing paragraphs of text to be used
15698 for constructing the warning message which is sent by Exim when a message has
15699 been on the queue for a specified amount of time, as specified by
15700 &%delay_warning%&. Details of the file's contents are given in chapter
15701 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15702
15703
15704 .option write_rejectlog main boolean true
15705 .cindex "reject log" "disabling"
15706 If this option is set false, Exim no longer writes anything to the reject log.
15707 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15708 .ecindex IIDconfima
15709 .ecindex IIDmaiconf
15710
15711
15712
15713
15714 . ////////////////////////////////////////////////////////////////////////////
15715 . ////////////////////////////////////////////////////////////////////////////
15716
15717 .chapter "Generic options for routers" "CHAProutergeneric"
15718 .scindex IIDgenoprou1 "options" "generic; for routers"
15719 .scindex IIDgenoprou2 "generic options" "router"
15720 This chapter describes the generic options that apply to all routers.
15721 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15722
15723 For a general description of how a router operates, see sections
15724 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15725 which the preconditions are tested. The order of expansion of the options that
15726 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15727 &%headers_remove%&, &%transport%&.
15728
15729
15730
15731 .option address_data routers string&!! unset
15732 .cindex "router" "data attached to address"
15733 The string is expanded just before the router is run, that is, after all the
15734 precondition tests have succeeded. If the expansion is forced to fail, the
15735 router declines, the value of &%address_data%& remains unchanged, and the
15736 &%more%& option controls what happens next. Other expansion failures cause
15737 delivery of the address to be deferred.
15738
15739 .vindex "&$address_data$&"
15740 When the expansion succeeds, the value is retained with the address, and can be
15741 accessed using the variable &$address_data$& in the current router, subsequent
15742 routers, and the eventual transport.
15743
15744 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15745 that runs a user's filter file, the contents of &$address_data$& are accessible
15746 in the filter. This is not normally a problem, because such data is usually
15747 either not confidential or it &"belongs"& to the current user, but if you do
15748 put confidential data into &$address_data$& you need to remember this point.
15749
15750 Even if the router declines or passes, the value of &$address_data$& remains
15751 with the address, though it can be changed by another &%address_data%& setting
15752 on a subsequent router. If a router generates child addresses, the value of
15753 &$address_data$& propagates to them. This also applies to the special kind of
15754 &"child"& that is generated by a router with the &%unseen%& option.
15755
15756 The idea of &%address_data%& is that you can use it to look up a lot of data
15757 for the address once, and then pick out parts of the data later. For example,
15758 you could use a single LDAP lookup to return a string of the form
15759 .code
15760 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15761 .endd
15762 In the transport you could pick out the mailbox by a setting such as
15763 .code
15764 file = ${extract{mailbox}{$address_data}}
15765 .endd
15766 This makes the configuration file less messy, and also reduces the number of
15767 lookups (though Exim does cache lookups).
15768
15769 .vindex "&$sender_address_data$&"
15770 .vindex "&$address_data$&"
15771 The &%address_data%& facility is also useful as a means of passing information
15772 from one router to another, and from a router to a transport. In addition, if
15773 &$address_data$& is set by a router when verifying a recipient address from an
15774 ACL, it remains available for use in the rest of the ACL statement. After
15775 verifying a sender, the value is transferred to &$sender_address_data$&.
15776
15777
15778
15779 .option address_test routers&!? boolean true
15780 .oindex "&%-bt%&"
15781 .cindex "router" "skipping when address testing"
15782 If this option is set false, the router is skipped when routing is being tested
15783 by means of the &%-bt%& command line option. This can be a convenience when
15784 your first router sends messages to an external scanner, because it saves you
15785 having to set the &"already scanned"& indicator when testing real address
15786 routing.
15787
15788
15789
15790 .option cannot_route_message routers string&!! unset
15791 .cindex "router" "customizing &""cannot route""& message"
15792 .cindex "customizing" "&""cannot route""& message"
15793 This option specifies a text message that is used when an address cannot be
15794 routed because Exim has run out of routers. The default message is
15795 &"Unrouteable address"&. This option is useful only on routers that have
15796 &%more%& set false, or on the very last router in a configuration, because the
15797 value that is used is taken from the last router that is considered. This
15798 includes a router that is skipped because its preconditions are not met, as
15799 well as a router that declines. For example, using the default configuration,
15800 you could put:
15801 .code
15802 cannot_route_message = Remote domain not found in DNS
15803 .endd
15804 on the first router, which is a &(dnslookup)& router with &%more%& set false,
15805 and
15806 .code
15807 cannot_route_message = Unknown local user
15808 .endd
15809 on the final router that checks for local users. If string expansion fails for
15810 this option, the default message is used. Unless the expansion failure was
15811 explicitly forced, a message about the failure is written to the main and panic
15812 logs, in addition to the normal message about the routing failure.
15813
15814
15815 .option caseful_local_part routers boolean false
15816 .cindex "case of local parts"
15817 .cindex "router" "case of local parts"
15818 By default, routers handle the local parts of addresses in a case-insensitive
15819 manner, though the actual case is preserved for transmission with the message.
15820 If you want the case of letters to be significant in a router, you must set
15821 this option true. For individual router options that contain address or local
15822 part lists (for example, &%local_parts%&), case-sensitive matching can be
15823 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
15824 more details.
15825
15826 .vindex "&$local_part$&"
15827 .vindex "&$original_local_part$&"
15828 .vindex "&$parent_local_part$&"
15829 The value of the &$local_part$& variable is forced to lower case while a
15830 router is running unless &%caseful_local_part%& is set. When a router assigns
15831 an address to a transport, the value of &$local_part$& when the transport runs
15832 is the same as it was in the router. Similarly, when a router generates child
15833 addresses by aliasing or forwarding, the values of &$original_local_part$&
15834 and &$parent_local_part$& are those that were used by the redirecting router.
15835
15836 This option applies to the processing of an address by a router. When a
15837 recipient address is being processed in an ACL, there is a separate &%control%&
15838 modifier that can be used to specify case-sensitive processing within the ACL
15839 (see section &<<SECTcontrols>>&).
15840
15841
15842
15843 .option check_local_user routers&!? boolean false
15844 .cindex "local user, checking in router"
15845 .cindex "router" "checking for local user"
15846 .cindex "&_/etc/passwd_&"
15847 .vindex "&$home$&"
15848 When this option is true, Exim checks that the local part of the recipient
15849 address (with affixes removed if relevant) is the name of an account on the
15850 local system. The check is done by calling the &[getpwnam()]& function rather
15851 than trying to read &_/etc/passwd_& directly. This means that other methods of
15852 holding password data (such as NIS) are supported. If the local part is a local
15853 user, &$home$& is set from the password data, and can be tested in other
15854 preconditions that are evaluated after this one (the order of evaluation is
15855 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
15856 overridden by &%router_home_directory%&. If the local part is not a local user,
15857 the router is skipped.
15858
15859 If you want to check that the local part is either the name of a local user
15860 or matches something else, you cannot combine &%check_local_user%& with a
15861 setting of &%local_parts%&, because that specifies the logical &'and'& of the
15862 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
15863 setting to achieve this. For example:
15864 .code
15865 local_parts = passwd;$local_part : lsearch;/etc/other/users
15866 .endd
15867 Note, however, that the side effects of &%check_local_user%& (such as setting
15868 up a home directory) do not occur when a &(passwd)& lookup is used in a
15869 &%local_parts%& (or any other) precondition.
15870
15871
15872
15873 .option condition routers&!? string&!! unset
15874 .cindex "router" "customized precondition"
15875 This option specifies a general precondition test that has to succeed for the
15876 router to be called. The &%condition%& option is the last precondition to be
15877 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
15878 result is a forced failure, or an empty string, or one of the strings &"0"& or
15879 &"no"& or &"false"& (checked without regard to the case of the letters), the
15880 router is skipped, and the address is offered to the next one.
15881
15882 If the result is any other value, the router is run (as this is the last
15883 precondition to be evaluated, all the other preconditions must be true).
15884
15885 This option is unique in that multiple &%condition%& options may be present.
15886 All &%condition%& options must succeed.
15887
15888 The &%condition%& option provides a means of applying custom conditions to the
15889 running of routers. Note that in the case of a simple conditional expansion,
15890 the default expansion values are exactly what is wanted. For example:
15891 .code
15892 condition = ${if >{$message_age}{600}}
15893 .endd
15894 Because of the default behaviour of the string expansion, this is equivalent to
15895 .code
15896 condition = ${if >{$message_age}{600}{true}{}}
15897 .endd
15898
15899 A multiple condition example, which succeeds:
15900 .code
15901 condition = ${if >{$message_age}{600}}
15902 condition = ${if !eq{${lc:$local_part}}{postmaster}}
15903 condition = foobar
15904 .endd
15905
15906 If the expansion fails (other than forced failure) delivery is deferred. Some
15907 of the other precondition options are common special cases that could in fact
15908 be specified using &%condition%&.
15909
15910
15911 .option debug_print routers string&!! unset
15912 .cindex "testing" "variables in drivers"
15913 If this option is set and debugging is enabled (see the &%-d%& command line
15914 option), the string is expanded and included in the debugging output.
15915 If expansion of the string fails, the error message is written to the debugging
15916 output, and Exim carries on processing.
15917 This option is provided to help with checking out the values of variables and
15918 so on when debugging router configurations. For example, if a &%condition%&
15919 option appears not to be working, &%debug_print%& can be used to output the
15920 variables it references. The output happens after checks for &%domains%&,
15921 &%local_parts%&, and &%check_local_user%& but before any other preconditions
15922 are tested. A newline is added to the text if it does not end with one.
15923
15924
15925
15926 .option disable_logging routers boolean false
15927 If this option is set true, nothing is logged for any routing errors
15928 or for any deliveries caused by this router. You should not set this option
15929 unless you really, really know what you are doing. See also the generic
15930 transport option of the same name.
15931
15932
15933 .option domains routers&!? "domain list&!!" unset
15934 .cindex "router" "restricting to specific domains"
15935 .vindex "&$domain_data$&"
15936 If this option is set, the router is skipped unless the current domain matches
15937 the list. If the match is achieved by means of a file lookup, the data that the
15938 lookup returned for the domain is placed in &$domain_data$& for use in string
15939 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
15940 a list of the order in which preconditions are evaluated.
15941
15942
15943
15944 .option driver routers string unset
15945 This option must always be set. It specifies which of the available routers is
15946 to be used.
15947
15948
15949
15950 .option errors_to routers string&!! unset
15951 .cindex "envelope sender"
15952 .cindex "router" "changing address for errors"
15953 If a router successfully handles an address, it may assign the address to a
15954 transport for delivery or it may generate child addresses. In both cases, if
15955 there is a delivery problem during later processing, the resulting bounce
15956 message is sent to the address that results from expanding this string,
15957 provided that the address verifies successfully. The &%errors_to%& option is
15958 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
15959
15960 The &%errors_to%& setting associated with an address can be overridden if it
15961 subsequently passes through other routers that have their own &%errors_to%&
15962 settings, or if the message is delivered by a transport with a &%return_path%&
15963 setting.
15964
15965 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
15966 the expansion fails to verify, the errors address associated with the incoming
15967 address is used. At top level, this is the envelope sender. A non-forced
15968 expansion failure causes delivery to be deferred.
15969
15970 If an address for which &%errors_to%& has been set ends up being delivered over
15971 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
15972 any bounces that are generated by other MTAs on the delivery route are also
15973 sent there. You can set &%errors_to%& to the empty string by either of these
15974 settings:
15975 .code
15976 errors_to =
15977 errors_to = ""
15978 .endd
15979 An expansion item that yields an empty string has the same effect. If you do
15980 this, a locally detected delivery error for addresses processed by this router
15981 no longer gives rise to a bounce message; the error is discarded. If the
15982 address is delivered to a remote host, the return path is set to &`<>`&, unless
15983 overridden by the &%return_path%& option on the transport.
15984
15985 .vindex "&$address_data$&"
15986 If for some reason you want to discard local errors, but use a non-empty
15987 MAIL command for remote delivery, you can preserve the original return
15988 path in &$address_data$& in the router, and reinstate it in the transport by
15989 setting &%return_path%&.
15990
15991 The most common use of &%errors_to%& is to direct mailing list bounces to the
15992 manager of the list, as described in section &<<SECTmailinglists>>&, or to
15993 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
15994
15995
15996
15997 .option expn routers&!? boolean true
15998 .cindex "address" "testing"
15999 .cindex "testing" "addresses"
16000 .cindex "EXPN" "router skipping"
16001 .cindex "router" "skipping for EXPN"
16002 If this option is turned off, the router is skipped when testing an address
16003 as a result of processing an SMTP EXPN command. You might, for example,
16004 want to turn it off on a router for users' &_.forward_& files, while leaving it
16005 on for the system alias file.
16006 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16007 are evaluated.
16008
16009 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16010 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16011 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16012
16013
16014
16015 .option fail_verify routers boolean false
16016 .cindex "router" "forcing verification failure"
16017 Setting this option has the effect of setting both &%fail_verify_sender%& and
16018 &%fail_verify_recipient%& to the same value.
16019
16020
16021
16022 .option fail_verify_recipient routers boolean false
16023 If this option is true and an address is accepted by this router when
16024 verifying a recipient, verification fails.
16025
16026
16027
16028 .option fail_verify_sender routers boolean false
16029 If this option is true and an address is accepted by this router when
16030 verifying a sender, verification fails.
16031
16032
16033
16034 .option fallback_hosts routers "string list" unset
16035 .cindex "router" "fallback hosts"
16036 .cindex "fallback" "hosts specified on router"
16037 String expansion is not applied to this option. The argument must be a
16038 colon-separated list of host names or IP addresses. The list separator can be
16039 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16040 each name or address. In fact, the format of each item is exactly the same as
16041 defined for the list of hosts in a &(manualroute)& router (see section
16042 &<<SECTformatonehostitem>>&).
16043
16044 If a router queues an address for a remote transport, this host list is
16045 associated with the address, and used instead of the transport's fallback host
16046 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16047 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16048 transport for further details.
16049
16050
16051 .option group routers string&!! "see below"
16052 .cindex "gid (group id)" "local delivery"
16053 .cindex "local transports" "uid and gid"
16054 .cindex "transport" "local"
16055 .cindex "router" "setting group"
16056 When a router queues an address for a transport, and the transport does not
16057 specify a group, the group given here is used when running the delivery
16058 process.
16059 The group may be specified numerically or by name. If expansion fails, the
16060 error is logged and delivery is deferred.
16061 The default is unset, unless &%check_local_user%& is set, when the default
16062 is taken from the password information. See also &%initgroups%& and &%user%&
16063 and the discussion in chapter &<<CHAPenvironment>>&.
16064
16065
16066
16067 .option headers_add routers string&!! unset
16068 .cindex "header lines" "adding"
16069 .cindex "router" "adding header lines"
16070 This option specifies a string of text that is expanded at routing time, and
16071 associated with any addresses that are accepted by the router. However, this
16072 option has no effect when an address is just being verified. The way in which
16073 the text is used to add header lines at transport time is described in section
16074 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16075 message is in the process of being transported. This means that references to
16076 header lines in string expansions in the transport's configuration do not
16077 &"see"& the added header lines.
16078
16079 The &%headers_add%& option is expanded after &%errors_to%&, but before
16080 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16081 the expansion is forced to fail, the option has no effect. Other expansion
16082 failures are treated as configuration errors.
16083
16084 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16085 router that has the &%one_time%& option set.
16086
16087 .cindex "duplicate addresses"
16088 .oindex "&%unseen%&"
16089 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16090 additions are deleted when the address is passed on to subsequent routers.
16091 For a &%redirect%& router, if a generated address is the same as the incoming
16092 address, this can lead to duplicate addresses with different header
16093 modifications. Exim does not do duplicate deliveries (except, in certain
16094 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16095 which of the duplicates is discarded, so this ambiguous situation should be
16096 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16097
16098
16099
16100 .option headers_remove routers string&!! unset
16101 .cindex "header lines" "removing"
16102 .cindex "router" "removing header lines"
16103 This option specifies a string of text that is expanded at routing time, and
16104 associated with any addresses that are accepted by the router. However, this
16105 option has no effect when an address is just being verified. The way in which
16106 the text is used to remove header lines at transport time is described in
16107 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16108 the message is in the process of being transported. This means that references
16109 to header lines in string expansions in the transport's configuration still
16110 &"see"& the original header lines.
16111
16112 The &%headers_remove%& option is expanded after &%errors_to%& and
16113 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16114 the option has no effect. Other expansion failures are treated as configuration
16115 errors.
16116
16117 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16118 router that has the &%one_time%& option set.
16119
16120 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16121 removal requests are deleted when the address is passed on to subsequent
16122 routers, and this can lead to problems with duplicates -- see the similar
16123 warning for &%headers_add%& above.
16124
16125
16126 .option ignore_target_hosts routers "host list&!!" unset
16127 .cindex "IP address" "discarding"
16128 .cindex "router" "discarding IP addresses"
16129 Although this option is a host list, it should normally contain IP address
16130 entries rather than names. If any host that is looked up by the router has an
16131 IP address that matches an item in this list, Exim behaves as if that IP
16132 address did not exist. This option allows you to cope with rogue DNS entries
16133 like
16134 .code
16135 remote.domain.example.  A  127.0.0.1
16136 .endd
16137 by setting
16138 .code
16139 ignore_target_hosts = 127.0.0.1
16140 .endd
16141 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16142 discarded in this way, the router declines. In a conventional configuration, an
16143 attempt to mail to such a domain would normally provoke the &"unrouteable
16144 domain"& error, and an attempt to verify an address in the domain would fail.
16145 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16146 router declines if presented with one of the listed addresses.
16147
16148 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16149 means of the first or the second of the following settings, respectively:
16150 .code
16151 ignore_target_hosts = 0.0.0.0/0
16152 ignore_target_hosts = <; 0::0/0
16153 .endd
16154 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16155 in the second line matches all IPv6 addresses.
16156
16157 This option may also be useful for ignoring link-local and site-local IPv6
16158 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16159 is expanded before use as a list, it is possible to make it dependent on the
16160 domain that is being routed.
16161
16162 .vindex "&$host_address$&"
16163 During its expansion, &$host_address$& is set to the IP address that is being
16164 checked.
16165
16166 .option initgroups routers boolean false
16167 .cindex "additional groups"
16168 .cindex "groups" "additional"
16169 .cindex "local transports" "uid and gid"
16170 .cindex "transport" "local"
16171 If the router queues an address for a transport, and this option is true, and
16172 the uid supplied by the router is not overridden by the transport, the
16173 &[initgroups()]& function is called when running the transport to ensure that
16174 any additional groups associated with the uid are set up. See also &%group%&
16175 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16176
16177
16178
16179 .option local_part_prefix routers&!? "string list" unset
16180 .cindex "router" "prefix for local part"
16181 .cindex "prefix" "for local part, used in router"
16182 If this option is set, the router is skipped unless the local part starts with
16183 one of the given strings, or &%local_part_prefix_optional%& is true. See
16184 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16185 evaluated.
16186
16187 The list is scanned from left to right, and the first prefix that matches is
16188 used. A limited form of wildcard is available; if the prefix begins with an
16189 asterisk, it matches the longest possible sequence of arbitrary characters at
16190 the start of the local part. An asterisk should therefore always be followed by
16191 some character that does not occur in normal local parts.
16192 .cindex "multiple mailboxes"
16193 .cindex "mailbox" "multiple"
16194 Wildcarding can be used to set up multiple user mailboxes, as described in
16195 section &<<SECTmulbox>>&.
16196
16197 .vindex "&$local_part$&"
16198 .vindex "&$local_part_prefix$&"
16199 During the testing of the &%local_parts%& option, and while the router is
16200 running, the prefix is removed from the local part, and is available in the
16201 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16202 the router accepts the address, this remains true during subsequent delivery by
16203 a transport. In particular, the local part that is transmitted in the RCPT
16204 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16205 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16206 the relevant transport.
16207
16208 When an address is being verified, &%local_part_prefix%& affects only the
16209 behaviour of the router. If the callout feature of verification is in use, this
16210 means that the full address, including the prefix, will be used during the
16211 callout.
16212
16213 The prefix facility is commonly used to handle local parts of the form
16214 &%owner-something%&. Another common use is to support local parts of the form
16215 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16216 to tell a user their forwarding is broken &-- by placing a router like this one
16217 immediately before the router that handles &_.forward_& files:
16218 .code
16219 real_localuser:
16220   driver = accept
16221   local_part_prefix = real-
16222   check_local_user
16223   transport = local_delivery
16224 .endd
16225 For security, it would probably be a good idea to restrict the use of this
16226 router to locally-generated messages, using a condition such as this:
16227 .code
16228   condition = ${if match {$sender_host_address}\
16229                          {\N^(|127\.0\.0\.1)$\N}}
16230 .endd
16231
16232 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16233 both conditions must be met if not optional. Care must be taken if wildcards
16234 are used in both a prefix and a suffix on the same router. Different
16235 separator characters must be used to avoid ambiguity.
16236
16237
16238 .option local_part_prefix_optional routers boolean false
16239 See &%local_part_prefix%& above.
16240
16241
16242
16243 .option local_part_suffix routers&!? "string list" unset
16244 .cindex "router" "suffix for local part"
16245 .cindex "suffix for local part" "used in router"
16246 This option operates in the same way as &%local_part_prefix%&, except that the
16247 local part must end (rather than start) with the given string, the
16248 &%local_part_suffix_optional%& option determines whether the suffix is
16249 mandatory, and the wildcard * character, if present, must be the last
16250 character of the suffix. This option facility is commonly used to handle local
16251 parts of the form &%something-request%& and multiple user mailboxes of the form
16252 &%username-foo%&.
16253
16254
16255 .option local_part_suffix_optional routers boolean false
16256 See &%local_part_suffix%& above.
16257
16258
16259
16260 .option local_parts routers&!? "local part list&!!" unset
16261 .cindex "router" "restricting to specific local parts"
16262 .cindex "local part" "checking in router"
16263 The router is run only if the local part of the address matches the list.
16264 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16265 are evaluated, and
16266 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16267 string is expanded, it is possible to make it depend on the domain, for
16268 example:
16269 .code
16270 local_parts = dbm;/usr/local/specials/$domain
16271 .endd
16272 .vindex "&$local_part_data$&"
16273 If the match is achieved by a lookup, the data that the lookup returned
16274 for the local part is placed in the variable &$local_part_data$& for use in
16275 expansions of the router's private options. You might use this option, for
16276 example, if you have a large number of local virtual domains, and you want to
16277 send all postmaster mail to the same place without having to set up an alias in
16278 each virtual domain:
16279 .code
16280 postmaster:
16281   driver = redirect
16282   local_parts = postmaster
16283   data = postmaster@real.domain.example
16284 .endd
16285
16286
16287 .option log_as_local routers boolean "see below"
16288 .cindex "log" "delivery line"
16289 .cindex "delivery" "log line format"
16290 Exim has two logging styles for delivery, the idea being to make local
16291 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16292 recipient address is given just as the local part, without a domain. The use of
16293 this style is controlled by this option. It defaults to true for the &(accept)&
16294 router, and false for all the others. This option applies only when a
16295 router assigns an address to a transport. It has no effect on routers that
16296 redirect addresses.
16297
16298
16299
16300 .option more routers boolean&!! true
16301 The result of string expansion for this option must be a valid boolean value,
16302 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16303 result causes an error, and delivery is deferred. If the expansion is forced to
16304 fail, the default value for the option (true) is used. Other failures cause
16305 delivery to be deferred.
16306
16307 If this option is set false, and the router declines to handle the address, no
16308 further routers are tried, routing fails, and the address is bounced.
16309 .oindex "&%self%&"
16310 However, if the router explicitly passes an address to the following router by
16311 means of the setting
16312 .code
16313 self = pass
16314 .endd
16315 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16316 does not affect the behaviour if one of the precondition tests fails. In that
16317 case, the address is always passed to the next router.
16318
16319 Note that &%address_data%& is not considered to be a precondition. If its
16320 expansion is forced to fail, the router declines, and the value of &%more%&
16321 controls what happens next.
16322
16323
16324 .option pass_on_timeout routers boolean false
16325 .cindex "timeout" "of router"
16326 .cindex "router" "timeout"
16327 If a router times out during a host lookup, it normally causes deferral of the
16328 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16329 router, overriding &%no_more%&. This may be helpful for systems that are
16330 intermittently connected to the Internet, or those that want to pass to a smart
16331 host any messages that cannot immediately be delivered.
16332
16333 There are occasional other temporary errors that can occur while doing DNS
16334 lookups. They are treated in the same way as a timeout, and this option
16335 applies to all of them.
16336
16337
16338
16339 .option pass_router routers string unset
16340 .cindex "router" "go to after &""pass""&"
16341 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16342 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16343 routing to continue, and overriding a false setting of &%more%&. When one of
16344 these routers returns &"pass"&, the address is normally handed on to the next
16345 router in sequence. This can be changed by setting &%pass_router%& to the name
16346 of another router. However (unlike &%redirect_router%&) the named router must
16347 be below the current router, to avoid loops. Note that this option applies only
16348 to the special case of &"pass"&. It does not apply when a router returns
16349 &"decline"& because it cannot handle an address.
16350
16351
16352
16353 .option redirect_router routers string unset
16354 .cindex "router" "start at after redirection"
16355 Sometimes an administrator knows that it is pointless to reprocess addresses
16356 generated from alias or forward files with the same router again. For
16357 example, if an alias file translates real names into login ids there is no
16358 point searching the alias file a second time, especially if it is a large file.
16359
16360 The &%redirect_router%& option can be set to the name of any router instance.
16361 It causes the routing of any generated addresses to start at the named router
16362 instead of at the first router. This option has no effect if the router in
16363 which it is set does not generate new addresses.
16364
16365
16366
16367 .option require_files routers&!? "string list&!!" unset
16368 .cindex "file" "requiring for router"
16369 .cindex "router" "requiring file existence"
16370 This option provides a general mechanism for predicating the running of a
16371 router on the existence or non-existence of certain files or directories.
16372 Before running a router, as one of its precondition tests, Exim works its way
16373 through the &%require_files%& list, expanding each item separately.
16374
16375 Because the list is split before expansion, any colons in expansion items must
16376 be doubled, or the facility for using a different list separator must be used.
16377 If any expansion is forced to fail, the item is ignored. Other expansion
16378 failures cause routing of the address to be deferred.
16379
16380 If any expanded string is empty, it is ignored. Otherwise, except as described
16381 below, each string must be a fully qualified file path, optionally preceded by
16382 &"!"&. The paths are passed to the &[stat()]& function to test for the
16383 existence of the files or directories. The router is skipped if any paths not
16384 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16385
16386 .cindex "NFS"
16387 If &[stat()]& cannot determine whether a file exists or not, delivery of
16388 the message is deferred. This can happen when NFS-mounted filesystems are
16389 unavailable.
16390
16391 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16392 options, so you cannot use it to check for the existence of a file in which to
16393 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16394 full list of the order in which preconditions are evaluated.) However, as
16395 these options are all expanded, you can use the &%exists%& expansion condition
16396 to make such tests. The &%require_files%& option is intended for checking files
16397 that the router may be going to use internally, or which are needed by a
16398 transport (for example &_.procmailrc_&).
16399
16400 During delivery, the &[stat()]& function is run as root, but there is a
16401 facility for some checking of the accessibility of a file by another user.
16402 This is not a proper permissions check, but just a &"rough"& check that
16403 operates as follows:
16404
16405 If an item in a &%require_files%& list does not contain any forward slash
16406 characters, it is taken to be the user (and optional group, separated by a
16407 comma) to be checked for subsequent files in the list. If no group is specified
16408 but the user is specified symbolically, the gid associated with the uid is
16409 used. For example:
16410 .code
16411 require_files = mail:/some/file
16412 require_files = $local_part:$home/.procmailrc
16413 .endd
16414 If a user or group name in a &%require_files%& list does not exist, the
16415 &%require_files%& condition fails.
16416
16417 Exim performs the check by scanning along the components of the file path, and
16418 checking the access for the given uid and gid. It checks for &"x"& access on
16419 directories, and &"r"& access on the final file. Note that this means that file
16420 access control lists, if the operating system has them, are ignored.
16421
16422 &*Warning 1*&: When the router is being run to verify addresses for an
16423 incoming SMTP message, Exim is not running as root, but under its own uid. This
16424 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16425 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16426 user is not permitted to read one of the directories on the file's path.
16427
16428 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16429 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16430 without root access. In this case, if a check for access by a particular user
16431 is requested, Exim creates a subprocess that runs as that user, and tries the
16432 check again in that process.
16433
16434 The default action for handling an unresolved EACCES is to consider it to
16435 be caused by a configuration error, and routing is deferred because the
16436 existence or non-existence of the file cannot be determined. However, in some
16437 circumstances it may be desirable to treat this condition as if the file did
16438 not exist. If the file name (or the exclamation mark that precedes the file
16439 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16440 as if the file did not exist. For example:
16441 .code
16442 require_files = +/some/file
16443 .endd
16444 If the router is not an essential part of verification (for example, it
16445 handles users' &_.forward_& files), another solution is to set the &%verify%&
16446 option false so that the router is skipped when verifying.
16447
16448
16449
16450 .option retry_use_local_part routers boolean "see below"
16451 .cindex "hints database" "retry keys"
16452 .cindex "local part" "in retry keys"
16453 When a delivery suffers a temporary routing failure, a retry record is created
16454 in Exim's hints database. For addresses whose routing depends only on the
16455 domain, the key for the retry record should not involve the local part, but for
16456 other addresses, both the domain and the local part should be included.
16457 Usually, remote routing is of the former kind, and local routing is of the
16458 latter kind.
16459
16460 This option controls whether the local part is used to form the key for retry
16461 hints for addresses that suffer temporary errors while being handled by this
16462 router. The default value is true for any router that has &%check_local_user%&
16463 set, and false otherwise. Note that this option does not apply to hints keys
16464 for transport delays; they are controlled by a generic transport option of the
16465 same name.
16466
16467 The setting of &%retry_use_local_part%& applies only to the router on which it
16468 appears. If the router generates child addresses, they are routed
16469 independently; this setting does not become attached to them.
16470
16471
16472
16473 .option router_home_directory routers string&!! unset
16474 .cindex "router" "home directory for"
16475 .cindex "home directory" "for router"
16476 .vindex "&$home$&"
16477 This option sets a home directory for use while the router is running. (Compare
16478 &%transport_home_directory%&, which sets a home directory for later
16479 transporting.) In particular, if used on a &(redirect)& router, this option
16480 sets a value for &$home$& while a filter is running. The value is expanded;
16481 forced expansion failure causes the option to be ignored &-- other failures
16482 cause the router to defer.
16483
16484 Expansion of &%router_home_directory%& happens immediately after the
16485 &%check_local_user%& test (if configured), before any further expansions take
16486 place.
16487 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16488 are evaluated.)
16489 While the router is running, &%router_home_directory%& overrides the value of
16490 &$home$& that came from &%check_local_user%&.
16491
16492 When a router accepts an address and assigns it to a local transport (including
16493 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16494 delivery), the home directory setting for the transport is taken from the first
16495 of these values that is set:
16496
16497 .ilist
16498 The &%home_directory%& option on the transport;
16499 .next
16500 The &%transport_home_directory%& option on the router;
16501 .next
16502 The password data if &%check_local_user%& is set on the router;
16503 .next
16504 The &%router_home_directory%& option on the router.
16505 .endlist
16506
16507 In other words, &%router_home_directory%& overrides the password data for the
16508 router, but not for the transport.
16509
16510
16511
16512 .option self routers string freeze
16513 .cindex "MX record" "pointing to local host"
16514 .cindex "local host" "MX pointing to"
16515 This option applies to those routers that use a recipient address to find a
16516 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16517 and &(manualroute)& routers.
16518 Certain configurations of the &(queryprogram)& router can also specify a list
16519 of remote hosts.
16520 Usually such routers are configured to send the message to a remote host via an
16521 &(smtp)& transport. The &%self%& option specifies what happens when the first
16522 host on the list turns out to be the local host.
16523 The way in which Exim checks for the local host is described in section
16524 &<<SECTreclocipadd>>&.
16525
16526 Normally this situation indicates either an error in Exim's configuration (for
16527 example, the router should be configured not to process this domain), or an
16528 error in the DNS (for example, the MX should not point to this host). For this
16529 reason, the default action is to log the incident, defer the address, and
16530 freeze the message. The following alternatives are provided for use in special
16531 cases:
16532
16533 .vlist
16534 .vitem &%defer%&
16535 Delivery of the message is tried again later, but the message is not frozen.
16536
16537 .vitem "&%reroute%&: <&'domain'&>"
16538 The domain is changed to the given domain, and the address is passed back to
16539 be reprocessed by the routers. No rewriting of headers takes place. This
16540 behaviour is essentially a redirection.
16541
16542 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16543 The domain is changed to the given domain, and the address is passed back to be
16544 reprocessed by the routers. Any headers that contain the original domain are
16545 rewritten.
16546
16547 .vitem &%pass%&
16548 .oindex "&%more%&"
16549 .vindex "&$self_hostname$&"
16550 The router passes the address to the next router, or to the router named in the
16551 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16552 subsequent routing and delivery, the variable &$self_hostname$& contains the
16553 name of the local host that the router encountered. This can be used to
16554 distinguish between different cases for hosts with multiple names. The
16555 combination
16556 .code
16557 self = pass
16558 no_more
16559 .endd
16560 ensures that only those addresses that routed to the local host are passed on.
16561 Without &%no_more%&, addresses that were declined for other reasons would also
16562 be passed to the next router.
16563
16564 .vitem &%fail%&
16565 Delivery fails and an error report is generated.
16566
16567 .vitem &%send%&
16568 .cindex "local host" "sending to"
16569 The anomaly is ignored and the address is queued for the transport. This
16570 setting should be used with extreme caution. For an &(smtp)& transport, it
16571 makes sense only in cases where the program that is listening on the SMTP port
16572 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16573 different configuration file that handles the domain in another way.
16574 .endlist
16575
16576
16577
16578 .option senders routers&!? "address list&!!" unset
16579 .cindex "router" "checking senders"
16580 If this option is set, the router is skipped unless the message's sender
16581 address matches something on the list.
16582 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16583 are evaluated.
16584
16585 There are issues concerning verification when the running of routers is
16586 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16587 setting, it sets the sender to the null string. When using the &%-bt%& option
16588 to check a configuration file, it is necessary also to use the &%-f%& option to
16589 set an appropriate sender. For incoming mail, the sender is unset when
16590 verifying the sender, but is available when verifying any recipients. If the
16591 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16592 matters.
16593
16594
16595 .option translate_ip_address routers string&!! unset
16596 .cindex "IP address" "translating"
16597 .cindex "packet radio"
16598 .cindex "router" "IP address translation"
16599 There exist some rare networking situations (for example, packet radio) where
16600 it is helpful to be able to translate IP addresses generated by normal routing
16601 mechanisms into other IP addresses, thus performing a kind of manual IP
16602 routing. This should be done only if the normal IP routing of the TCP/IP stack
16603 is inadequate or broken. Because this is an extremely uncommon requirement, the
16604 code to support this option is not included in the Exim binary unless
16605 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16606
16607 .vindex "&$host_address$&"
16608 The &%translate_ip_address%& string is expanded for every IP address generated
16609 by the router, with the generated address set in &$host_address$&. If the
16610 expansion is forced to fail, no action is taken.
16611 For any other expansion error, delivery of the message is deferred.
16612 If the result of the expansion is an IP address, that replaces the original
16613 address; otherwise the result is assumed to be a host name &-- this is looked
16614 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16615 produce one or more replacement IP addresses. For example, to subvert all IP
16616 addresses in some specific networks, this could be added to a router:
16617 .code
16618 translate_ip_address = \
16619   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16620     {$value}fail}}
16621 .endd
16622 The file would contain lines like
16623 .code
16624 10.2.3.128/26    some.host
16625 10.8.4.34/26     10.44.8.15
16626 .endd
16627 You should not make use of this facility unless you really understand what you
16628 are doing.
16629
16630
16631
16632 .option transport routers string&!! unset
16633 This option specifies the transport to be used when a router accepts an address
16634 and sets it up for delivery. A transport is never needed if a router is used
16635 only for verification. The value of the option is expanded at routing time,
16636 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16637 and result must be the name of one of the configured transports. If it is not,
16638 delivery is deferred.
16639
16640 The &%transport%& option is not used by the &(redirect)& router, but it does
16641 have some private options that set up transports for pipe and file deliveries
16642 (see chapter &<<CHAPredirect>>&).
16643
16644
16645
16646 .option transport_current_directory routers string&!! unset
16647 .cindex "current directory for local transport"
16648 This option associates a current directory with any address that is routed
16649 to a local transport. This can happen either because a transport is
16650 explicitly configured for the router, or because it generates a delivery to a
16651 file or a pipe. During the delivery process (that is, at transport time), this
16652 option string is expanded and is set as the current directory, unless
16653 overridden by a setting on the transport.
16654 If the expansion fails for any reason, including forced failure, an error is
16655 logged, and delivery is deferred.
16656 See chapter &<<CHAPenvironment>>& for details of the local delivery
16657 environment.
16658
16659
16660
16661
16662 .option transport_home_directory routers string&!! "see below"
16663 .cindex "home directory" "for local transport"
16664 This option associates a home directory with any address that is routed to a
16665 local transport. This can happen either because a transport is explicitly
16666 configured for the router, or because it generates a delivery to a file or a
16667 pipe. During the delivery process (that is, at transport time), the option
16668 string is expanded and is set as the home directory, unless overridden by a
16669 setting of &%home_directory%& on the transport.
16670 If the expansion fails for any reason, including forced failure, an error is
16671 logged, and delivery is deferred.
16672
16673 If the transport does not specify a home directory, and
16674 &%transport_home_directory%& is not set for the router, the home directory for
16675 the transport is taken from the password data if &%check_local_user%& is set for
16676 the router. Otherwise it is taken from &%router_home_directory%& if that option
16677 is set; if not, no home directory is set for the transport.
16678
16679 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16680 environment.
16681
16682
16683
16684
16685 .option unseen routers boolean&!! false
16686 .cindex "router" "carrying on after success"
16687 The result of string expansion for this option must be a valid boolean value,
16688 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16689 result causes an error, and delivery is deferred. If the expansion is forced to
16690 fail, the default value for the option (false) is used. Other failures cause
16691 delivery to be deferred.
16692
16693 When this option is set true, routing does not cease if the router accepts the
16694 address. Instead, a copy of the incoming address is passed to the next router,
16695 overriding a false setting of &%more%&. There is little point in setting
16696 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16697 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16698 sometimes true and sometimes false).
16699
16700 .cindex "copy of message (&%unseen%& option)"
16701 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16702 qualifier in filter files. It can be used to cause copies of messages to be
16703 delivered to some other destination, while also carrying out a normal delivery.
16704 In effect, the current address is made into a &"parent"& that has two children
16705 &-- one that is delivered as specified by this router, and a clone that goes on
16706 to be routed further. For this reason, &%unseen%& may not be combined with the
16707 &%one_time%& option in a &(redirect)& router.
16708
16709 &*Warning*&: Header lines added to the address (or specified for removal) by
16710 this router or by previous routers affect the &"unseen"& copy of the message
16711 only. The clone that continues to be processed by further routers starts with
16712 no added headers and none specified for removal. For a &%redirect%& router, if
16713 a generated address is the same as the incoming address, this can lead to
16714 duplicate addresses with different header modifications. Exim does not do
16715 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16716 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16717 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16718 &%redirect%& router may be of help.
16719
16720 Unlike the handling of header modifications, any data that was set by the
16721 &%address_data%& option in the current or previous routers &'is'& passed on to
16722 subsequent routers.
16723
16724
16725 .option user routers string&!! "see below"
16726 .cindex "uid (user id)" "local delivery"
16727 .cindex "local transports" "uid and gid"
16728 .cindex "transport" "local"
16729 .cindex "router" "user for filter processing"
16730 .cindex "filter" "user for processing"
16731 When a router queues an address for a transport, and the transport does not
16732 specify a user, the user given here is used when running the delivery process.
16733 The user may be specified numerically or by name. If expansion fails, the
16734 error is logged and delivery is deferred.
16735 This user is also used by the &(redirect)& router when running a filter file.
16736 The default is unset, except when &%check_local_user%& is set. In this case,
16737 the default is taken from the password information. If the user is specified as
16738 a name, and &%group%& is not set, the group associated with the user is used.
16739 See also &%initgroups%& and &%group%& and the discussion in chapter
16740 &<<CHAPenvironment>>&.
16741
16742
16743
16744 .option verify routers&!? boolean true
16745 Setting this option has the effect of setting &%verify_sender%& and
16746 &%verify_recipient%& to the same value.
16747
16748
16749 .option verify_only routers&!? boolean false
16750 .cindex "EXPN" "with &%verify_only%&"
16751 .oindex "&%-bv%&"
16752 .cindex "router" "used only when verifying"
16753 If this option is set, the router is used only when verifying an address or
16754 testing with the &%-bv%& option, not when actually doing a delivery, testing
16755 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16756 restricted to verifying only senders or recipients by means of
16757 &%verify_sender%& and &%verify_recipient%&.
16758
16759 &*Warning*&: When the router is being run to verify addresses for an incoming
16760 SMTP message, Exim is not running as root, but under its own uid. If the router
16761 accesses any files, you need to make sure that they are accessible to the Exim
16762 user or group.
16763
16764
16765 .option verify_recipient routers&!? boolean true
16766 If this option is false, the router is skipped when verifying recipient
16767 addresses
16768 or testing recipient verification using &%-bv%&.
16769 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16770 are evaluated.
16771
16772
16773 .option verify_sender routers&!? boolean true
16774 If this option is false, the router is skipped when verifying sender addresses
16775 or testing sender verification using &%-bvs%&.
16776 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16777 are evaluated.
16778 .ecindex IIDgenoprou1
16779 .ecindex IIDgenoprou2
16780
16781
16782
16783
16784
16785
16786 . ////////////////////////////////////////////////////////////////////////////
16787 . ////////////////////////////////////////////////////////////////////////////
16788
16789 .chapter "The accept router" "CHID4"
16790 .cindex "&(accept)& router"
16791 .cindex "routers" "&(accept)&"
16792 The &(accept)& router has no private options of its own. Unless it is being
16793 used purely for verification (see &%verify_only%&) a transport is required to
16794 be defined by the generic &%transport%& option. If the preconditions that are
16795 specified by generic options are met, the router accepts the address and queues
16796 it for the given transport. The most common use of this router is for setting
16797 up deliveries to local mailboxes. For example:
16798 .code
16799 localusers:
16800   driver = accept
16801   domains = mydomain.example
16802   check_local_user
16803   transport = local_delivery
16804 .endd
16805 The &%domains%& condition in this example checks the domain of the address, and
16806 &%check_local_user%& checks that the local part is the login of a local user.
16807 When both preconditions are met, the &(accept)& router runs, and queues the
16808 address for the &(local_delivery)& transport.
16809
16810
16811
16812
16813
16814
16815 . ////////////////////////////////////////////////////////////////////////////
16816 . ////////////////////////////////////////////////////////////////////////////
16817
16818 .chapter "The dnslookup router" "CHAPdnslookup"
16819 .scindex IIDdnsrou1 "&(dnslookup)& router"
16820 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
16821 The &(dnslookup)& router looks up the hosts that handle mail for the
16822 recipient's domain in the DNS. A transport must always be set for this router,
16823 unless &%verify_only%& is set.
16824
16825 If SRV support is configured (see &%check_srv%& below), Exim first searches for
16826 SRV records. If none are found, or if SRV support is not configured,
16827 MX records are looked up. If no MX records exist, address records are sought.
16828 However, &%mx_domains%& can be set to disable the direct use of address
16829 records.
16830
16831 MX records of equal priority are sorted by Exim into a random order. Exim then
16832 looks for address records for the host names obtained from MX or SRV records.
16833 When a host has more than one IP address, they are sorted into a random order,
16834 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
16835 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
16836 generic option, the router declines.
16837
16838 Unless they have the highest priority (lowest MX value), MX records that point
16839 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
16840 are discarded, together with any other MX records of equal or lower priority.
16841
16842 .cindex "MX record" "pointing to local host"
16843 .cindex "local host" "MX pointing to"
16844 .oindex "&%self%&" "in &(dnslookup)& router"
16845 If the host pointed to by the highest priority MX record, or looked up as an
16846 address record, is the local host, or matches &%hosts_treat_as_local%&, what
16847 happens is controlled by the generic &%self%& option.
16848
16849
16850 .section "Problems with DNS lookups" "SECTprowitdnsloo"
16851 There have been problems with DNS servers when SRV records are looked up.
16852 Some mis-behaving servers return a DNS error or timeout when a non-existent
16853 SRV record is sought. Similar problems have in the past been reported for
16854 MX records. The global &%dns_again_means_nonexist%& option can help with this
16855 problem, but it is heavy-handed because it is a global option.
16856
16857 For this reason, there are two options, &%srv_fail_domains%& and
16858 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
16859 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
16860 an attempt to look up an SRV or MX record causes one of these results, and the
16861 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
16862 such record"&. In the case of an SRV lookup, this means that the router
16863 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
16864 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
16865 case routing fails.
16866
16867
16868
16869
16870 .section "Private options for dnslookup" "SECID118"
16871 .cindex "options" "&(dnslookup)& router"
16872 The private options for the &(dnslookup)& router are as follows:
16873
16874 .option check_secondary_mx dnslookup boolean false
16875 .cindex "MX record" "checking for secondary"
16876 If this option is set, the router declines unless the local host is found in
16877 (and removed from) the list of hosts obtained by MX lookup. This can be used to
16878 process domains for which the local host is a secondary mail exchanger
16879 differently to other domains. The way in which Exim decides whether a host is
16880 the local host is described in section &<<SECTreclocipadd>>&.
16881
16882
16883 .option check_srv dnslookup string&!! unset
16884 .cindex "SRV record" "enabling use of"
16885 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
16886 addition to MX and address records. The support is disabled by default. To
16887 enable SRV support, set the &%check_srv%& option to the name of the service
16888 required. For example,
16889 .code
16890 check_srv = smtp
16891 .endd
16892 looks for SRV records that refer to the normal smtp service. The option is
16893 expanded, so the service name can vary from message to message or address
16894 to address. This might be helpful if SRV records are being used for a
16895 submission service. If the expansion is forced to fail, the &%check_srv%&
16896 option is ignored, and the router proceeds to look for MX records in the
16897 normal way.
16898
16899 When the expansion succeeds, the router searches first for SRV records for
16900 the given service (it assumes TCP protocol). A single SRV record with a
16901 host name that consists of just a single dot indicates &"no such service for
16902 this domain"&; if this is encountered, the router declines. If other kinds of
16903 SRV record are found, they are used to construct a host list for delivery
16904 according to the rules of RFC 2782. MX records are not sought in this case.
16905
16906 When no SRV records are found, MX records (and address records) are sought in
16907 the traditional way. In other words, SRV records take precedence over MX
16908 records, just as MX records take precedence over address records. Note that
16909 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
16910 defined it. It is apparently believed that MX records are sufficient for email
16911 and that SRV records should not be used for this purpose. However, SRV records
16912 have an additional &"weight"& feature which some people might find useful when
16913 trying to split an SMTP load between hosts of different power.
16914
16915 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
16916 when there is a DNS lookup error.
16917
16918
16919
16920 .option mx_domains dnslookup "domain list&!!" unset
16921 .cindex "MX record" "required to exist"
16922 .cindex "SRV record" "required to exist"
16923 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
16924 record in order to be recognized. (The name of this option could be improved.)
16925 For example, if all the mail hosts in &'fict.example'& are known to have MX
16926 records, except for those in &'discworld.fict.example'&, you could use this
16927 setting:
16928 .code
16929 mx_domains = ! *.discworld.fict.example : *.fict.example
16930 .endd
16931 This specifies that messages addressed to a domain that matches the list but
16932 has no MX record should be bounced immediately instead of being routed using
16933 the address record.
16934
16935
16936 .option mx_fail_domains dnslookup "domain list&!!" unset
16937 If the DNS lookup for MX records for one of the domains in this list causes a
16938 DNS lookup error, Exim behaves as if no MX records were found. See section
16939 &<<SECTprowitdnsloo>>& for more discussion.
16940
16941
16942
16943
16944 .option qualify_single dnslookup boolean true
16945 .cindex "DNS" "resolver options"
16946 .cindex "DNS" "qualifying single-component names"
16947 When this option is true, the resolver option RES_DEFNAMES is set for DNS
16948 lookups. Typically, but not standardly, this causes the resolver to qualify
16949 single-component names with the default domain. For example, on a machine
16950 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
16951 &'thesaurus.ref.example'& inside the resolver. For details of what your
16952 resolver actually does, consult your man pages for &'resolver'& and
16953 &'resolv.conf'&.
16954
16955
16956
16957 .option rewrite_headers dnslookup boolean true
16958 .cindex "rewriting" "header lines"
16959 .cindex "header lines" "rewriting"
16960 If the domain name in the address that is being processed is not fully
16961 qualified, it may be expanded to its full form by a DNS lookup. For example, if
16962 an address is specified as &'dormouse@teaparty'&, the domain might be
16963 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
16964 occur as a result of setting the &%widen_domains%& option. If
16965 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
16966 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
16967 header lines of the message are rewritten with the full domain name.
16968
16969 This option should be turned off only when it is known that no message is
16970 ever going to be sent outside an environment where the abbreviation makes
16971 sense.
16972
16973 When an MX record is looked up in the DNS and matches a wildcard record, name
16974 servers normally return a record containing the name that has been looked up,
16975 making it impossible to detect whether a wildcard was present or not. However,
16976 some name servers have recently been seen to return the wildcard entry. If the
16977 name returned by a DNS lookup begins with an asterisk, it is not used for
16978 header rewriting.
16979
16980
16981 .option same_domain_copy_routing dnslookup boolean false
16982 .cindex "address" "copying routing"
16983 Addresses with the same domain are normally routed by the &(dnslookup)& router
16984 to the same list of hosts. However, this cannot be presumed, because the router
16985 options and preconditions may refer to the local part of the address. By
16986 default, therefore, Exim routes each address in a message independently. DNS
16987 servers run caches, so repeated DNS lookups are not normally expensive, and in
16988 any case, personal messages rarely have more than a few recipients.
16989
16990 If you are running mailing lists with large numbers of subscribers at the same
16991 domain, and you are using a &(dnslookup)& router which is independent of the
16992 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
16993 lookups for identical domains in one message. In this case, when &(dnslookup)&
16994 routes an address to a remote transport, any other unrouted addresses in the
16995 message that have the same domain are automatically given the same routing
16996 without processing them independently,
16997 provided the following conditions are met:
16998
16999 .ilist
17000 No router that processed the address specified &%headers_add%& or
17001 &%headers_remove%&.
17002 .next
17003 The router did not change the address in any way, for example, by &"widening"&
17004 the domain.
17005 .endlist
17006
17007
17008
17009
17010 .option search_parents dnslookup boolean false
17011 .cindex "DNS" "resolver options"
17012 When this option is true, the resolver option RES_DNSRCH is set for DNS
17013 lookups. This is different from the &%qualify_single%& option in that it
17014 applies to domains containing dots. Typically, but not standardly, it causes
17015 the resolver to search for the name in the current domain and in parent
17016 domains. For example, on a machine in the &'fict.example'& domain, if looking
17017 up &'teaparty.wonderland'& failed, the resolver would try
17018 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17019 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17020
17021 Setting this option true can cause problems in domains that have a wildcard MX
17022 record, because any domain that does not have its own MX record matches the
17023 local wildcard.
17024
17025
17026
17027 .option srv_fail_domains dnslookup "domain list&!!" unset
17028 If the DNS lookup for SRV records for one of the domains in this list causes a
17029 DNS lookup error, Exim behaves as if no SRV records were found. See section
17030 &<<SECTprowitdnsloo>>& for more discussion.
17031
17032
17033
17034
17035 .option widen_domains dnslookup "string list" unset
17036 .cindex "domain" "partial; widening"
17037 If a DNS lookup fails and this option is set, each of its strings in turn is
17038 added onto the end of the domain, and the lookup is tried again. For example,
17039 if
17040 .code
17041 widen_domains = fict.example:ref.example
17042 .endd
17043 is set and a lookup of &'klingon.dictionary'& fails,
17044 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17045 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17046 and &%search_parents%& options can cause some widening to be undertaken inside
17047 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17048 when verifying, unless &%rewrite_headers%& is false (not the default).
17049
17050
17051 .section "Effect of qualify_single and search_parents" "SECID119"
17052 When a domain from an envelope recipient is changed by the resolver as a result
17053 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17054 corresponding address in the message's header lines unless &%rewrite_headers%&
17055 is set false. Exim then re-routes the address, using the full domain.
17056
17057 These two options affect only the DNS lookup that takes place inside the router
17058 for the domain of the address that is being routed. They do not affect lookups
17059 such as that implied by
17060 .code
17061 domains = @mx_any
17062 .endd
17063 that may happen while processing a router precondition before the router is
17064 entered. No widening ever takes place for these lookups.
17065 .ecindex IIDdnsrou1
17066 .ecindex IIDdnsrou2
17067
17068
17069
17070
17071
17072
17073
17074
17075
17076 . ////////////////////////////////////////////////////////////////////////////
17077 . ////////////////////////////////////////////////////////////////////////////
17078
17079 .chapter "The ipliteral router" "CHID5"
17080 .cindex "&(ipliteral)& router"
17081 .cindex "domain literal" "routing"
17082 .cindex "routers" "&(ipliteral)&"
17083 This router has no private options. Unless it is being used purely for
17084 verification (see &%verify_only%&) a transport is required to be defined by the
17085 generic &%transport%& option. The router accepts the address if its domain part
17086 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17087 router handles the address
17088 .code
17089 root@[192.168.1.1]
17090 .endd
17091 by setting up delivery to the host with that IP address. IPv4 domain literals
17092 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17093 are similar, but the address is preceded by &`ipv6:`&. For example:
17094 .code
17095 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17096 .endd
17097 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17098 grounds that sooner or later somebody will try it.
17099
17100 .oindex "&%self%&" "in &(ipliteral)& router"
17101 If the IP address matches something in &%ignore_target_hosts%&, the router
17102 declines. If an IP literal turns out to refer to the local host, the generic
17103 &%self%& option determines what happens.
17104
17105 The RFCs require support for domain literals; however, their use is
17106 controversial in today's Internet. If you want to use this router, you must
17107 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17108 Exim will not recognize the domain literal syntax in addresses.
17109
17110
17111
17112 . ////////////////////////////////////////////////////////////////////////////
17113 . ////////////////////////////////////////////////////////////////////////////
17114
17115 .chapter "The iplookup router" "CHID6"
17116 .cindex "&(iplookup)& router"
17117 .cindex "routers" "&(iplookup)&"
17118 The &(iplookup)& router was written to fulfil a specific requirement in
17119 Cambridge University (which in fact no longer exists). For this reason, it is
17120 not included in the binary of Exim by default. If you want to include it, you
17121 must set
17122 .code
17123 ROUTER_IPLOOKUP=yes
17124 .endd
17125 in your &_Local/Makefile_& configuration file.
17126
17127 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17128 connection to one or more specific hosts. The host can then return the same or
17129 a different address &-- in effect rewriting the recipient address in the
17130 message's envelope. The new address is then passed on to subsequent routers. If
17131 this process fails, the address can be passed on to other routers, or delivery
17132 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17133 must not be specified for it.
17134
17135 .cindex "options" "&(iplookup)& router"
17136 .option hosts iplookup string unset
17137 This option must be supplied. Its value is a colon-separated list of host
17138 names. The hosts are looked up using &[gethostbyname()]&
17139 (or &[getipnodebyname()]& when available)
17140 and are tried in order until one responds to the query. If none respond, what
17141 happens is controlled by &%optional%&.
17142
17143
17144 .option optional iplookup boolean false
17145 If &%optional%& is true, if no response is obtained from any host, the address
17146 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17147 delivery to the address is deferred.
17148
17149
17150 .option port iplookup integer 0
17151 .cindex "port" "&(iplookup)& router"
17152 This option must be supplied. It specifies the port number for the TCP or UDP
17153 call.
17154
17155
17156 .option protocol iplookup string udp
17157 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17158 protocols is to be used.
17159
17160
17161 .option query iplookup string&!! "see below"
17162 This defines the content of the query that is sent to the remote hosts. The
17163 default value is:
17164 .code
17165 $local_part@$domain $local_part@$domain
17166 .endd
17167 The repetition serves as a way of checking that a response is to the correct
17168 query in the default case (see &%response_pattern%& below).
17169
17170
17171 .option reroute iplookup string&!! unset
17172 If this option is not set, the rerouted address is precisely the byte string
17173 returned by the remote host, up to the first white space, if any. If set, the
17174 string is expanded to form the rerouted address. It can include parts matched
17175 in the response by &%response_pattern%& by means of numeric variables such as
17176 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17177 whether or not a pattern is in use. In all cases, the rerouted address must end
17178 up in the form &'local_part@domain'&.
17179
17180
17181 .option response_pattern iplookup string unset
17182 This option can be set to a regular expression that is applied to the string
17183 returned from the remote host. If the pattern does not match the response, the
17184 router declines. If &%response_pattern%& is not set, no checking of the
17185 response is done, unless the query was defaulted, in which case there is a
17186 check that the text returned after the first white space is the original
17187 address. This checks that the answer that has been received is in response to
17188 the correct question. For example, if the response is just a new domain, the
17189 following could be used:
17190 .code
17191 response_pattern = ^([^@]+)$
17192 reroute = $local_part@$1
17193 .endd
17194
17195 .option timeout iplookup time 5s
17196 This specifies the amount of time to wait for a response from the remote
17197 machine. The same timeout is used for the &[connect()]& function for a TCP
17198 call. It does not apply to UDP.
17199
17200
17201
17202
17203 . ////////////////////////////////////////////////////////////////////////////
17204 . ////////////////////////////////////////////////////////////////////////////
17205
17206 .chapter "The manualroute router" "CHID7"
17207 .scindex IIDmanrou1 "&(manualroute)& router"
17208 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17209 .cindex "domain" "manually routing"
17210 The &(manualroute)& router is so-called because it provides a way of manually
17211 routing an address according to its domain. It is mainly used when you want to
17212 route addresses to remote hosts according to your own rules, bypassing the
17213 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17214 route to local transports, a facility that may be useful if you want to save
17215 messages for dial-in hosts in local files.
17216
17217 The &(manualroute)& router compares a list of domain patterns with the domain
17218 it is trying to route. If there is no match, the router declines. Each pattern
17219 has associated with it a list of hosts and some other optional data, which may
17220 include a transport. The combination of a pattern and its data is called a
17221 &"routing rule"&. For patterns that do not have an associated transport, the
17222 generic &%transport%& option must specify a transport, unless the router is
17223 being used purely for verification (see &%verify_only%&).
17224
17225 .vindex "&$host$&"
17226 In the case of verification, matching the domain pattern is sufficient for the
17227 router to accept the address. When actually routing an address for delivery,
17228 an address that matches a domain pattern is queued for the associated
17229 transport. If the transport is not a local one, a host list must be associated
17230 with the pattern; IP addresses are looked up for the hosts, and these are
17231 passed to the transport along with the mail address. For local transports, a
17232 host list is optional. If it is present, it is passed in &$host$& as a single
17233 text string.
17234
17235 The list of routing rules can be provided as an inline string in
17236 &%route_list%&, or the data can be obtained by looking up the domain in a file
17237 or database by setting &%route_data%&. Only one of these settings may appear in
17238 any one instance of &(manualroute)&. The format of routing rules is described
17239 below, following the list of private options.
17240
17241
17242 .section "Private options for manualroute" "SECTprioptman"
17243
17244 .cindex "options" "&(manualroute)& router"
17245 The private options for the &(manualroute)& router are as follows:
17246
17247 .option host_all_ignored manualroute string defer
17248 See &%host_find_failed%&.
17249
17250 .option host_find_failed manualroute string freeze
17251 This option controls what happens when &(manualroute)& tries to find an IP
17252 address for a host, and the host does not exist. The option can be set to one
17253 of the following values:
17254 .code
17255 decline
17256 defer
17257 fail
17258 freeze
17259 ignore
17260 pass
17261 .endd
17262 The default (&"freeze"&) assumes that this state is a serious configuration
17263 error. The difference between &"pass"& and &"decline"& is that the former
17264 forces the address to be passed to the next router (or the router defined by
17265 &%pass_router%&),
17266 .oindex "&%more%&"
17267 overriding &%no_more%&, whereas the latter passes the address to the next
17268 router only if &%more%& is true.
17269
17270 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17271 cannot be found. If all the hosts in the list are ignored, the behaviour is
17272 controlled by the &%host_all_ignored%& option. This takes the same values
17273 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17274
17275 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17276 state; if a host lookup gets a temporary error, delivery is deferred unless the
17277 generic &%pass_on_timeout%& option is set.
17278
17279
17280 .option hosts_randomize manualroute boolean false
17281 .cindex "randomized host list"
17282 .cindex "host" "list of; randomized"
17283 If this option is set, the order of the items in a host list in a routing rule
17284 is randomized each time the list is used, unless an option in the routing rule
17285 overrides (see below). Randomizing the order of a host list can be used to do
17286 crude load sharing. However, if more than one mail address is routed by the
17287 same router to the same host list, the host lists are considered to be the same
17288 (even though they may be randomized into different orders) for the purpose of
17289 deciding whether to batch the deliveries into a single SMTP transaction.
17290
17291 When &%hosts_randomize%& is true, a host list may be split
17292 into groups whose order is separately randomized. This makes it possible to
17293 set up MX-like behaviour. The boundaries between groups are indicated by an
17294 item that is just &`+`& in the host list. For example:
17295 .code
17296 route_list = * host1:host2:host3:+:host4:host5
17297 .endd
17298 The order of the first three hosts and the order of the last two hosts is
17299 randomized for each use, but the first three always end up before the last two.
17300 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17301 randomized host list is passed to an &(smtp)& transport that also has
17302 &%hosts_randomize set%&, the list is not re-randomized.
17303
17304
17305 .option route_data manualroute string&!! unset
17306 If this option is set, it must expand to yield the data part of a routing rule.
17307 Typically, the expansion string includes a lookup based on the domain. For
17308 example:
17309 .code
17310 route_data = ${lookup{$domain}dbm{/etc/routes}}
17311 .endd
17312 If the expansion is forced to fail, or the result is an empty string, the
17313 router declines. Other kinds of expansion failure cause delivery to be
17314 deferred.
17315
17316
17317 .option route_list manualroute "string list" unset
17318 This string is a list of routing rules, in the form defined below. Note that,
17319 unlike most string lists, the items are separated by semicolons. This is so
17320 that they may contain colon-separated host lists.
17321
17322
17323 .option same_domain_copy_routing manualroute boolean false
17324 .cindex "address" "copying routing"
17325 Addresses with the same domain are normally routed by the &(manualroute)&
17326 router to the same list of hosts. However, this cannot be presumed, because the
17327 router options and preconditions may refer to the local part of the address. By
17328 default, therefore, Exim routes each address in a message independently. DNS
17329 servers run caches, so repeated DNS lookups are not normally expensive, and in
17330 any case, personal messages rarely have more than a few recipients.
17331
17332 If you are running mailing lists with large numbers of subscribers at the same
17333 domain, and you are using a &(manualroute)& router which is independent of the
17334 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17335 lookups for identical domains in one message. In this case, when
17336 &(manualroute)& routes an address to a remote transport, any other unrouted
17337 addresses in the message that have the same domain are automatically given the
17338 same routing without processing them independently. However, this is only done
17339 if &%headers_add%& and &%headers_remove%& are unset.
17340
17341
17342
17343
17344 .section "Routing rules in route_list" "SECID120"
17345 The value of &%route_list%& is a string consisting of a sequence of routing
17346 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17347 entered as two semicolons. Alternatively, the list separator can be changed as
17348 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17349 Empty rules are ignored. The format of each rule is
17350 .display
17351 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17352 .endd
17353 The following example contains two rules, each with a simple domain pattern and
17354 no options:
17355 .code
17356 route_list = \
17357   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17358   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17359 .endd
17360 The three parts of a rule are separated by white space. The pattern and the
17361 list of hosts can be enclosed in quotes if necessary, and if they are, the
17362 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17363 single domain pattern, which is the only mandatory item in the rule. The
17364 pattern is in the same format as one item in a domain list (see section
17365 &<<SECTdomainlist>>&),
17366 except that it may not be the name of an interpolated file.
17367 That is, it may be wildcarded, or a regular expression, or a file or database
17368 lookup (with semicolons doubled, because of the use of semicolon as a separator
17369 in a &%route_list%&).
17370
17371 The rules in &%route_list%& are searched in order until one of the patterns
17372 matches the domain that is being routed. The list of hosts and then options are
17373 then used as described below. If there is no match, the router declines. When
17374 &%route_list%& is set, &%route_data%& must not be set.
17375
17376
17377
17378 .section "Routing rules in route_data" "SECID121"
17379 The use of &%route_list%& is convenient when there are only a small number of
17380 routing rules. For larger numbers, it is easier to use a file or database to
17381 hold the routing information, and use the &%route_data%& option instead.
17382 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17383 Most commonly, &%route_data%& is set as a string that contains an
17384 expansion lookup. For example, suppose we place two routing rules in a file
17385 like this:
17386 .code
17387 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17388 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17389 .endd
17390 This data can be accessed by setting
17391 .code
17392 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17393 .endd
17394 Failure of the lookup results in an empty string, causing the router to
17395 decline. However, you do not have to use a lookup in &%route_data%&. The only
17396 requirement is that the result of expanding the string is a list of hosts,
17397 possibly followed by options, separated by white space. The list of hosts must
17398 be enclosed in quotes if it contains white space.
17399
17400
17401
17402
17403 .section "Format of the list of hosts" "SECID122"
17404 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17405 always separately expanded before use. If the expansion fails, the router
17406 declines. The result of the expansion must be a colon-separated list of names
17407 and/or IP addresses, optionally also including ports. The format of each item
17408 in the list is described in the next section. The list separator can be changed
17409 as described in section &<<SECTlistconstruct>>&.
17410
17411 If the list of hosts was obtained from a &%route_list%& item, the following
17412 variables are set during its expansion:
17413
17414 .ilist
17415 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17416 If the domain was matched against a regular expression, the numeric variables
17417 &$1$&, &$2$&, etc. may be set. For example:
17418 .code
17419 route_list = ^domain(\d+)   host-$1.text.example
17420 .endd
17421 .next
17422 &$0$& is always set to the entire domain.
17423 .next
17424 &$1$& is also set when partial matching is done in a file lookup.
17425
17426 .next
17427 .vindex "&$value$&"
17428 If the pattern that matched the domain was a lookup item, the data that was
17429 looked up is available in the expansion variable &$value$&. For example:
17430 .code
17431 route_list = lsearch;;/some/file.routes  $value
17432 .endd
17433 .endlist
17434
17435 Note the doubling of the semicolon in the pattern that is necessary because
17436 semicolon is the default route list separator.
17437
17438
17439
17440 .section "Format of one host item" "SECTformatonehostitem"
17441 Each item in the list of hosts is either a host name or an IP address,
17442 optionally with an attached port number. When no port is given, an IP address
17443 is not enclosed in brackets. When a port is specified, it overrides the port
17444 specification on the transport. The port is separated from the name or address
17445 by a colon. This leads to some complications:
17446
17447 .ilist
17448 Because colon is the default separator for the list of hosts, either
17449 the colon that specifies a port must be doubled, or the list separator must
17450 be changed. The following two examples have the same effect:
17451 .code
17452 route_list = * "host1.tld::1225 : host2.tld::1226"
17453 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17454 .endd
17455 .next
17456 When IPv6 addresses are involved, it gets worse, because they contain
17457 colons of their own. To make this case easier, it is permitted to
17458 enclose an IP address (either v4 or v6) in square brackets if a port
17459 number follows. For example:
17460 .code
17461 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17462 .endd
17463 .endlist
17464
17465 .section "How the list of hosts is used" "SECThostshowused"
17466 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17467 the hosts is tried, in the order specified, when carrying out the SMTP
17468 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17469 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17470 transport.
17471
17472 Hosts may be listed by name or by IP address. An unadorned name in the list of
17473 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17474 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17475 records in the DNS. For example:
17476 .code
17477 route_list = *  x.y.z:p.q.r/MX:e.f.g
17478 .endd
17479 If this feature is used with a port specifier, the port must come last. For
17480 example:
17481 .code
17482 route_list = *  dom1.tld/mx::1225
17483 .endd
17484 If the &%hosts_randomize%& option is set, the order of the items in the list is
17485 randomized before any lookups are done. Exim then scans the list; for any name
17486 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17487 be an interface on the local host and the item is not the first in the list,
17488 Exim discards it and any subsequent items. If it is the first item, what
17489 happens is controlled by the
17490 .oindex "&%self%&" "in &(manualroute)& router"
17491 &%self%& option of the router.
17492
17493 A name on the list that is followed by &`/MX`& is replaced with the list of
17494 hosts obtained by looking up MX records for the name. This is always a DNS
17495 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17496 below) are not relevant here. The order of these hosts is determined by the
17497 preference values in the MX records, according to the usual rules. Because
17498 randomizing happens before the MX lookup, it does not affect the order that is
17499 defined by MX preferences.
17500
17501 If the local host is present in the sublist obtained from MX records, but is
17502 not the most preferred host in that list, it and any equally or less
17503 preferred hosts are removed before the sublist is inserted into the main list.
17504
17505 If the local host is the most preferred host in the MX list, what happens
17506 depends on where in the original list of hosts the &`/MX`& item appears. If it
17507 is not the first item (that is, there are previous hosts in the main list),
17508 Exim discards this name and any subsequent items in the main list.
17509
17510 If the MX item is first in the list of hosts, and the local host is the
17511 most preferred host, what happens is controlled by the &%self%& option of the
17512 router.
17513
17514 DNS failures when lookup up the MX records are treated in the same way as DNS
17515 failures when looking up IP addresses: &%pass_on_timeout%& and
17516 &%host_find_failed%& are used when relevant.
17517
17518 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17519 whether obtained from an MX lookup or not.
17520
17521
17522
17523 .section "How the options are used" "SECThowoptused"
17524 The options are a sequence of words; in practice no more than three are ever
17525 present. One of the words can be the name of a transport; this overrides the
17526 &%transport%& option on the router for this particular routing rule only. The
17527 other words (if present) control randomization of the list of hosts on a
17528 per-rule basis, and how the IP addresses of the hosts are to be found when
17529 routing to a remote transport. These options are as follows:
17530
17531 .ilist
17532 &%randomize%&: randomize the order of the hosts in this list, overriding the
17533 setting of &%hosts_randomize%& for this routing rule only.
17534 .next
17535 &%no_randomize%&: do not randomize the order of the hosts in this list,
17536 overriding the setting of &%hosts_randomize%& for this routing rule only.
17537 .next
17538 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17539 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17540 also look in &_/etc/hosts_& or other sources of information.
17541 .next
17542 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17543 no address records are found. If there is a temporary DNS error (such as a
17544 timeout), delivery is deferred.
17545 .endlist
17546
17547 For example:
17548 .code
17549 route_list = domain1  host1:host2:host3  randomize bydns;\
17550              domain2  host4:host5
17551 .endd
17552 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17553 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17554 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17555 or &[gethostbyname()]&, and the result of the lookup is the result of that
17556 call.
17557
17558 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17559 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17560 instead of TRY_AGAIN. That is why the default action is to try a DNS
17561 lookup first. Only if that gives a definite &"no such host"& is the local
17562 function called.
17563
17564
17565
17566 If no IP address for a host can be found, what happens is controlled by the
17567 &%host_find_failed%& option.
17568
17569 .vindex "&$host$&"
17570 When an address is routed to a local transport, IP addresses are not looked up.
17571 The host list is passed to the transport in the &$host$& variable.
17572
17573
17574
17575 .section "Manualroute examples" "SECID123"
17576 In some of the examples that follow, the presence of the &%remote_smtp%&
17577 transport, as defined in the default configuration file, is assumed:
17578
17579 .ilist
17580 .cindex "smart host" "example router"
17581 The &(manualroute)& router can be used to forward all external mail to a
17582 &'smart host'&. If you have set up, in the main part of the configuration, a
17583 named domain list that contains your local domains, for example:
17584 .code
17585 domainlist local_domains = my.domain.example
17586 .endd
17587 You can arrange for all other domains to be routed to a smart host by making
17588 your first router something like this:
17589 .code
17590 smart_route:
17591   driver = manualroute
17592   domains = !+local_domains
17593   transport = remote_smtp
17594   route_list = * smarthost.ref.example
17595 .endd
17596 This causes all non-local addresses to be sent to the single host
17597 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17598 they are tried in order
17599 (but you can use &%hosts_randomize%& to vary the order each time).
17600 Another way of configuring the same thing is this:
17601 .code
17602 smart_route:
17603   driver = manualroute
17604   transport = remote_smtp
17605   route_list = !+local_domains  smarthost.ref.example
17606 .endd
17607 There is no difference in behaviour between these two routers as they stand.
17608 However, they behave differently if &%no_more%& is added to them. In the first
17609 example, the router is skipped if the domain does not match the &%domains%&
17610 precondition; the following router is always tried. If the router runs, it
17611 always matches the domain and so can never decline. Therefore, &%no_more%&
17612 would have no effect. In the second case, the router is never skipped; it
17613 always runs. However, if it doesn't match the domain, it declines. In this case
17614 &%no_more%& would prevent subsequent routers from running.
17615
17616 .next
17617 .cindex "mail hub example"
17618 A &'mail hub'& is a host which receives mail for a number of domains via MX
17619 records in the DNS and delivers it via its own private routing mechanism. Often
17620 the final destinations are behind a firewall, with the mail hub being the one
17621 machine that can connect to machines both inside and outside the firewall. The
17622 &(manualroute)& router is usually used on a mail hub to route incoming messages
17623 to the correct hosts. For a small number of domains, the routing can be inline,
17624 using the &%route_list%& option, but for a larger number a file or database
17625 lookup is easier to manage.
17626
17627 If the domain names are in fact the names of the machines to which the mail is
17628 to be sent by the mail hub, the configuration can be quite simple. For
17629 example:
17630 .code
17631 hub_route:
17632   driver = manualroute
17633   transport = remote_smtp
17634   route_list = *.rhodes.tvs.example  $domain
17635 .endd
17636 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17637 whose names are the same as the mail domains. A similar approach can be taken
17638 if the host name can be obtained from the domain name by a string manipulation
17639 that the expansion facilities can handle. Otherwise, a lookup based on the
17640 domain can be used to find the host:
17641 .code
17642 through_firewall:
17643   driver = manualroute
17644   transport = remote_smtp
17645   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17646 .endd
17647 The result of the lookup must be the name or IP address of the host (or
17648 hosts) to which the address is to be routed. If the lookup fails, the route
17649 data is empty, causing the router to decline. The address then passes to the
17650 next router.
17651
17652 .next
17653 .cindex "batched SMTP output example"
17654 .cindex "SMTP" "batched outgoing; example"
17655 You can use &(manualroute)& to deliver messages to pipes or files in batched
17656 SMTP format for onward transportation by some other means. This is one way of
17657 storing mail for a dial-up host when it is not connected. The route list entry
17658 can be as simple as a single domain name in a configuration like this:
17659 .code
17660 save_in_file:
17661   driver = manualroute
17662   transport = batchsmtp_appendfile
17663   route_list = saved.domain.example
17664 .endd
17665 though often a pattern is used to pick up more than one domain. If there are
17666 several domains or groups of domains with different transport requirements,
17667 different transports can be listed in the routing information:
17668 .code
17669 save_in_file:
17670   driver = manualroute
17671   route_list = \
17672     *.saved.domain1.example  $domain  batch_appendfile; \
17673     *.saved.domain2.example  \
17674       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17675       batch_pipe
17676 .endd
17677 .vindex "&$domain$&"
17678 .vindex "&$host$&"
17679 The first of these just passes the domain in the &$host$& variable, which
17680 doesn't achieve much (since it is also in &$domain$&), but the second does a
17681 file lookup to find a value to pass, causing the router to decline to handle
17682 the address if the lookup fails.
17683
17684 .next
17685 .cindex "UUCP" "example of router for"
17686 Routing mail directly to UUCP software is a specific case of the use of
17687 &(manualroute)& in a gateway to another mail environment. This is an example of
17688 one way it can be done:
17689 .code
17690 # Transport
17691 uucp:
17692   driver = pipe
17693   user = nobody
17694   command = /usr/local/bin/uux -r - \
17695     ${substr_-5:$host}!rmail ${local_part}
17696   return_fail_output = true
17697
17698 # Router
17699 uucphost:
17700   transport = uucp
17701   driver = manualroute
17702   route_data = \
17703     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17704 .endd
17705 The file &_/usr/local/exim/uucphosts_& contains entries like
17706 .code
17707 darksite.ethereal.example:           darksite.UUCP
17708 .endd
17709 It can be set up more simply without adding and removing &".UUCP"& but this way
17710 makes clear the distinction between the domain name
17711 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17712 .endlist
17713 .ecindex IIDmanrou1
17714 .ecindex IIDmanrou2
17715
17716
17717
17718
17719
17720
17721
17722
17723 . ////////////////////////////////////////////////////////////////////////////
17724 . ////////////////////////////////////////////////////////////////////////////
17725
17726 .chapter "The queryprogram router" "CHAPdriverlast"
17727 .scindex IIDquerou1 "&(queryprogram)& router"
17728 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17729 .cindex "routing" "by external program"
17730 The &(queryprogram)& router routes an address by running an external command
17731 and acting on its output. This is an expensive way to route, and is intended
17732 mainly for use in lightly-loaded systems, or for performing experiments.
17733 However, if it is possible to use the precondition options (&%domains%&,
17734 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17735 be used in special cases, even on a busy host. There are the following private
17736 options:
17737 .cindex "options" "&(queryprogram)& router"
17738
17739 .option command queryprogram string&!! unset
17740 This option must be set. It specifies the command that is to be run. The
17741 command is split up into a command name and arguments, and then each is
17742 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17743 &<<CHAPpipetransport>>&).
17744
17745
17746 .option command_group queryprogram string unset
17747 .cindex "gid (group id)" "in &(queryprogram)& router"
17748 This option specifies a gid to be set when running the command while routing an
17749 address for deliver. It must be set if &%command_user%& specifies a numerical
17750 uid. If it begins with a digit, it is interpreted as the numerical value of the
17751 gid. Otherwise it is looked up using &[getgrnam()]&.
17752
17753
17754 .option command_user queryprogram string unset
17755 .cindex "uid (user id)" "for &(queryprogram)&"
17756 This option must be set. It specifies the uid which is set when running the
17757 command while routing an address for delivery. If the value begins with a digit,
17758 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
17759 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
17760 not set, a value for the gid also.
17761
17762 &*Warning:*& Changing uid and gid is possible only when Exim is running as
17763 root, which it does during a normal delivery in a conventional configuration.
17764 However, when an address is being verified during message reception, Exim is
17765 usually running as the Exim user, not as root. If the &(queryprogram)& router
17766 is called from a non-root process, Exim cannot change uid or gid before running
17767 the command. In this circumstance the command runs under the current uid and
17768 gid.
17769
17770
17771 .option current_directory queryprogram string /
17772 This option specifies an absolute path which is made the current directory
17773 before running the command.
17774
17775
17776 .option timeout queryprogram time 1h
17777 If the command does not complete within the timeout period, its process group
17778 is killed and the message is frozen. A value of zero time specifies no
17779 timeout.
17780
17781
17782 The standard output of the command is connected to a pipe, which is read when
17783 the command terminates. It should consist of a single line of output,
17784 containing up to five fields, separated by white space. The maximum length of
17785 the line is 1023 characters. Longer lines are silently truncated. The first
17786 field is one of the following words (case-insensitive):
17787
17788 .ilist
17789 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
17790 below).
17791 .next
17792 &'Decline'&: the router declines; pass the address to the next router, unless
17793 &%no_more%& is set.
17794 .next
17795 &'Fail'&: routing failed; do not pass the address to any more routers. Any
17796 subsequent text on the line is an error message. If the router is run as part
17797 of address verification during an incoming SMTP message, the message is
17798 included in the SMTP response.
17799 .next
17800 &'Defer'&: routing could not be completed at this time; try again later. Any
17801 subsequent text on the line is an error message which is logged. It is not
17802 included in any SMTP response.
17803 .next
17804 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
17805 .next
17806 &'Pass'&: pass the address to the next router (or the router specified by
17807 &%pass_router%&), overriding &%no_more%&.
17808 .next
17809 &'Redirect'&: the message is redirected. The remainder of the line is a list of
17810 new addresses, which are routed independently, starting with the first router,
17811 or the router specified by &%redirect_router%&, if set.
17812 .endlist
17813
17814 When the first word is &'accept'&, the remainder of the line consists of a
17815 number of keyed data values, as follows (split into two lines here, to fit on
17816 the page):
17817 .code
17818 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
17819 LOOKUP=byname|bydns DATA=<text>
17820 .endd
17821 The data items can be given in any order, and all are optional. If no transport
17822 is included, the transport specified by the generic &%transport%& option is
17823 used. The list of hosts and the lookup type are needed only if the transport is
17824 an &(smtp)& transport that does not itself supply a list of hosts.
17825
17826 The format of the list of hosts is the same as for the &(manualroute)& router.
17827 As well as host names and IP addresses with optional port numbers, as described
17828 in section &<<SECTformatonehostitem>>&, it may contain names followed by
17829 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
17830 (see section &<<SECThostshowused>>&).
17831
17832 If the lookup type is not specified, Exim behaves as follows when trying to
17833 find an IP address for each host: First, a DNS lookup is done. If this yields
17834 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
17835 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
17836 result of the lookup is the result of that call.
17837
17838 .vindex "&$address_data$&"
17839 If the DATA field is set, its value is placed in the &$address_data$&
17840 variable. For example, this return line
17841 .code
17842 accept hosts=x1.y.example:x2.y.example data="rule1"
17843 .endd
17844 routes the address to the default transport, passing a list of two hosts. When
17845 the transport runs, the string &"rule1"& is in &$address_data$&.
17846 .ecindex IIDquerou1
17847 .ecindex IIDquerou2
17848
17849
17850
17851
17852 . ////////////////////////////////////////////////////////////////////////////
17853 . ////////////////////////////////////////////////////////////////////////////
17854
17855 .chapter "The redirect router" "CHAPredirect"
17856 .scindex IIDredrou1 "&(redirect)& router"
17857 .scindex IIDredrou2 "routers" "&(redirect)&"
17858 .cindex "alias file" "in a &(redirect)& router"
17859 .cindex "address redirection" "&(redirect)& router"
17860 The &(redirect)& router handles several kinds of address redirection. Its most
17861 common uses are for resolving local part aliases from a central alias file
17862 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
17863 files, but it has many other potential uses. The incoming address can be
17864 redirected in several different ways:
17865
17866 .ilist
17867 It can be replaced by one or more new addresses which are themselves routed
17868 independently.
17869 .next
17870 It can be routed to be delivered to a given file or directory.
17871 .next
17872 It can be routed to be delivered to a specified pipe command.
17873 .next
17874 It can cause an automatic reply to be generated.
17875 .next
17876 It can be forced to fail, optionally with a custom error message.
17877 .next
17878 It can be temporarily deferred, optionally with a custom message.
17879 .next
17880 It can be discarded.
17881 .endlist
17882
17883 The generic &%transport%& option must not be set for &(redirect)& routers.
17884 However, there are some private options which define transports for delivery to
17885 files and pipes, and for generating autoreplies. See the &%file_transport%&,
17886 &%pipe_transport%& and &%reply_transport%& descriptions below.
17887
17888
17889
17890 .section "Redirection data" "SECID124"
17891 The router operates by interpreting a text string which it obtains either by
17892 expanding the contents of the &%data%& option, or by reading the entire
17893 contents of a file whose name is given in the &%file%& option. These two
17894 options are mutually exclusive. The first is commonly used for handling system
17895 aliases, in a configuration like this:
17896 .code
17897 system_aliases:
17898   driver = redirect
17899   data = ${lookup{$local_part}lsearch{/etc/aliases}}
17900 .endd
17901 If the lookup fails, the expanded string in this example is empty. When the
17902 expansion of &%data%& results in an empty string, the router declines. A forced
17903 expansion failure also causes the router to decline; other expansion failures
17904 cause delivery to be deferred.
17905
17906 A configuration using &%file%& is commonly used for handling users'
17907 &_.forward_& files, like this:
17908 .code
17909 userforward:
17910   driver = redirect
17911   check_local_user
17912   file = $home/.forward
17913   no_verify
17914 .endd
17915 If the file does not exist, or causes no action to be taken (for example, it is
17916 empty or consists only of comments), the router declines. &*Warning*&: This
17917 is not the case when the file contains syntactically valid items that happen to
17918 yield empty addresses, for example, items containing only RFC 2822 address
17919 comments.
17920
17921
17922
17923 .section "Forward files and address verification" "SECID125"
17924 .cindex "address redirection" "while verifying"
17925 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
17926 &_.forward_& files, as in the example above. There are two reasons for this:
17927
17928 .ilist
17929 When Exim is receiving an incoming SMTP message from a remote host, it is
17930 running under the Exim uid, not as root. Exim is unable to change uid to read
17931 the file as the user, and it may not be able to read it as the Exim user. So in
17932 practice the router may not be able to operate.
17933 .next
17934 However, even when the router can operate, the existence of a &_.forward_& file
17935 is unimportant when verifying an address. What should be checked is whether the
17936 local part is a valid user name or not. Cutting out the redirection processing
17937 saves some resources.
17938 .endlist
17939
17940
17941
17942
17943
17944
17945 .section "Interpreting redirection data" "SECID126"
17946 .cindex "Sieve filter" "specifying in redirection data"
17947 .cindex "filter" "specifying in redirection data"
17948 The contents of the data string, whether obtained from &%data%& or &%file%&,
17949 can be interpreted in two different ways:
17950
17951 .ilist
17952 If the &%allow_filter%& option is set true, and the data begins with the text
17953 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
17954 &'filtering'& instructions in the form of an Exim or Sieve filter file,
17955 respectively. Details of the syntax and semantics of filter files are described
17956 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
17957 document is intended for use by end users.
17958 .next
17959 Otherwise, the data must be a comma-separated list of redirection items, as
17960 described in the next section.
17961 .endlist
17962
17963 When a message is redirected to a file (a &"mail folder"&), the file name given
17964 in a non-filter redirection list must always be an absolute path. A filter may
17965 generate a relative path &-- how this is handled depends on the transport's
17966 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
17967 for the &(appendfile)& transport.
17968
17969
17970
17971 .section "Items in a non-filter redirection list" "SECTitenonfilred"
17972 .cindex "address redirection" "non-filter list items"
17973 When the redirection data is not an Exim or Sieve filter, for example, if it
17974 comes from a conventional alias or forward file, it consists of a list of
17975 addresses, file names, pipe commands, or certain special items (see section
17976 &<<SECTspecitredli>>& below). The special items can be individually enabled or
17977 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
17978 depending on their default values. The items in the list are separated by
17979 commas or newlines.
17980 If a comma is required in an item, the entire item must be enclosed in double
17981 quotes.
17982
17983 Lines starting with a # character are comments, and are ignored, and # may
17984 also appear following a comma, in which case everything between the # and the
17985 next newline character is ignored.
17986
17987 If an item is entirely enclosed in double quotes, these are removed. Otherwise
17988 double quotes are retained because some forms of mail address require their use
17989 (but never to enclose the entire address). In the following description,
17990 &"item"& refers to what remains after any surrounding double quotes have been
17991 removed.
17992
17993 .vindex "&$local_part$&"
17994 &*Warning*&: If you use an Exim expansion to construct a redirection address,
17995 and the expansion contains a reference to &$local_part$&, you should make use
17996 of the &%quote_local_part%& expansion operator, in case the local part contains
17997 special characters. For example, to redirect all mail for the domain
17998 &'obsolete.example'&, retaining the existing local part, you could use this
17999 setting:
18000 .code
18001 data = ${quote_local_part:$local_part}@newdomain.example
18002 .endd
18003
18004
18005 .section "Redirecting to a local mailbox" "SECTredlocmai"
18006 .cindex "routing" "loops in"
18007 .cindex "loop" "while routing, avoidance of"
18008 .cindex "address redirection" "to local mailbox"
18009 A redirection item may safely be the same as the address currently under
18010 consideration. This does not cause a routing loop, because a router is
18011 automatically skipped if any ancestor of the address that is being processed
18012 is the same as the current address and was processed by the current router.
18013 Such an address is therefore passed to the following routers, so it is handled
18014 as if there were no redirection. When making this loop-avoidance test, the
18015 complete local part, including any prefix or suffix, is used.
18016
18017 .cindex "address redirection" "local part without domain"
18018 Specifying the same local part without a domain is a common usage in personal
18019 filter files when the user wants to have messages delivered to the local
18020 mailbox and also forwarded elsewhere. For example, the user whose login is
18021 &'cleo'& might have a &_.forward_& file containing this:
18022 .code
18023 cleo, cleopatra@egypt.example
18024 .endd
18025 .cindex "backslash in alias file"
18026 .cindex "alias file" "backslash in"
18027 For compatibility with other MTAs, such unqualified local parts may be
18028 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18029 it does make a difference if more than one domain is being handled
18030 synonymously.
18031
18032 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18033 2822 address that does not include a domain, the item is qualified using the
18034 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18035 addresses are qualified using the value in &%qualify_recipient%&, but you can
18036 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18037
18038 Care must be taken if there are alias names for local users.
18039 Consider an MTA handling a single local domain where the system alias file
18040 contains:
18041 .code
18042 Sam.Reman: spqr
18043 .endd
18044 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18045 messages in the local mailbox, and also forward copies elsewhere. He creates
18046 this forward file:
18047 .code
18048 Sam.Reman, spqr@reme.elsewhere.example
18049 .endd
18050 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18051 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18052 second time round, because it has previously routed it,
18053 and the following routers presumably cannot handle the alias. The forward file
18054 should really contain
18055 .code
18056 spqr, spqr@reme.elsewhere.example
18057 .endd
18058 but because this is such a common error, the &%check_ancestor%& option (see
18059 below) exists to provide a way to get round it. This is normally set on a
18060 &(redirect)& router that is handling users' &_.forward_& files.
18061
18062
18063
18064 .section "Special items in redirection lists" "SECTspecitredli"
18065 In addition to addresses, the following types of item may appear in redirection
18066 lists (that is, in non-filter redirection data):
18067
18068 .ilist
18069 .cindex "pipe" "in redirection list"
18070 .cindex "address redirection" "to pipe"
18071 An item is treated as a pipe command if it begins with &"|"& and does not parse
18072 as a valid RFC 2822 address that includes a domain. A transport for running the
18073 command must be specified by the &%pipe_transport%& option.
18074 Normally, either the router or the transport specifies a user and a group under
18075 which to run the delivery. The default is to use the Exim user and group.
18076
18077 Single or double quotes can be used for enclosing the individual arguments of
18078 the pipe command; no interpretation of escapes is done for single quotes. If
18079 the command contains a comma character, it is necessary to put the whole item
18080 in double quotes, for example:
18081 .code
18082 "|/some/command ready,steady,go"
18083 .endd
18084 since items in redirection lists are terminated by commas. Do not, however,
18085 quote just the command. An item such as
18086 .code
18087 |"/some/command ready,steady,go"
18088 .endd
18089 is interpreted as a pipe with a rather strange command name, and no arguments.
18090
18091 .next
18092 .cindex "file" "in redirection list"
18093 .cindex "address redirection" "to file"
18094 An item is interpreted as a path name if it begins with &"/"& and does not
18095 parse as a valid RFC 2822 address that includes a domain. For example,
18096 .code
18097 /home/world/minbari
18098 .endd
18099 is treated as a file name, but
18100 .code
18101 /s=molari/o=babylon/@x400gate.way
18102 .endd
18103 is treated as an address. For a file name, a transport must be specified using
18104 the &%file_transport%& option. However, if the generated path name ends with a
18105 forward slash character, it is interpreted as a directory name rather than a
18106 file name, and &%directory_transport%& is used instead.
18107
18108 Normally, either the router or the transport specifies a user and a group under
18109 which to run the delivery. The default is to use the Exim user and group.
18110
18111 .cindex "&_/dev/null_&"
18112 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18113 bypassed at a high level, and the log entry shows &"**bypassed**"&
18114 instead of a transport name. In this case the user and group are not used.
18115
18116 .next
18117 .cindex "included address list"
18118 .cindex "address redirection" "included external list"
18119 If an item is of the form
18120 .code
18121 :include:<path name>
18122 .endd
18123 a list of further items is taken from the given file and included at that
18124 point. &*Note*&: Such a file can not be a filter file; it is just an
18125 out-of-line addition to the list. The items in the included list are separated
18126 by commas or newlines and are not subject to expansion. If this is the first
18127 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18128 the alias name. This example is incorrect:
18129 .code
18130 list1    :include:/opt/lists/list1
18131 .endd
18132 It must be given as
18133 .code
18134 list1:   :include:/opt/lists/list1
18135 .endd
18136 .next
18137 .cindex "address redirection" "to black hole"
18138 Sometimes you want to throw away mail to a particular local part. Making the
18139 &%data%& option expand to an empty string does not work, because that causes
18140 the router to decline. Instead, the alias item
18141 .cindex "black hole"
18142 .cindex "abandoning mail"
18143 &':blackhole:'& can be used. It does what its name implies. No delivery is
18144 done, and no error message is generated. This has the same effect as specifing
18145 &_/dev/null_& as a destination, but it can be independently disabled.
18146
18147 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18148 delivery is done for the original local part, even if other redirection items
18149 are present. If you are generating a multi-item list (for example, by reading a
18150 database) and need the ability to provide a no-op item, you must use
18151 &_/dev/null_&.
18152
18153 .next
18154 .cindex "delivery" "forcing failure"
18155 .cindex "delivery" "forcing deferral"
18156 .cindex "failing delivery" "forcing"
18157 .cindex "deferred delivery, forcing"
18158 .cindex "customizing" "failure message"
18159 An attempt to deliver a particular address can be deferred or forced to fail by
18160 redirection items of the form
18161 .code
18162 :defer:
18163 :fail:
18164 .endd
18165 respectively. When a redirection list contains such an item, it applies
18166 to the entire redirection; any other items in the list are ignored. Any
18167 text following &':fail:'& or &':defer:'& is placed in the error text
18168 associated with the failure. For example, an alias file might contain:
18169 .code
18170 X.Employee:  :fail: Gone away, no forwarding address
18171 .endd
18172 In the case of an address that is being verified from an ACL or as the subject
18173 of a
18174 .cindex "VRFY" "error text, display of"
18175 VRFY command, the text is included in the SMTP error response by
18176 default.
18177 .cindex "EXPN" "error text, display of"
18178 The text is not included in the response to an EXPN command. In non-SMTP cases
18179 the text is included in the error message that Exim generates.
18180
18181 .cindex "SMTP" "error codes"
18182 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18183 &':fail:'&. However, if the message starts with three digits followed by a
18184 space, optionally followed by an extended code of the form &'n.n.n'&, also
18185 followed by a space, and the very first digit is the same as the default error
18186 code, the code from the message is used instead. If the very first digit is
18187 incorrect, a panic error is logged, and the default code is used. You can
18188 suppress the use of the supplied code in a redirect router by setting the
18189 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18190 ignored.
18191
18192 .vindex "&$acl_verify_message$&"
18193 In an ACL, an explicitly provided message overrides the default, but the
18194 default message is available in the variable &$acl_verify_message$& and can
18195 therefore be included in a custom message if this is desired.
18196
18197 Normally the error text is the rest of the redirection list &-- a comma does
18198 not terminate it &-- but a newline does act as a terminator. Newlines are not
18199 normally present in alias expansions. In &(lsearch)& lookups they are removed
18200 as part of the continuation process, but they may exist in other kinds of
18201 lookup and in &':include:'& files.
18202
18203 During routing for message delivery (as opposed to verification), a redirection
18204 containing &':fail:'& causes an immediate failure of the incoming address,
18205 whereas &':defer:'& causes the message to remain on the queue so that a
18206 subsequent delivery attempt can happen at a later time. If an address is
18207 deferred for too long, it will ultimately fail, because the normal retry
18208 rules still apply.
18209
18210 .next
18211 .cindex "alias file" "exception to default"
18212 Sometimes it is useful to use a single-key search type with a default (see
18213 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18214 for exceptions to the default. These can be handled by aliasing them to
18215 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18216 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18217 results in an empty redirection list has the same effect.
18218 .endlist
18219
18220
18221 .section "Duplicate addresses" "SECTdupaddr"
18222 .cindex "duplicate addresses"
18223 .cindex "address duplicate, discarding"
18224 .cindex "pipe" "duplicated"
18225 Exim removes duplicate addresses from the list to which it is delivering, so as
18226 to deliver just one copy to each address. This does not apply to deliveries
18227 routed to pipes by different immediate parent addresses, but an indirect
18228 aliasing scheme of the type
18229 .code
18230 pipe:       |/some/command $local_part
18231 localpart1: pipe
18232 localpart2: pipe
18233 .endd
18234 does not work with a message that is addressed to both local parts, because
18235 when the second is aliased to the intermediate local part &"pipe"& it gets
18236 discarded as being the same as a previously handled address. However, a scheme
18237 such as
18238 .code
18239 localpart1: |/some/command $local_part
18240 localpart2: |/some/command $local_part
18241 .endd
18242 does result in two different pipe deliveries, because the immediate parents of
18243 the pipes are distinct.
18244
18245
18246
18247 .section "Repeated redirection expansion" "SECID128"
18248 .cindex "repeated redirection expansion"
18249 .cindex "address redirection" "repeated for each delivery attempt"
18250 When a message cannot be delivered to all of its recipients immediately,
18251 leading to two or more delivery attempts, redirection expansion is carried out
18252 afresh each time for those addresses whose children were not all previously
18253 delivered. If redirection is being used as a mailing list, this can lead to new
18254 members of the list receiving copies of old messages. The &%one_time%& option
18255 can be used to avoid this.
18256
18257
18258 .section "Errors in redirection lists" "SECID129"
18259 .cindex "address redirection" "errors"
18260 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18261 error is skipped, and an entry is written to the main log. This may be useful
18262 for mailing lists that are automatically managed. Otherwise, if an error is
18263 detected while generating the list of new addresses, the original address is
18264 deferred. See also &%syntax_errors_to%&.
18265
18266
18267
18268 .section "Private options for the redirect router" "SECID130"
18269
18270 .cindex "options" "&(redirect)& router"
18271 The private options for the &(redirect)& router are as follows:
18272
18273
18274 .option allow_defer redirect boolean false
18275 Setting this option allows the use of &':defer:'& in non-filter redirection
18276 data, or the &%defer%& command in an Exim filter file.
18277
18278
18279 .option allow_fail redirect boolean false
18280 .cindex "failing delivery" "from filter"
18281 If this option is true, the &':fail:'& item can be used in a redirection list,
18282 and the &%fail%& command may be used in an Exim filter file.
18283
18284
18285 .option allow_filter redirect boolean false
18286 .cindex "filter" "enabling use of"
18287 .cindex "Sieve filter" "enabling use of"
18288 Setting this option allows Exim to interpret redirection data that starts with
18289 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18290 are some features of Exim filter files that some administrators may wish to
18291 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18292
18293 It is also possible to lock out Exim filters or Sieve filters while allowing
18294 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18295
18296
18297 The filter is run using the uid and gid set by the generic &%user%& and
18298 &%group%& options. These take their defaults from the password data if
18299 &%check_local_user%& is set, so in the normal case of users' personal filter
18300 files, the filter is run as the relevant user. When &%allow_filter%& is set
18301 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18302
18303
18304
18305 .option allow_freeze redirect boolean false
18306 .cindex "freezing messages" "allowing in filter"
18307 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18308 This command is more normally encountered in system filters, and is disabled by
18309 default for redirection filters because it isn't something you usually want to
18310 let ordinary users do.
18311
18312
18313
18314 .option check_ancestor redirect boolean false
18315 This option is concerned with handling generated addresses that are the same
18316 as some address in the list of redirection ancestors of the current address.
18317 Although it is turned off by default in the code, it is set in the default
18318 configuration file for handling users' &_.forward_& files. It is recommended
18319 for this use of the &(redirect)& router.
18320
18321 When &%check_ancestor%& is set, if a generated address (including the domain)
18322 is the same as any ancestor of the current address, it is replaced by a copy of
18323 the current address. This helps in the case where local part A is aliased to B,
18324 and B has a &_.forward_& file pointing back to A. For example, within a single
18325 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18326 &_&~jb/.forward_& contains:
18327 .code
18328 \Joe.Bloggs, <other item(s)>
18329 .endd
18330 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18331 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18332 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18333 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18334 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18335 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18336 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18337 original address. See also the &%repeat_use%& option below.
18338
18339
18340 .option check_group redirect boolean "see below"
18341 When the &%file%& option is used, the group owner of the file is checked only
18342 when this option is set. The permitted groups are those listed in the
18343 &%owngroups%& option, together with the user's default group if
18344 &%check_local_user%& is set. If the file has the wrong group, routing is
18345 deferred. The default setting for this option is true if &%check_local_user%&
18346 is set and the &%modemask%& option permits the group write bit, or if the
18347 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18348
18349
18350
18351 .option check_owner redirect boolean "see below"
18352 When the &%file%& option is used, the owner of the file is checked only when
18353 this option is set. If &%check_local_user%& is set, the local user is
18354 permitted; otherwise the owner must be one of those listed in the &%owners%&
18355 option. The default value for this option is true if &%check_local_user%& or
18356 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18357
18358
18359 .option data redirect string&!! unset
18360 This option is mutually exclusive with &%file%&. One or other of them must be
18361 set, but not both. The contents of &%data%& are expanded, and then used as the
18362 list of forwarding items, or as a set of filtering instructions. If the
18363 expansion is forced to fail, or the result is an empty string or a string that
18364 has no effect (consists entirely of comments), the router declines.
18365
18366 When filtering instructions are used, the string must begin with &"#Exim
18367 filter"&, and all comments in the string, including this initial one, must be
18368 terminated with newline characters. For example:
18369 .code
18370 data = #Exim filter\n\
18371        if $h_to: contains Exim then save $home/mail/exim endif
18372 .endd
18373 If you are reading the data from a database where newlines cannot be included,
18374 you can use the &${sg}$& expansion item to turn the escape string of your
18375 choice into a newline.
18376
18377
18378 .option directory_transport redirect string&!! unset
18379 A &(redirect)& router sets up a direct delivery to a directory when a path name
18380 ending with a slash is specified as a new &"address"&. The transport used is
18381 specified by this option, which, after expansion, must be the name of a
18382 configured transport. This should normally be an &(appendfile)& transport.
18383
18384
18385 .option file redirect string&!! unset
18386 This option specifies the name of a file that contains the redirection data. It
18387 is mutually exclusive with the &%data%& option. The string is expanded before
18388 use; if the expansion is forced to fail, the router declines. Other expansion
18389 failures cause delivery to be deferred. The result of a successful expansion
18390 must be an absolute path. The entire file is read and used as the redirection
18391 data. If the data is an empty string or a string that has no effect (consists
18392 entirely of comments), the router declines.
18393
18394 .cindex "NFS" "checking for file existence"
18395 If the attempt to open the file fails with a &"does not exist"& error, Exim
18396 runs a check on the containing directory,
18397 unless &%ignore_enotdir%& is true (see below).
18398 If the directory does not appear to exist, delivery is deferred. This can
18399 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18400 is a mount problem. If the containing directory does exist, but the file does
18401 not, the router declines.
18402
18403
18404 .option file_transport redirect string&!! unset
18405 .vindex "&$address_file$&"
18406 A &(redirect)& router sets up a direct delivery to a file when a path name not
18407 ending in a slash is specified as a new &"address"&. The transport used is
18408 specified by this option, which, after expansion, must be the name of a
18409 configured transport. This should normally be an &(appendfile)& transport. When
18410 it is running, the file name is in &$address_file$&.
18411
18412
18413 .option filter_prepend_home redirect boolean true
18414 When this option is true, if a &(save)& command in an Exim filter specifies a
18415 relative path, and &$home$& is defined, it is automatically prepended to the
18416 relative path. If this option is set false, this action does not happen. The
18417 relative path is then passed to the transport unmodified.
18418
18419
18420 .option forbid_blackhole redirect boolean false
18421 If this option is true, the &':blackhole:'& item may not appear in a
18422 redirection list.
18423
18424
18425 .option forbid_exim_filter redirect boolean false
18426 If this option is set true, only Sieve filters are permitted when
18427 &%allow_filter%& is true.
18428
18429
18430
18431
18432 .option forbid_file redirect boolean false
18433 .cindex "delivery" "to file; forbidding"
18434 .cindex "Sieve filter" "forbidding delivery to a file"
18435 .cindex "Sieve filter" "&""keep""& facility; disabling"
18436 If this option is true, this router may not generate a new address that
18437 specifies delivery to a local file or directory, either from a filter or from a
18438 conventional forward file. This option is forced to be true if &%one_time%& is
18439 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18440 locks out the Sieve's &"keep"& facility.
18441
18442
18443 .option forbid_filter_dlfunc redirect boolean false
18444 .cindex "filter" "locking out certain features"
18445 If this option is true, string expansions in Exim filters are not allowed to
18446 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18447 functions.
18448
18449 .option forbid_filter_existstest redirect boolean false
18450 .cindex "expansion" "statting a file"
18451 If this option is true, string expansions in Exim filters are not allowed to
18452 make use of the &%exists%& condition or the &%stat%& expansion item.
18453
18454 .option forbid_filter_logwrite redirect boolean false
18455 If this option is true, use of the logging facility in Exim filters is not
18456 permitted. Logging is in any case available only if the filter is being run
18457 under some unprivileged uid (which is normally the case for ordinary users'
18458 &_.forward_& files).
18459
18460
18461 .option forbid_filter_lookup redirect boolean false
18462 If this option is true, string expansions in Exim filter files are not allowed
18463 to make use of &%lookup%& items.
18464
18465
18466 .option forbid_filter_perl redirect boolean false
18467 This option has an effect only if Exim is built with embedded Perl support. If
18468 it is true, string expansions in Exim filter files are not allowed to make use
18469 of the embedded Perl support.
18470
18471
18472 .option forbid_filter_readfile redirect boolean false
18473 If this option is true, string expansions in Exim filter files are not allowed
18474 to make use of &%readfile%& items.
18475
18476
18477 .option forbid_filter_readsocket redirect boolean false
18478 If this option is true, string expansions in Exim filter files are not allowed
18479 to make use of &%readsocket%& items.
18480
18481
18482 .option forbid_filter_reply redirect boolean false
18483 If this option is true, this router may not generate an automatic reply
18484 message. Automatic replies can be generated only from Exim or Sieve filter
18485 files, not from traditional forward files. This option is forced to be true if
18486 &%one_time%& is set.
18487
18488
18489 .option forbid_filter_run redirect boolean false
18490 If this option is true, string expansions in Exim filter files are not allowed
18491 to make use of &%run%& items.
18492
18493
18494 .option forbid_include redirect boolean false
18495 If this option is true, items of the form
18496 .code
18497 :include:<path name>
18498 .endd
18499 are not permitted in non-filter redirection lists.
18500
18501
18502 .option forbid_pipe redirect boolean false
18503 .cindex "delivery" "to pipe; forbidding"
18504 If this option is true, this router may not generate a new address which
18505 specifies delivery to a pipe, either from an Exim filter or from a conventional
18506 forward file. This option is forced to be true if &%one_time%& is set.
18507
18508
18509 .option forbid_sieve_filter redirect boolean false
18510 If this option is set true, only Exim filters are permitted when
18511 &%allow_filter%& is true.
18512
18513
18514 .cindex "SMTP" "error codes"
18515 .option forbid_smtp_code redirect boolean false
18516 If this option is set true, any SMTP error codes that are present at the start
18517 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18518 the default codes (451 and 550, respectively) are always used.
18519
18520
18521
18522
18523 .option hide_child_in_errmsg redirect boolean false
18524 .cindex "bounce message" "redirection details; suppressing"
18525 If this option is true, it prevents Exim from quoting a child address if it
18526 generates a bounce or delay message for it. Instead it says &"an address
18527 generated from <&'the top level address'&>"&. Of course, this applies only to
18528 bounces generated locally. If a message is forwarded to another host, &'its'&
18529 bounce may well quote the generated address.
18530
18531
18532 .option ignore_eacces redirect boolean false
18533 .cindex "EACCES"
18534 If this option is set and an attempt to open a redirection file yields the
18535 EACCES error (permission denied), the &(redirect)& router behaves as if the
18536 file did not exist.
18537
18538
18539 .option ignore_enotdir redirect boolean false
18540 .cindex "ENOTDIR"
18541 If this option is set and an attempt to open a redirection file yields the
18542 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18543 router behaves as if the file did not exist.
18544
18545 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18546 router that has the &%file%& option set discovers that the file does not exist
18547 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18548 against unmounted NFS directories. If the parent can not be statted, delivery
18549 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18550 is set, because that option tells Exim to ignore &"something on the path is not
18551 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18552 that some operating systems give ENOENT where others give ENOTDIR.
18553
18554
18555
18556 .option include_directory redirect string unset
18557 If this option is set, the path names of any &':include:'& items in a
18558 redirection list must start with this directory.
18559
18560
18561 .option modemask redirect "octal integer" 022
18562 This specifies mode bits which must not be set for a file specified by the
18563 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18564
18565
18566 .option one_time redirect boolean false
18567 .cindex "one-time aliasing/forwarding expansion"
18568 .cindex "alias file" "one-time expansion"
18569 .cindex "forward file" "one-time expansion"
18570 .cindex "mailing lists" "one-time expansion"
18571 .cindex "address redirection" "one-time expansion"
18572 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18573 files each time it tries to deliver a message causes a problem when one or more
18574 of the generated addresses fails be delivered at the first attempt. The problem
18575 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18576 but of what happens when the redirection list changes during the time that the
18577 message is on Exim's queue. This is particularly true in the case of mailing
18578 lists, where new subscribers might receive copies of messages that were posted
18579 before they subscribed.
18580
18581 If &%one_time%& is set and any addresses generated by the router fail to
18582 deliver at the first attempt, the failing addresses are added to the message as
18583 &"top level"& addresses, and the parent address that generated them is marked
18584 &"delivered"&. Thus, redirection does not happen again at the next delivery
18585 attempt.
18586
18587 &*Warning 1*&: Any header line addition or removal that is specified by this
18588 router would be lost if delivery did not succeed at the first attempt. For this
18589 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18590 permitted when &%one_time%& is set.
18591
18592 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18593 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18594 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18595
18596 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18597 &%one_time%&.
18598
18599 The original top-level address is remembered with each of the generated
18600 addresses, and is output in any log messages. However, any intermediate parent
18601 addresses are not recorded. This makes a difference to the log only if
18602 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18603 typically be used for mailing lists, where there is normally just one level of
18604 expansion.
18605
18606
18607 .option owners redirect "string list" unset
18608 .cindex "ownership" "alias file"
18609 .cindex "ownership" "forward file"
18610 .cindex "alias file" "ownership"
18611 .cindex "forward file" "ownership"
18612 This specifies a list of permitted owners for the file specified by &%file%&.
18613 This list is in addition to the local user when &%check_local_user%& is set.
18614 See &%check_owner%& above.
18615
18616
18617 .option owngroups redirect "string list" unset
18618 This specifies a list of permitted groups for the file specified by &%file%&.
18619 The list is in addition to the local user's primary group when
18620 &%check_local_user%& is set. See &%check_group%& above.
18621
18622
18623 .option pipe_transport redirect string&!! unset
18624 .vindex "&$address_pipe$&"
18625 A &(redirect)& router sets up a direct delivery to a pipe when a string
18626 starting with a vertical bar character is specified as a new &"address"&. The
18627 transport used is specified by this option, which, after expansion, must be the
18628 name of a configured transport. This should normally be a &(pipe)& transport.
18629 When the transport is run, the pipe command is in &$address_pipe$&.
18630
18631
18632 .option qualify_domain redirect string&!! unset
18633 .vindex "&$qualify_recipient$&"
18634 If this option is set, and an unqualified address (one without a domain) is
18635 generated, and that address would normally be qualified by the global setting
18636 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18637 expanding this string. If the expansion fails, the router declines. If you want
18638 to revert to the default, you can have the expansion generate
18639 &$qualify_recipient$&.
18640
18641 This option applies to all unqualified addresses generated by Exim filters,
18642 but for traditional &_.forward_& files, it applies only to addresses that are
18643 not preceded by a backslash. Sieve filters cannot generate unqualified
18644 addresses.
18645
18646 .option qualify_preserve_domain redirect boolean false
18647 .cindex "domain" "in redirection; preserving"
18648 .cindex "preserving domain in redirection"
18649 .cindex "address redirection" "domain; preserving"
18650 If this option is set, the router's local &%qualify_domain%& option must not be
18651 set (a configuration error occurs if it is). If an unqualified address (one
18652 without a domain) is generated, it is qualified with the domain of the parent
18653 address (the immediately preceding ancestor) instead of the global
18654 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18655 this applies whether or not the address is preceded by a backslash.
18656
18657
18658 .option repeat_use redirect boolean true
18659 If this option is set false, the router is skipped for a child address that has
18660 any ancestor that was routed by this router. This test happens before any of
18661 the other preconditions are tested. Exim's default anti-looping rules skip
18662 only when the ancestor is the same as the current address. See also
18663 &%check_ancestor%& above and the generic &%redirect_router%& option.
18664
18665
18666 .option reply_transport redirect string&!! unset
18667 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18668 &%vacation%& command is used in a filter file. The transport used is specified
18669 by this option, which, after expansion, must be the name of a configured
18670 transport. This should normally be an &(autoreply)& transport. Other transports
18671 are unlikely to do anything sensible or useful.
18672
18673
18674 .option rewrite redirect boolean true
18675 .cindex "address redirection" "disabling rewriting"
18676 If this option is set false, addresses generated by the router are not
18677 subject to address rewriting. Otherwise, they are treated like new addresses
18678 and are rewritten according to the global rewriting rules.
18679
18680
18681 .option sieve_subaddress redirect string&!! unset
18682 The value of this option is passed to a Sieve filter to specify the
18683 :subaddress part of an address.
18684
18685 .option sieve_useraddress redirect string&!! unset
18686 The value of this option is passed to a Sieve filter to specify the :user part
18687 of an address. However, if it is unset, the entire original local part
18688 (including any prefix or suffix) is used for :user.
18689
18690
18691 .option sieve_vacation_directory redirect string&!! unset
18692 .cindex "Sieve filter" "vacation directory"
18693 To enable the &"vacation"& extension for Sieve filters, you must set
18694 &%sieve_vacation_directory%& to the directory where vacation databases are held
18695 (do not put anything else in that directory), and ensure that the
18696 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18697 needs their own directory; Exim will create it if necessary.
18698
18699
18700
18701 .option skip_syntax_errors redirect boolean false
18702 .cindex "forward file" "broken"
18703 .cindex "address redirection" "broken files"
18704 .cindex "alias file" "broken"
18705 .cindex "broken alias or forward files"
18706 .cindex "ignoring faulty addresses"
18707 .cindex "skipping faulty addresses"
18708 .cindex "error" "skipping bad syntax"
18709 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18710 non-filter redirection data are skipped, and each failing address is logged. If
18711 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18712 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18713 are expanded and placed at the head of the error message generated by
18714 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18715 be the same address as the generic &%errors_to%& option. The
18716 &%skip_syntax_errors%& option is often used when handling mailing lists.
18717
18718 If all the addresses in a redirection list are skipped because of syntax
18719 errors, the router declines to handle the original address, and it is passed to
18720 the following routers.
18721
18722 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18723 error in the filter causes filtering to be abandoned without any action being
18724 taken. The incident is logged, and the router declines to handle the address,
18725 so it is passed to the following routers.
18726
18727 .cindex "Sieve filter" "syntax errors in"
18728 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18729 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18730 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18731
18732 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18733 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18734 option, used with an address that does not get redirected, can be used to
18735 notify users of these errors, by means of a router like this:
18736 .code
18737 userforward:
18738   driver = redirect
18739   allow_filter
18740   check_local_user
18741   file = $home/.forward
18742   file_transport = address_file
18743   pipe_transport = address_pipe
18744   reply_transport = address_reply
18745   no_verify
18746   skip_syntax_errors
18747   syntax_errors_to = real-$local_part@$domain
18748   syntax_errors_text = \
18749    This is an automatically generated message. An error has\n\
18750    been found in your .forward file. Details of the error are\n\
18751    reported below. While this error persists, you will receive\n\
18752    a copy of this message for every message that is addressed\n\
18753    to you. If your .forward file is a filter file, or if it is\n\
18754    a non-filter file containing no valid forwarding addresses,\n\
18755    a copy of each incoming message will be put in your normal\n\
18756    mailbox. If a non-filter file contains at least one valid\n\
18757    forwarding address, forwarding to the valid addresses will\n\
18758    happen, and those will be the only deliveries that occur.
18759 .endd
18760 You also need a router to ensure that local addresses that are prefixed by
18761 &`real-`& are recognized, but not forwarded or filtered. For example, you could
18762 put this immediately before the &(userforward)& router:
18763 .code
18764 real_localuser:
18765   driver = accept
18766   check_local_user
18767   local_part_prefix = real-
18768   transport = local_delivery
18769 .endd
18770 For security, it would probably be a good idea to restrict the use of this
18771 router to locally-generated messages, using a condition such as this:
18772 .code
18773   condition = ${if match {$sender_host_address}\
18774                          {\N^(|127\.0\.0\.1)$\N}}
18775 .endd
18776
18777
18778 .option syntax_errors_text redirect string&!! unset
18779 See &%skip_syntax_errors%& above.
18780
18781
18782 .option syntax_errors_to redirect string unset
18783 See &%skip_syntax_errors%& above.
18784 .ecindex IIDredrou1
18785 .ecindex IIDredrou2
18786
18787
18788
18789
18790
18791
18792 . ////////////////////////////////////////////////////////////////////////////
18793 . ////////////////////////////////////////////////////////////////////////////
18794
18795 .chapter "Environment for running local transports" "CHAPenvironment" &&&
18796          "Environment for local transports"
18797 .scindex IIDenvlotra1 "local transports" "environment for"
18798 .scindex IIDenvlotra2 "environment for local transports"
18799 .scindex IIDenvlotra3 "transport" "local; environment for"
18800 Local transports handle deliveries to files and pipes. (The &(autoreply)&
18801 transport can be thought of as similar to a pipe.) Exim always runs transports
18802 in subprocesses, under specified uids and gids. Typical deliveries to local
18803 mailboxes run under the uid and gid of the local user.
18804
18805 Exim also sets a specific current directory while running the transport; for
18806 some transports a home directory setting is also relevant. The &(pipe)&
18807 transport is the only one that sets up environment variables; see section
18808 &<<SECTpipeenv>>& for details.
18809
18810 The values used for the uid, gid, and the directories may come from several
18811 different places. In many cases, the router that handles the address associates
18812 settings with that address as a result of its &%check_local_user%&, &%group%&,
18813 or &%user%& options. However, values may also be given in the transport's own
18814 configuration, and these override anything that comes from the router.
18815
18816
18817
18818 .section "Concurrent deliveries" "SECID131"
18819 .cindex "concurrent deliveries"
18820 .cindex "simultaneous deliveries"
18821 If two different messages for the same local recipient arrive more or less
18822 simultaneously, the two delivery processes are likely to run concurrently. When
18823 the &(appendfile)& transport is used to write to a file, Exim applies locking
18824 rules to stop concurrent processes from writing to the same file at the same
18825 time.
18826
18827 However, when you use a &(pipe)& transport, it is up to you to arrange any
18828 locking that is needed. Here is a silly example:
18829 .code
18830 my_transport:
18831   driver = pipe
18832   command = /bin/sh -c 'cat >>/some/file'
18833 .endd
18834 This is supposed to write the message at the end of the file. However, if two
18835 messages arrive at the same time, the file will be scrambled. You can use the
18836 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
18837 file using the same algorithm that Exim itself uses.
18838
18839
18840
18841
18842 .section "Uids and gids" "SECTenvuidgid"
18843 .cindex "local transports" "uid and gid"
18844 .cindex "transport" "local; uid and gid"
18845 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
18846 overrides any group that the router set in the address, even if &%user%& is not
18847 set for the transport. This makes it possible, for example, to run local mail
18848 delivery under the uid of the recipient (set by the router), but in a special
18849 group (set by the transport). For example:
18850 .code
18851 # Routers ...
18852 # User/group are set by check_local_user in this router
18853 local_users:
18854   driver = accept
18855   check_local_user
18856   transport = group_delivery
18857
18858 # Transports ...
18859 # This transport overrides the group
18860 group_delivery:
18861   driver = appendfile
18862   file = /var/spool/mail/$local_part
18863   group = mail
18864 .endd
18865 If &%user%& is set for a transport, its value overrides what is set in the
18866 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
18867 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
18868 set.
18869
18870 .oindex "&%initgroups%&"
18871 When the uid is taken from the transport's configuration, the &[initgroups()]&
18872 function is called for the groups associated with that uid if the
18873 &%initgroups%& option is set for the transport. When the uid is not specified
18874 by the transport, but is associated with the address by a router, the option
18875 for calling &[initgroups()]& is taken from the router configuration.
18876
18877 .cindex "&(pipe)& transport" "uid for"
18878 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
18879 is set and &%user%& is not set, the uid of the process that called Exim to
18880 receive the message is used, and if &%group%& is not set, the corresponding
18881 original gid is also used.
18882
18883 This is the detailed preference order for obtaining a gid; the first of the
18884 following that is set is used:
18885
18886 .ilist
18887 A &%group%& setting of the transport;
18888 .next
18889 A &%group%& setting of the router;
18890 .next
18891 A gid associated with a user setting of the router, either as a result of
18892 &%check_local_user%& or an explicit non-numeric &%user%& setting;
18893 .next
18894 The group associated with a non-numeric &%user%& setting of the transport;
18895 .next
18896 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
18897 the uid is the creator's uid;
18898 .next
18899 The Exim gid if the Exim uid is being used as a default.
18900 .endlist
18901
18902 If, for example, the user is specified numerically on the router and there are
18903 no group settings, no gid is available. In this situation, an error occurs.
18904 This is different for the uid, for which there always is an ultimate default.
18905 The first of the following that is set is used:
18906
18907 .ilist
18908 A &%user%& setting of the transport;
18909 .next
18910 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
18911 .next
18912 A &%user%& setting of the router;
18913 .next
18914 A &%check_local_user%& setting of the router;
18915 .next
18916 The Exim uid.
18917 .endlist
18918
18919 Of course, an error will still occur if the uid that is chosen is on the
18920 &%never_users%& list.
18921
18922
18923
18924
18925
18926 .section "Current and home directories" "SECID132"
18927 .cindex "current directory for local transport"
18928 .cindex "home directory" "for local transport"
18929 .cindex "transport" "local; home directory for"
18930 .cindex "transport" "local; current directory for"
18931 Routers may set current and home directories for local transports by means of
18932 the &%transport_current_directory%& and &%transport_home_directory%& options.
18933 However, if the transport's &%current_directory%& or &%home_directory%& options
18934 are set, they override the router's values. In detail, the home directory
18935 for a local transport is taken from the first of these values that is set:
18936
18937 .ilist
18938 The &%home_directory%& option on the transport;
18939 .next
18940 The &%transport_home_directory%& option on the router;
18941 .next
18942 The password data if &%check_local_user%& is set on the router;
18943 .next
18944 The &%router_home_directory%& option on the router.
18945 .endlist
18946
18947 The current directory is taken from the first of these values that is set:
18948
18949 .ilist
18950 The &%current_directory%& option on the transport;
18951 .next
18952 The &%transport_current_directory%& option on the router.
18953 .endlist
18954
18955
18956 If neither the router nor the transport sets a current directory, Exim uses the
18957 value of the home directory, if it is set. Otherwise it sets the current
18958 directory to &_/_& before running a local transport.
18959
18960
18961
18962 .section "Expansion variables derived from the address" "SECID133"
18963 .vindex "&$domain$&"
18964 .vindex "&$local_part$&"
18965 .vindex "&$original_domain$&"
18966 Normally a local delivery is handling a single address, and in that case the
18967 variables such as &$domain$& and &$local_part$& are set during local
18968 deliveries. However, in some circumstances more than one address may be handled
18969 at once (for example, while writing batch SMTP for onward transmission by some
18970 other means). In this case, the variables associated with the local part are
18971 never set, &$domain$& is set only if all the addresses have the same domain,
18972 and &$original_domain$& is never set.
18973 .ecindex IIDenvlotra1
18974 .ecindex IIDenvlotra2
18975 .ecindex IIDenvlotra3
18976
18977
18978
18979
18980
18981
18982
18983 . ////////////////////////////////////////////////////////////////////////////
18984 . ////////////////////////////////////////////////////////////////////////////
18985
18986 .chapter "Generic options for transports" "CHAPtransportgeneric"
18987 .scindex IIDgenoptra1 "generic options" "transport"
18988 .scindex IIDgenoptra2 "options" "generic; for transports"
18989 .scindex IIDgenoptra3 "transport" "generic options for"
18990 The following generic options apply to all transports:
18991
18992
18993 .option body_only transports boolean false
18994 .cindex "transport" "body only"
18995 .cindex "message" "transporting body only"
18996 .cindex "body of message" "transporting"
18997 If this option is set, the message's headers are not transported. It is
18998 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
18999 or &(pipe)& transports, the settings of &%message_prefix%& and
19000 &%message_suffix%& should be checked, because this option does not
19001 automatically suppress them.
19002
19003
19004 .option current_directory transports string&!! unset
19005 .cindex "transport" "current directory for"
19006 This specifies the current directory that is to be set while running the
19007 transport, overriding any value that may have been set by the router.
19008 If the expansion fails for any reason, including forced failure, an error is
19009 logged, and delivery is deferred.
19010
19011
19012 .option disable_logging transports boolean false
19013 If this option is set true, nothing is logged for any
19014 deliveries by the transport or for any
19015 transport errors. You should not set this option unless you really, really know
19016 what you are doing.
19017
19018
19019 .option debug_print transports string&!! unset
19020 .cindex "testing" "variables in drivers"
19021 If this option is set and debugging is enabled (see the &%-d%& command line
19022 option), the string is expanded and included in the debugging output when the
19023 transport is run.
19024 If expansion of the string fails, the error message is written to the debugging
19025 output, and Exim carries on processing.
19026 This facility is provided to help with checking out the values of variables and
19027 so on when debugging driver configurations. For example, if a &%headers_add%&
19028 option is not working properly, &%debug_print%& could be used to output the
19029 variables it references. A newline is added to the text if it does not end with
19030 one.
19031
19032
19033 .option delivery_date_add transports boolean false
19034 .cindex "&'Delivery-date:'& header line"
19035 If this option is true, a &'Delivery-date:'& header is added to the message.
19036 This gives the actual time the delivery was made. As this is not a standard
19037 header, Exim has a configuration option (&%delivery_date_remove%&) which
19038 requests its removal from incoming messages, so that delivered messages can
19039 safely be resent to other recipients.
19040
19041
19042 .option driver transports string unset
19043 This specifies which of the available transport drivers is to be used.
19044 There is no default, and this option must be set for every transport.
19045
19046
19047 .option envelope_to_add transports boolean false
19048 .cindex "&'Envelope-to:'& header line"
19049 If this option is true, an &'Envelope-to:'& header is added to the message.
19050 This gives the original address(es) in the incoming envelope that caused this
19051 delivery to happen. More than one address may be present if the transport is
19052 configured to handle several addresses at once, or if more than one original
19053 address was redirected to the same final address. As this is not a standard
19054 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19055 its removal from incoming messages, so that delivered messages can safely be
19056 resent to other recipients.
19057
19058
19059 .option group transports string&!! "Exim group"
19060 .cindex "transport" "group; specifying"
19061 This option specifies a gid for running the transport process, overriding any
19062 value that the router supplies, and also overriding any value associated with
19063 &%user%& (see below).
19064
19065
19066 .option headers_add transports string&!! unset
19067 .cindex "header lines" "adding in transport"
19068 .cindex "transport" "header lines; adding"
19069 This option specifies a string of text that is expanded and added to the header
19070 portion of a message as it is transported, as described in section
19071 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19072 routers. If the result of the expansion is an empty string, or if the expansion
19073 is forced to fail, no action is taken. Other expansion failures are treated as
19074 errors and cause the delivery to be deferred.
19075
19076
19077
19078 .option headers_only transports boolean false
19079 .cindex "transport" "header lines only"
19080 .cindex "message" "transporting headers only"
19081 .cindex "header lines" "transporting"
19082 If this option is set, the message's body is not transported. It is mutually
19083 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19084 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19085 checked, since this option does not automatically suppress them.
19086
19087
19088 .option headers_remove transports string&!! unset
19089 .cindex "header lines" "removing"
19090 .cindex "transport" "header lines; removing"
19091 This option specifies a string that is expanded into a list of header names;
19092 these headers are omitted from the message as it is transported, as described
19093 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19094 routers. If the result of the expansion is an empty string, or if the expansion
19095 is forced to fail, no action is taken. Other expansion failures are treated as
19096 errors and cause the delivery to be deferred.
19097
19098
19099
19100 .option headers_rewrite transports string unset
19101 .cindex "transport" "header lines; rewriting"
19102 .cindex "rewriting" "at transport time"
19103 This option allows addresses in header lines to be rewritten at transport time,
19104 that is, as the message is being copied to its destination. The contents of the
19105 option are a colon-separated list of rewriting rules. Each rule is in exactly
19106 the same form as one of the general rewriting rules that are applied when a
19107 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19108 example,
19109 .code
19110 headers_rewrite = a@b c@d f : \
19111                   x@y w@z
19112 .endd
19113 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19114 &'w@z'& in all address-bearing header lines. The rules are applied to the
19115 header lines just before they are written out at transport time, so they affect
19116 only those copies of the message that pass through the transport. However, only
19117 the message's original header lines, and any that were added by a system
19118 filter, are rewritten. If a router or transport adds header lines, they are not
19119 affected by this option. These rewriting rules are &'not'& applied to the
19120 envelope. You can change the return path using &%return_path%&, but you cannot
19121 change envelope recipients at this time.
19122
19123
19124 .option home_directory transports string&!! unset
19125 .cindex "transport" "home directory for"
19126 .vindex "&$home$&"
19127 This option specifies a home directory setting for a local transport,
19128 overriding any value that may be set by the router. The home directory is
19129 placed in &$home$& while expanding the transport's private options. It is also
19130 used as the current directory if no current directory is set by the
19131 &%current_directory%& option on the transport or the
19132 &%transport_current_directory%& option on the router. If the expansion fails
19133 for any reason, including forced failure, an error is logged, and delivery is
19134 deferred.
19135
19136
19137 .option initgroups transports boolean false
19138 .cindex "additional groups"
19139 .cindex "groups" "additional"
19140 .cindex "transport" "group; additional"
19141 If this option is true and the uid for the delivery process is provided by the
19142 transport, the &[initgroups()]& function is called when running the transport
19143 to ensure that any additional groups associated with the uid are set up.
19144
19145
19146 .option message_size_limit transports string&!! 0
19147 .cindex "limit" "message size per transport"
19148 .cindex "size" "of message, limit"
19149 .cindex "transport" "message size; limiting"
19150 This option controls the size of messages passed through the transport. It is
19151 expanded before use; the result of the expansion must be a sequence of decimal
19152 digits, optionally followed by K or M. If the expansion fails for any reason,
19153 including forced failure, or if the result is not of the required form,
19154 delivery is deferred. If the value is greater than zero and the size of a
19155 message exceeds this limit, the address is failed. If there is any chance that
19156 the resulting bounce message could be routed to the same transport, you should
19157 ensure that &%return_size_limit%& is less than the transport's
19158 &%message_size_limit%&, as otherwise the bounce message will fail to get
19159 delivered.
19160
19161
19162
19163 .option rcpt_include_affixes transports boolean false
19164 .cindex "prefix" "for local part, including in envelope"
19165 .cindex "suffix for local part" "including in envelope"
19166 .cindex "local part" "prefix"
19167 .cindex "local part" "suffix"
19168 When this option is false (the default), and an address that has had any
19169 affixes (prefixes or suffixes) removed from the local part is delivered by any
19170 form of SMTP or LMTP, the affixes are not included. For example, if a router
19171 that contains
19172 .code
19173 local_part_prefix = *-
19174 .endd
19175 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19176 is delivered with
19177 .code
19178 RCPT TO:<xyz@some.domain>
19179 .endd
19180 This is also the case when an ACL-time callout is being used to verify a
19181 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19182 whole local part is included in the RCPT command. This option applies to BSMTP
19183 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19184 &(lmtp)& and &(smtp)& transports.
19185
19186
19187 .option retry_use_local_part transports boolean "see below"
19188 .cindex "hints database" "retry keys"
19189 When a delivery suffers a temporary failure, a retry record is created
19190 in Exim's hints database. For remote deliveries, the key for the retry record
19191 is based on the name and/or IP address of the failing remote host. For local
19192 deliveries, the key is normally the entire address, including both the local
19193 part and the domain. This is suitable for most common cases of local delivery
19194 temporary failure &-- for example, exceeding a mailbox quota should delay only
19195 deliveries to that mailbox, not to the whole domain.
19196
19197 However, in some special cases you may want to treat a temporary local delivery
19198 as a failure associated with the domain, and not with a particular local part.
19199 (For example, if you are storing all mail for some domain in files.) You can do
19200 this by setting &%retry_use_local_part%& false.
19201
19202 For all the local transports, its default value is true. For remote transports,
19203 the default value is false for tidiness, but changing the value has no effect
19204 on a remote transport in the current implementation.
19205
19206
19207 .option return_path transports string&!! unset
19208 .cindex "envelope sender"
19209 .cindex "transport" "return path; changing"
19210 .cindex "return path" "changing in transport"
19211 If this option is set, the string is expanded at transport time and replaces
19212 the existing return path (envelope sender) value in the copy of the message
19213 that is being delivered. An empty return path is permitted. This feature is
19214 designed for remote deliveries, where the value of this option is used in the
19215 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19216 only effect is to change the address that is placed in the &'Return-path:'&
19217 header line, if one is added to the message (see the next option).
19218
19219 &*Note:*& A changed return path is not logged unless you add
19220 &%return_path_on_delivery%& to the log selector.
19221
19222 .vindex "&$return_path$&"
19223 The expansion can refer to the existing value via &$return_path$&. This is
19224 either the message's envelope sender, or an address set by the
19225 &%errors_to%& option on a router. If the expansion is forced to fail, no
19226 replacement occurs; if it fails for another reason, delivery is deferred. This
19227 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19228 section &<<SECTverp>>&.
19229
19230 &*Note*&: If a delivery error is detected locally, including the case when a
19231 remote server rejects a message at SMTP time, the bounce message is not sent to
19232 the value of this option. It is sent to the previously set errors address.
19233 This defaults to the incoming sender address, but can be changed by setting
19234 &%errors_to%& in a router.
19235
19236
19237
19238 .option return_path_add transports boolean false
19239 .cindex "&'Return-path:'& header line"
19240 If this option is true, a &'Return-path:'& header is added to the message.
19241 Although the return path is normally available in the prefix line of BSD
19242 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19243 have easy access to it.
19244
19245 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19246 the delivery SMTP server makes the final delivery"&. This implies that this
19247 header should not be present in incoming messages. Exim has a configuration
19248 option, &%return_path_remove%&, which requests removal of this header from
19249 incoming messages, so that delivered messages can safely be resent to other
19250 recipients.
19251
19252
19253 .option shadow_condition transports string&!! unset
19254 See &%shadow_transport%& below.
19255
19256
19257 .option shadow_transport transports string unset
19258 .cindex "shadow transport"
19259 .cindex "transport" "shadow"
19260 A local transport may set the &%shadow_transport%& option to the name of
19261 another local transport. Shadow remote transports are not supported.
19262
19263 Whenever a delivery to the main transport succeeds, and either
19264 &%shadow_condition%& is unset, or its expansion does not result in the empty
19265 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19266 passed to the shadow transport, with the same delivery address or addresses. If
19267 expansion fails, no action is taken except that non-forced expansion failures
19268 cause a log line to be written.
19269
19270 The result of the shadow transport is discarded and does not affect the
19271 subsequent processing of the message. Only a single level of shadowing is
19272 provided; the &%shadow_transport%& option is ignored on any transport when it
19273 is running as a shadow. Options concerned with output from pipes are also
19274 ignored. The log line for the successful delivery has an item added on the end,
19275 of the form
19276 .code
19277 ST=<shadow transport name>
19278 .endd
19279 If the shadow transport did not succeed, the error message is put in
19280 parentheses afterwards. Shadow transports can be used for a number of different
19281 purposes, including keeping more detailed log information than Exim normally
19282 provides, and implementing automatic acknowledgment policies based on message
19283 headers that some sites insist on.
19284
19285
19286 .option transport_filter transports string&!! unset
19287 .cindex "transport" "filter"
19288 .cindex "filter" "transport filter"
19289 This option sets up a filtering (in the Unix shell sense) process for messages
19290 at transport time. It should not be confused with mail filtering as set up by
19291 individual users or via a system filter.
19292
19293 When the message is about to be written out, the command specified by
19294 &%transport_filter%& is started up in a separate, parallel process, and
19295 the entire message, including the header lines, is passed to it on its standard
19296 input (this in fact is done from a third process, to avoid deadlock). The
19297 command must be specified as an absolute path.
19298
19299 The lines of the message that are written to the transport filter are
19300 terminated by newline (&"\n"&). The message is passed to the filter before any
19301 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19302 lines beginning with a dot, and also before any processing implied by the
19303 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19304 &(pipe)& transports.
19305
19306 The standard error for the filter process is set to the same destination as its
19307 standard output; this is read and written to the message's ultimate
19308 destination. The process that writes the message to the filter, the
19309 filter itself, and the original process that reads the result and delivers it
19310 are all run in parallel, like a shell pipeline.
19311
19312 The filter can perform any transformations it likes, but of course should take
19313 care not to break RFC 2822 syntax. Exim does not check the result, except to
19314 test for a final newline when SMTP is in use. All messages transmitted over
19315 SMTP must end with a newline, so Exim supplies one if it is missing.
19316
19317 .cindex "content scanning" "per user"
19318 A transport filter can be used to provide content-scanning on a per-user basis
19319 at delivery time if the only required effect of the scan is to modify the
19320 message. For example, a content scan could insert a new header line containing
19321 a spam score. This could be interpreted by a filter in the user's MUA. It is
19322 not possible to discard a message at this stage.
19323
19324 .cindex "SMTP" "SIZE"
19325 A problem might arise if the filter increases the size of a message that is
19326 being sent down an SMTP connection. If the receiving SMTP server has indicated
19327 support for the SIZE parameter, Exim will have sent the size of the message
19328 at the start of the SMTP session. If what is actually sent is substantially
19329 more, the server might reject the message. This can be worked round by setting
19330 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19331 additions to the message, or to disable the use of SIZE altogether.
19332
19333 .vindex "&$pipe_addresses$&"
19334 The value of the &%transport_filter%& option is the command string for starting
19335 the filter, which is run directly from Exim, not under a shell. The string is
19336 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19337 Exim breaks it up into arguments and then expands each argument separately (see
19338 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19339 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19340 of arguments, one for each address that applies to this delivery. (This isn't
19341 an ideal name for this feature here, but as it was already implemented for the
19342 &(pipe)& transport, it seemed sensible not to change it.)
19343
19344 .vindex "&$host$&"
19345 .vindex "&$host_address$&"
19346 The expansion variables &$host$& and &$host_address$& are available when the
19347 transport is a remote one. They contain the name and IP address of the host to
19348 which the message is being sent. For example:
19349 .code
19350 transport_filter = /some/directory/transport-filter.pl \
19351   $host $host_address $sender_address $pipe_addresses
19352 .endd
19353
19354 Two problems arise if you want to use more complicated expansion items to
19355 generate transport filter commands, both of which due to the fact that the
19356 command is split up &'before'& expansion.
19357 .ilist
19358 If an expansion item contains white space, you must quote it, so that it is all
19359 part of the same command item. If the entire option setting is one such
19360 expansion item, you have to take care what kind of quoting you use. For
19361 example:
19362 .code
19363 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19364 .endd
19365 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19366 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19367 stripped by Exim when it read the option's value. When the value is used, if
19368 the single quotes were missing, the line would be split into two items,
19369 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19370 Exim tried to expand the first one.
19371 .next
19372 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19373 expansion cannot generate multiple arguments, or a command name followed by
19374 arguments. Consider this example:
19375 .code
19376 transport_filter = ${lookup{$host}lsearch{/a/file}\
19377                     {$value}{/bin/cat}}
19378 .endd
19379 The result of the lookup is interpreted as the name of the command, even
19380 if it contains white space. The simplest way round this is to use a shell:
19381 .code
19382 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19383                                {$value}{/bin/cat}}
19384 .endd
19385 .endlist
19386
19387 The filter process is run under the same uid and gid as the normal delivery.
19388 For remote deliveries this is the Exim uid/gid by default. The command should
19389 normally yield a zero return code. Transport filters are not supposed to fail.
19390 A non-zero code is taken to mean that the transport filter encountered some
19391 serious problem. Delivery of the message is deferred; the message remains on
19392 the queue and is tried again later. It is not possible to cause a message to be
19393 bounced from a transport filter.
19394
19395 If a transport filter is set on an autoreply transport, the original message is
19396 passed through the filter as it is being copied into the newly generated
19397 message, which happens if the &%return_message%& option is set.
19398
19399
19400 .option transport_filter_timeout transports time 5m
19401 .cindex "transport" "filter, timeout"
19402 When Exim is reading the output of a transport filter, it a applies a timeout
19403 that can be set by this option. Exceeding the timeout is normally treated as a
19404 temporary delivery failure. However, if a transport filter is used with a
19405 &(pipe)& transport, a timeout in the transport filter is treated in the same
19406 way as a timeout in the pipe command itself. By default, a timeout is a hard
19407 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19408 becomes a temporary error.
19409
19410
19411 .option user transports string&!! "Exim user"
19412 .cindex "uid (user id)" "local delivery"
19413 .cindex "transport" "user, specifying"
19414 This option specifies the user under whose uid the delivery process is to be
19415 run, overriding any uid that may have been set by the router. If the user is
19416 given as a name, the uid is looked up from the password data, and the
19417 associated group is taken as the value of the gid to be used if the &%group%&
19418 option is not set.
19419
19420 For deliveries that use local transports, a user and group are normally
19421 specified explicitly or implicitly (for example, as a result of
19422 &%check_local_user%&) by the router or transport.
19423
19424 .cindex "hints database" "access by remote transport"
19425 For remote transports, you should leave this option unset unless you really are
19426 sure you know what you are doing. When a remote transport is running, it needs
19427 to be able to access Exim's hints databases, because each host may have its own
19428 retry data.
19429 .ecindex IIDgenoptra1
19430 .ecindex IIDgenoptra2
19431 .ecindex IIDgenoptra3
19432
19433
19434
19435
19436
19437
19438 . ////////////////////////////////////////////////////////////////////////////
19439 . ////////////////////////////////////////////////////////////////////////////
19440
19441 .chapter "Address batching in local transports" "CHAPbatching" &&&
19442          "Address batching"
19443 .cindex "transport" "local; address batching in"
19444 The only remote transport (&(smtp)&) is normally configured to handle more than
19445 one address at a time, so that when several addresses are routed to the same
19446 remote host, just one copy of the message is sent. Local transports, however,
19447 normally handle one address at a time. That is, a separate instance of the
19448 transport is run for each address that is routed to the transport. A separate
19449 copy of the message is delivered each time.
19450
19451 .cindex "batched local delivery"
19452 .oindex "&%batch_max%&"
19453 .oindex "&%batch_id%&"
19454 In special cases, it may be desirable to handle several addresses at once in a
19455 local transport, for example:
19456
19457 .ilist
19458 In an &(appendfile)& transport, when storing messages in files for later
19459 delivery by some other means, a single copy of the message with multiple
19460 recipients saves space.
19461 .next
19462 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19463 a single copy saves time, and is the normal way LMTP is expected to work.
19464 .next
19465 In a &(pipe)& transport, when passing the message
19466 to a scanner program or
19467 to some other delivery mechanism such as UUCP, multiple recipients may be
19468 acceptable.
19469 .endlist
19470
19471 These three local transports all have the same options for controlling multiple
19472 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19473 repeating the information for each transport, these options are described here.
19474
19475 The &%batch_max%& option specifies the maximum number of addresses that can be
19476 delivered together in a single run of the transport. Its default value is one
19477 (no batching). When more than one address is routed to a transport that has a
19478 &%batch_max%& value greater than one, the addresses are delivered in a batch
19479 (that is, in a single run of the transport with multiple recipients), subject
19480 to certain conditions:
19481
19482 .ilist
19483 .vindex "&$local_part$&"
19484 If any of the transport's options contain a reference to &$local_part$&, no
19485 batching is possible.
19486 .next
19487 .vindex "&$domain$&"
19488 If any of the transport's options contain a reference to &$domain$&, only
19489 addresses with the same domain are batched.
19490 .next
19491 .cindex "customizing" "batching condition"
19492 If &%batch_id%& is set, it is expanded for each address, and only those
19493 addresses with the same expanded value are batched. This allows you to specify
19494 customized batching conditions. Failure of the expansion for any reason,
19495 including forced failure, disables batching, but it does not stop the delivery
19496 from taking place.
19497 .next
19498 Batched addresses must also have the same errors address (where to send
19499 delivery errors), the same header additions and removals, the same user and
19500 group for the transport, and if a host list is present, the first host must
19501 be the same.
19502 .endlist
19503
19504 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19505 both when the file or pipe command is specified in the transport, and when it
19506 is specified by a &(redirect)& router, but all the batched addresses must of
19507 course be routed to the same file or pipe command. These two transports have an
19508 option called &%use_bsmtp%&, which causes them to deliver the message in
19509 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19510 &%check_string%& and &%escape_string%& options are forced to the values
19511 .code
19512 check_string = "."
19513 escape_string = ".."
19514 .endd
19515 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19516 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19517 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19518
19519 .cindex "&'Envelope-to:'& header line"
19520 If the generic &%envelope_to_add%& option is set for a batching transport, the
19521 &'Envelope-to:'& header that is added to the message contains all the addresses
19522 that are being processed together. If you are using a batching &(appendfile)&
19523 transport without &%use_bsmtp%&, the only way to preserve the recipient
19524 addresses is to set the &%envelope_to_add%& option.
19525
19526 .cindex "&(pipe)& transport" "with multiple addresses"
19527 .vindex "&$pipe_addresses$&"
19528 If you are using a &(pipe)& transport without BSMTP, and setting the
19529 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19530 the command. This is not a true variable; it is a bit of magic that causes each
19531 of the recipient addresses to be inserted into the command as a separate
19532 argument. This provides a way of accessing all the addresses that are being
19533 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19534 are specified by a &(redirect)& router.
19535
19536
19537
19538
19539 . ////////////////////////////////////////////////////////////////////////////
19540 . ////////////////////////////////////////////////////////////////////////////
19541
19542 .chapter "The appendfile transport" "CHAPappendfile"
19543 .scindex IIDapptra1 "&(appendfile)& transport"
19544 .scindex IIDapptra2 "transports" "&(appendfile)&"
19545 .cindex "directory creation"
19546 .cindex "creating directories"
19547 The &(appendfile)& transport delivers a message by appending it to an existing
19548 file, or by creating an entirely new file in a specified directory. Single
19549 files to which messages are appended can be in the traditional Unix mailbox
19550 format, or optionally in the MBX format supported by the Pine MUA and
19551 University of Washington IMAP daemon, &'inter alia'&. When each message is
19552 being delivered as a separate file, &"maildir"& format can optionally be used
19553 to give added protection against failures that happen part-way through the
19554 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19555 supported. For all file formats, Exim attempts to create as many levels of
19556 directory as necessary, provided that &%create_directory%& is set.
19557
19558 The code for the optional formats is not included in the Exim binary by
19559 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19560 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19561 included.
19562
19563 .cindex "quota" "system"
19564 Exim recognizes system quota errors, and generates an appropriate message. Exim
19565 also supports its own quota control within the transport, for use when the
19566 system facility is unavailable or cannot be used for some reason.
19567
19568 If there is an error while appending to a file (for example, quota exceeded or
19569 partition filled), Exim attempts to reset the file's length and last
19570 modification time back to what they were before. If there is an error while
19571 creating an entirely new file, the new file is removed.
19572
19573 Before appending to a file, a number of security checks are made, and the
19574 file is locked. A detailed description is given below, after the list of
19575 private options.
19576
19577 The &(appendfile)& transport is most commonly used for local deliveries to
19578 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19579 putting messages into files for remote delivery by some means other than Exim.
19580 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19581 option).
19582
19583
19584
19585 .section "The file and directory options" "SECTfildiropt"
19586 The &%file%& option specifies a single file, to which the message is appended;
19587 the &%directory%& option specifies a directory, in which a new file containing
19588 the message is created. Only one of these two options can be set, and for
19589 normal deliveries to mailboxes, one of them &'must'& be set.
19590
19591 .vindex "&$address_file$&"
19592 .vindex "&$local_part$&"
19593 However, &(appendfile)& is also used for delivering messages to files or
19594 directories whose names (or parts of names) are obtained from alias,
19595 forwarding, or filtering operations (for example, a &%save%& command in a
19596 user's Exim filter). When such a transport is running, &$local_part$& contains
19597 the local part that was aliased or forwarded, and &$address_file$& contains the
19598 name (or partial name) of the file or directory generated by the redirection
19599 operation. There are two cases:
19600
19601 .ilist
19602 If neither &%file%& nor &%directory%& is set, the redirection operation
19603 must specify an absolute path (one that begins with &`/`&). This is the most
19604 common case when users with local accounts use filtering to sort mail into
19605 different folders. See for example, the &(address_file)& transport in the
19606 default configuration. If the path ends with a slash, it is assumed to be the
19607 name of a directory. A delivery to a directory can also be forced by setting
19608 &%maildir_format%& or &%mailstore_format%&.
19609 .next
19610 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19611 used to determine the file or directory name for the delivery. Normally, the
19612 contents of &$address_file$& are used in some way in the string expansion.
19613 .endlist
19614
19615
19616 .cindex "Sieve filter" "configuring &(appendfile)&"
19617 .cindex "Sieve filter" "relative mailbox path handling"
19618 As an example of the second case, consider an environment where users do not
19619 have home directories. They may be permitted to use Exim filter commands of the
19620 form:
19621 .code
19622 save folder23
19623 .endd
19624 or Sieve filter commands of the form:
19625 .code
19626 require "fileinto";
19627 fileinto "folder23";
19628 .endd
19629 In this situation, the expansion of &%file%& or &%directory%& in the transport
19630 must transform the relative path into an appropriate absolute file name. In the
19631 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19632 is used as a result of a &"keep"& action in the filter. This example shows one
19633 way of handling this requirement:
19634 .code
19635 file = ${if eq{$address_file}{inbox} \
19636             {/var/mail/$local_part} \
19637             {${if eq{${substr_0_1:$address_file}}{/} \
19638                   {$address_file} \
19639                   {$home/mail/$address_file} \
19640             }} \
19641        }
19642 .endd
19643 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19644 location, absolute paths are used without change, and other folders are in the
19645 &_mail_& directory within the home directory.
19646
19647 &*Note 1*&: While processing an Exim filter, a relative path such as
19648 &_folder23_& is turned into an absolute path if a home directory is known to
19649 the router. In particular, this is the case if &%check_local_user%& is set. If
19650 you want to prevent this happening at routing time, you can set
19651 &%router_home_directory%& empty. This forces the router to pass the relative
19652 path to the transport.
19653
19654 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19655 the &%file%& or &%directory%& option is still used if it is set.
19656
19657
19658
19659
19660 .section "Private options for appendfile" "SECID134"
19661 .cindex "options" "&(appendfile)& transport"
19662
19663
19664
19665 .option allow_fifo appendfile boolean false
19666 .cindex "fifo (named pipe)"
19667 .cindex "named pipe (fifo)"
19668 .cindex "pipe" "named (fifo)"
19669 Setting this option permits delivery to named pipes (FIFOs) as well as to
19670 regular files. If no process is reading the named pipe at delivery time, the
19671 delivery is deferred.
19672
19673
19674 .option allow_symlink appendfile boolean false
19675 .cindex "symbolic link" "to mailbox"
19676 .cindex "mailbox" "symbolic link"
19677 By default, &(appendfile)& will not deliver if the path name for the file is
19678 that of a symbolic link. Setting this option relaxes that constraint, but there
19679 are security issues involved in the use of symbolic links. Be sure you know
19680 what you are doing if you set this. Details of exactly what this option affects
19681 are included in the discussion which follows this list of options.
19682
19683
19684 .option batch_id appendfile string&!! unset
19685 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19686 However, batching is automatically disabled for &(appendfile)& deliveries that
19687 happen as a result of forwarding or aliasing or other redirection directly to a
19688 file.
19689
19690
19691 .option batch_max appendfile integer 1
19692 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19693
19694
19695 .option check_group appendfile boolean false
19696 When this option is set, the group owner of the file defined by the &%file%&
19697 option is checked to see that it is the same as the group under which the
19698 delivery process is running. The default setting is false because the default
19699 file mode is 0600, which means that the group is irrelevant.
19700
19701
19702 .option check_owner appendfile boolean true
19703 When this option is set, the owner of the file defined by the &%file%& option
19704 is checked to ensure that it is the same as the user under which the delivery
19705 process is running.
19706
19707
19708 .option check_string appendfile string "see below"
19709 .cindex "&""From""& line"
19710 As &(appendfile)& writes the message, the start of each line is tested for
19711 matching &%check_string%&, and if it does, the initial matching characters are
19712 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19713 a literal string, not a regular expression, and the case of any letters it
19714 contains is significant.
19715
19716 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19717 are forced to &"."& and &".."& respectively, and any settings in the
19718 configuration are ignored. Otherwise, they default to &"From&~"& and
19719 &">From&~"& when the &%file%& option is set, and unset when any of the
19720 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19721
19722 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19723 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19724 &"From&~"& indicates the start of a new message. All four options need changing
19725 if another format is used. For example, to deliver to mailboxes in MMDF format:
19726 .cindex "MMDF format mailbox"
19727 .cindex "mailbox" "MMDF format"
19728 .code
19729 check_string = "\1\1\1\1\n"
19730 escape_string = "\1\1\1\1 \n"
19731 message_prefix = "\1\1\1\1\n"
19732 message_suffix = "\1\1\1\1\n"
19733 .endd
19734 .option create_directory appendfile boolean true
19735 .cindex "directory creation"
19736 When this option is true, Exim attempts to create any missing superior
19737 directories for the file that it is about to write. A created directory's mode
19738 is given by the &%directory_mode%& option.
19739
19740 The group ownership of a newly created directory is highly dependent on the
19741 operating system (and possibly the file system) that is being used. For
19742 example, in Solaris, if the parent directory has the setgid bit set, its group
19743 is propagated to the child; if not, the currently set group is used. However,
19744 in FreeBSD, the parent's group is always used.
19745
19746
19747
19748 .option create_file appendfile string anywhere
19749 This option constrains the location of files and directories that are created
19750 by this transport. It applies to files defined by the &%file%& option and
19751 directories defined by the &%directory%& option. In the case of maildir
19752 delivery, it applies to the top level directory, not the maildir directories
19753 beneath.
19754
19755 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
19756 &"belowhome"&. In the second and third cases, a home directory must have been
19757 set for the transport. This option is not useful when an explicit file name is
19758 given for normal mailbox deliveries. It is intended for the case when file
19759 names are generated from users' &_.forward_& files. These are usually handled
19760 by an &(appendfile)& transport called &%address_file%&. See also
19761 &%file_must_exist%&.
19762
19763
19764 .option directory appendfile string&!! unset
19765 This option is mutually exclusive with the &%file%& option, but one of &%file%&
19766 or &%directory%& must be set, unless the delivery is the direct result of a
19767 redirection (see section &<<SECTfildiropt>>&).
19768
19769 When &%directory%& is set, the string is expanded, and the message is delivered
19770 into a new file or files in or below the given directory, instead of being
19771 appended to a single mailbox file. A number of different formats are provided
19772 (see &%maildir_format%& and &%mailstore_format%&), and see section
19773 &<<SECTopdir>>& for further details of this form of delivery.
19774
19775
19776 .option directory_file appendfile string&!! "see below"
19777 .cindex "base62"
19778 .vindex "&$inode$&"
19779 When &%directory%& is set, but neither &%maildir_format%& nor
19780 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
19781 whose name is obtained by expanding this string. The default value is:
19782 .code
19783 q${base62:$tod_epoch}-$inode
19784 .endd
19785 This generates a unique name from the current time, in base 62 form, and the
19786 inode of the file. The variable &$inode$& is available only when expanding this
19787 option.
19788
19789
19790 .option directory_mode appendfile "octal integer" 0700
19791 If &(appendfile)& creates any directories as a result of the
19792 &%create_directory%& option, their mode is specified by this option.
19793
19794
19795 .option escape_string appendfile string "see description"
19796 See &%check_string%& above.
19797
19798
19799 .option file appendfile string&!! unset
19800 This option is mutually exclusive with the &%directory%& option, but one of
19801 &%file%& or &%directory%& must be set, unless the delivery is the direct result
19802 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
19803 specifies a single file, to which the message is appended. One or more of
19804 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
19805 &%file%&.
19806
19807 .cindex "NFS" "lock file"
19808 .cindex "locking files"
19809 .cindex "lock files"
19810 If you are using more than one host to deliver over NFS into the same
19811 mailboxes, you should always use lock files.
19812
19813 The string value is expanded for each delivery, and must yield an absolute
19814 path. The most common settings of this option are variations on one of these
19815 examples:
19816 .code
19817 file = /var/spool/mail/$local_part
19818 file = /home/$local_part/inbox
19819 file = $home/inbox
19820 .endd
19821 .cindex "&""sticky""& bit"
19822 In the first example, all deliveries are done into the same directory. If Exim
19823 is configured to use lock files (see &%use_lockfile%& below) it must be able to
19824 create a file in the directory, so the &"sticky"& bit must be turned on for
19825 deliveries to be possible, or alternatively the &%group%& option can be used to
19826 run the delivery under a group id which has write access to the directory.
19827
19828
19829
19830 .option file_format appendfile string unset
19831 .cindex "file" "mailbox; checking existing format"
19832 This option requests the transport to check the format of an existing file
19833 before adding to it. The check consists of matching a specific string at the
19834 start of the file. The value of the option consists of an even number of
19835 colon-separated strings. The first of each pair is the test string, and the
19836 second is the name of a transport. If the transport associated with a matched
19837 string is not the current transport, control is passed over to the other
19838 transport. For example, suppose the standard &(local_delivery)& transport has
19839 this added to it:
19840 .code
19841 file_format = "From       : local_delivery :\
19842                \1\1\1\1\n : local_mmdf_delivery"
19843 .endd
19844 Mailboxes that begin with &"From"& are still handled by this transport, but if
19845 a mailbox begins with four binary ones followed by a newline, control is passed
19846 to a transport called &%local_mmdf_delivery%&, which presumably is configured
19847 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
19848 is assumed to match the current transport. If the start of a mailbox doesn't
19849 match any string, or if the transport named for a given string is not defined,
19850 delivery is deferred.
19851
19852
19853 .option file_must_exist appendfile boolean false
19854 If this option is true, the file specified by the &%file%& option must exist.
19855 A temporary error occurs if it does not, causing delivery to be deferred.
19856 If this option is false, the file is created if it does not exist.
19857
19858
19859 .option lock_fcntl_timeout appendfile time 0s
19860 .cindex "timeout" "mailbox locking"
19861 .cindex "mailbox" "locking, blocking and non-blocking"
19862 .cindex "locking files"
19863 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
19864 when locking an open mailbox file. If the call fails, the delivery process
19865 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
19866 Non-blocking calls are used so that the file is not kept open during the wait
19867 for the lock; the reason for this is to make it as safe as possible for
19868 deliveries over NFS in the case when processes might be accessing an NFS
19869 mailbox without using a lock file. This should not be done, but
19870 misunderstandings and hence misconfigurations are not unknown.
19871
19872 On a busy system, however, the performance of a non-blocking lock approach is
19873 not as good as using a blocking lock with a timeout. In this case, the waiting
19874 is done inside the system call, and Exim's delivery process acquires the lock
19875 and can proceed as soon as the previous lock holder releases it.
19876
19877 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
19878 timeout, are used. There may still be some retrying: the maximum number of
19879 retries is
19880 .code
19881 (lock_retries * lock_interval) / lock_fcntl_timeout
19882 .endd
19883 rounded up to the next whole number. In other words, the total time during
19884 which &(appendfile)& is trying to get a lock is roughly the same, unless
19885 &%lock_fcntl_timeout%& is set very large.
19886
19887 You should consider setting this option if you are getting a lot of delayed
19888 local deliveries because of errors of the form
19889 .code
19890 failed to lock mailbox /some/file (fcntl)
19891 .endd
19892
19893 .option lock_flock_timeout appendfile time 0s
19894 This timeout applies to file locking when using &[flock()]& (see
19895 &%use_flock%&); the timeout operates in a similar manner to
19896 &%lock_fcntl_timeout%&.
19897
19898
19899 .option lock_interval appendfile time 3s
19900 This specifies the time to wait between attempts to lock the file. See below
19901 for details of locking.
19902
19903
19904 .option lock_retries appendfile integer 10
19905 This specifies the maximum number of attempts to lock the file. A value of zero
19906 is treated as 1. See below for details of locking.
19907
19908
19909 .option lockfile_mode appendfile "octal integer" 0600
19910 This specifies the mode of the created lock file, when a lock file is being
19911 used (see &%use_lockfile%& and &%use_mbx_lock%&).
19912
19913
19914 .option lockfile_timeout appendfile time 30m
19915 .cindex "timeout" "mailbox locking"
19916 When a lock file is being used (see &%use_lockfile%&), if a lock file already
19917 exists and is older than this value, it is assumed to have been left behind by
19918 accident, and Exim attempts to remove it.
19919
19920
19921 .option mailbox_filecount appendfile string&!! unset
19922 .cindex "mailbox" "specifying size of"
19923 .cindex "size" "of mailbox"
19924 If this option is set, it is expanded, and the result is taken as the current
19925 number of files in the mailbox. It must be a decimal number, optionally
19926 followed by K or M. This provides a way of obtaining this information from an
19927 external source that maintains the data.
19928
19929
19930 .option mailbox_size appendfile string&!! unset
19931 .cindex "mailbox" "specifying size of"
19932 .cindex "size" "of mailbox"
19933 If this option is set, it is expanded, and the result is taken as the current
19934 size the mailbox. It must be a decimal number, optionally followed by K or M.
19935 This provides a way of obtaining this information from an external source that
19936 maintains the data. This is likely to be helpful for maildir deliveries where
19937 it is computationally expensive to compute the size of a mailbox.
19938
19939
19940
19941 .option maildir_format appendfile boolean false
19942 .cindex "maildir format" "specifying"
19943 If this option is set with the &%directory%& option, the delivery is into a new
19944 file, in the &"maildir"& format that is used by other mail software. When the
19945 transport is activated directly from a &(redirect)& router (for example, the
19946 &(address_file)& transport in the default configuration), setting
19947 &%maildir_format%& causes the path received from the router to be treated as a
19948 directory, whether or not it ends with &`/`&. This option is available only if
19949 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
19950 &<<SECTmaildirdelivery>>& below for further details.
19951
19952
19953 .option maildir_quota_directory_regex appendfile string "See below"
19954 .cindex "maildir format" "quota; directories included in"
19955 .cindex "quota" "maildir; directories included in"
19956 This option is relevant only when &%maildir_use_size_file%& is set. It defines
19957 a regular expression for specifying directories, relative to the quota
19958 directory (see &%quota_directory%&), that should be included in the quota
19959 calculation. The default value is:
19960 .code
19961 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
19962 .endd
19963 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
19964 (directories whose names begin with a dot). If you want to exclude the
19965 &_Trash_&
19966 folder from the count (as some sites do), you need to change this setting to
19967 .code
19968 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
19969 .endd
19970 This uses a negative lookahead in the regular expression to exclude the
19971 directory whose name is &_.Trash_&. When a directory is excluded from quota
19972 calculations, quota processing is bypassed for any messages that are delivered
19973 directly into that directory.
19974
19975
19976 .option maildir_retries appendfile integer 10
19977 This option specifies the number of times to retry when writing a file in
19978 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
19979
19980
19981 .option maildir_tag appendfile string&!! unset
19982 This option applies only to deliveries in maildir format, and is described in
19983 section &<<SECTmaildirdelivery>>& below.
19984
19985
19986 .new
19987 .option maildir_use_size_file appendfile&!! boolean false
19988 .cindex "maildir format" "&_maildirsize_& file"
19989 The result of string expansion for this option must be a valid boolean value.
19990 If it is true, it enables support for &_maildirsize_& files. Exim
19991 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
19992 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
19993 value is zero. See &%maildir_quota_directory_regex%& above and section
19994 &<<SECTmaildirdelivery>>& below for further details.
19995 .wen
19996
19997 .option maildirfolder_create_regex appendfile string unset
19998 .cindex "maildir format" "&_maildirfolder_& file"
19999 .cindex "&_maildirfolder_&, creating"
20000 The value of this option is a regular expression. If it is unset, it has no
20001 effect. Otherwise, before a maildir delivery takes place, the pattern is
20002 matched against the name of the maildir directory, that is, the directory
20003 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20004 delivery. If there is a match, Exim checks for the existence of a file called
20005 &_maildirfolder_& in the directory, and creates it if it does not exist.
20006 See section &<<SECTmaildirdelivery>>& for more details.
20007
20008
20009 .option mailstore_format appendfile boolean false
20010 .cindex "mailstore format" "specifying"
20011 If this option is set with the &%directory%& option, the delivery is into two
20012 new files in  &"mailstore"& format. The option is available only if
20013 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20014 below for further details.
20015
20016
20017 .option mailstore_prefix appendfile string&!! unset
20018 This option applies only to deliveries in mailstore format, and is described in
20019 section &<<SECTopdir>>& below.
20020
20021
20022 .option mailstore_suffix appendfile string&!! unset
20023 This option applies only to deliveries in mailstore format, and is described in
20024 section &<<SECTopdir>>& below.
20025
20026
20027 .option mbx_format appendfile boolean false
20028 .cindex "locking files"
20029 .cindex "file" "locking"
20030 .cindex "file" "MBX format"
20031 .cindex "MBX format, specifying"
20032 This option is available only if Exim has been compiled with SUPPORT_MBX
20033 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20034 the message is appended to the mailbox file in MBX format instead of
20035 traditional Unix format. This format is supported by Pine4 and its associated
20036 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20037
20038 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20039 automatically changed by the use of &%mbx_format%&. They should normally be set
20040 empty when using MBX format, so this option almost always appears in this
20041 combination:
20042 .code
20043 mbx_format = true
20044 message_prefix =
20045 message_suffix =
20046 .endd
20047 If none of the locking options are mentioned in the configuration,
20048 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20049 is possible to specify the other kinds of locking with &%mbx_format%&, but
20050 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20051 interworks with &'c-client'&, providing for shared access to the mailbox. It
20052 should not be used if any program that does not use this form of locking is
20053 going to access the mailbox, nor should it be used if the mailbox file is NFS
20054 mounted, because it works only when the mailbox is accessed from a single host.
20055
20056 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20057 the standard version of &'c-client'&, because as long as it has a mailbox open
20058 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20059 append messages to it.
20060
20061
20062 .option message_prefix appendfile string&!! "see below"
20063 .cindex "&""From""& line"
20064 The string specified here is expanded and output at the start of every message.
20065 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20066 in which case it is:
20067 .code
20068 message_prefix = "From ${if def:return_path{$return_path}\
20069   {MAILER-DAEMON}} $tod_bsdinbox\n"
20070 .endd
20071 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20072 &`\n`& to &`\r\n`& in &%message_prefix%&.
20073
20074 .option message_suffix appendfile string&!! "see below"
20075 The string specified here is expanded and output at the end of every message.
20076 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20077 in which case it is a single newline character. The suffix can be suppressed by
20078 setting
20079 .code
20080 message_suffix =
20081 .endd
20082 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20083 &`\n`& to &`\r\n`& in &%message_suffix%&.
20084
20085 .option mode appendfile "octal integer" 0600
20086 If the output file is created, it is given this mode. If it already exists and
20087 has wider permissions, they are reduced to this mode. If it has narrower
20088 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20089 if the delivery is the result of a &%save%& command in a filter file specifying
20090 a particular mode, the mode of the output file is always forced to take that
20091 value, and this option is ignored.
20092
20093
20094 .option mode_fail_narrower appendfile boolean true
20095 This option applies in the case when an existing mailbox file has a narrower
20096 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20097 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20098 continues with the delivery attempt, using the existing mode of the file.
20099
20100
20101 .option notify_comsat appendfile boolean false
20102 If this option is true, the &'comsat'& daemon is notified after every
20103 successful delivery to a user mailbox. This is the daemon that notifies logged
20104 on users about incoming mail.
20105
20106
20107 .option quota appendfile string&!! unset
20108 .cindex "quota" "imposed by Exim"
20109 This option imposes a limit on the size of the file to which Exim is appending,
20110 or to the total space used in the directory tree when the &%directory%& option
20111 is set. In the latter case, computation of the space used is expensive, because
20112 all the files in the directory (and any sub-directories) have to be
20113 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20114 &%maildir_use_size_file%& for ways to avoid this in environments where users
20115 have no shell access to their mailboxes).
20116
20117 As there is no interlock against two simultaneous deliveries into a
20118 multi-file mailbox, it is possible for the quota to be overrun in this case.
20119 For single-file mailboxes, of course, an interlock is a necessity.
20120
20121 A file's size is taken as its &'used'& value. Because of blocking effects, this
20122 may be a lot less than the actual amount of disk space allocated to the file.
20123 If the sizes of a number of files are being added up, the rounding effect can
20124 become quite noticeable, especially on systems that have large block sizes.
20125 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20126 the obvious value which users understand most easily.
20127
20128 The value of the option is expanded, and must then be a numerical value
20129 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20130 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20131 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20132 be handled.
20133
20134 &*Note*&: A value of zero is interpreted as &"no quota"&.
20135
20136 The expansion happens while Exim is running as root, before it changes uid for
20137 the delivery. This means that files that are inaccessible to the end user can
20138 be used to hold quota values that are looked up in the expansion. When delivery
20139 fails because this quota is exceeded, the handling of the error is as for
20140 system quota failures.
20141
20142 By default, Exim's quota checking mimics system quotas, and restricts the
20143 mailbox to the specified maximum size, though the value is not accurate to the
20144 last byte, owing to separator lines and additional headers that may get added
20145 during message delivery. When a mailbox is nearly full, large messages may get
20146 refused even though small ones are accepted, because the size of the current
20147 message is added to the quota when the check is made. This behaviour can be
20148 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20149 for exceeding the quota does not include the current message. Thus, deliveries
20150 continue until the quota has been exceeded; thereafter, no further messages are
20151 delivered. See also &%quota_warn_threshold%&.
20152
20153
20154 .option quota_directory appendfile string&!! unset
20155 This option defines the directory to check for quota purposes when delivering
20156 into individual files. The default is the delivery directory, or, if a file
20157 called &_maildirfolder_& exists in a maildir directory, the parent of the
20158 delivery directory.
20159
20160
20161 .option quota_filecount appendfile string&!! 0
20162 This option applies when the &%directory%& option is set. It limits the total
20163 number of files in the directory (compare the inode limit in system quotas). It
20164 can only be used if &%quota%& is also set. The value is expanded; an expansion
20165 failure causes delivery to be deferred. A value of zero is interpreted as
20166 &"no quota"&.
20167
20168
20169 .option quota_is_inclusive appendfile boolean true
20170 See &%quota%& above.
20171
20172
20173 .option quota_size_regex appendfile string unset
20174 This option applies when one of the delivery modes that writes a separate file
20175 for each message is being used. When Exim wants to find the size of one of
20176 these files in order to test the quota, it first checks &%quota_size_regex%&.
20177 If this is set to a regular expression that matches the file name, and it
20178 captures one string, that string is interpreted as a representation of the
20179 file's size. The value of &%quota_size_regex%& is not expanded.
20180
20181 This feature is useful only when users have no shell access to their mailboxes
20182 &-- otherwise they could defeat the quota simply by renaming the files. This
20183 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20184 the file length to the file name. For example:
20185 .code
20186 maildir_tag = ,S=$message_size
20187 quota_size_regex = ,S=(\d+)
20188 .endd
20189 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20190 number of lines in the message.
20191
20192 The regular expression should not assume that the length is at the end of the
20193 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20194 sometimes add other information onto the ends of message file names.
20195
20196 Section &<<SECID136>>& contains further information.
20197
20198
20199 .option quota_warn_message appendfile string&!! "see below"
20200 See below for the use of this option. If it is not set when
20201 &%quota_warn_threshold%& is set, it defaults to
20202 .code
20203 quota_warn_message = "\
20204   To: $local_part@$domain\n\
20205   Subject: Your mailbox\n\n\
20206   This message is automatically created \
20207   by mail delivery software.\n\n\
20208   The size of your mailbox has exceeded \
20209   a warning threshold that is\n\
20210   set by the system administrator.\n"
20211 .endd
20212
20213
20214 .option quota_warn_threshold appendfile string&!! 0
20215 .cindex "quota" "warning threshold"
20216 .cindex "mailbox" "size warning"
20217 .cindex "size" "of mailbox"
20218 This option is expanded in the same way as &%quota%& (see above). If the
20219 resulting value is greater than zero, and delivery of the message causes the
20220 size of the file or total space in the directory tree to cross the given
20221 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20222 may be specified as a percentage of it by following the value with a percent
20223 sign. For example:
20224 .code
20225 quota = 10M
20226 quota_warn_threshold = 75%
20227 .endd
20228 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20229 percent sign is ignored.
20230
20231 The warning message itself is specified by the &%quota_warn_message%& option,
20232 and it must start with a &'To:'& header line containing the recipient(s) of the
20233 warning message. These do not necessarily have to include the recipient(s) of
20234 the original message. A &'Subject:'& line should also normally be supplied. You
20235 can include any other header lines that you want. If you do not include a
20236 &'From:'& line, the default is:
20237 .code
20238 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20239 .endd
20240 .oindex &%errors_reply_to%&
20241 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20242 option.
20243
20244 The &%quota%& option does not have to be set in order to use this option; they
20245 are independent of one another except when the threshold is specified as a
20246 percentage.
20247
20248
20249 .option use_bsmtp appendfile boolean false
20250 .cindex "envelope sender"
20251 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20252 format, with the envelope sender and recipient(s) included as SMTP commands. If
20253 you want to include a leading HELO command with such messages, you can do
20254 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20255 for details of batch SMTP.
20256
20257
20258 .option use_crlf appendfile boolean false
20259 .cindex "carriage return"
20260 .cindex "linefeed"
20261 This option causes lines to be terminated with the two-character CRLF sequence
20262 (carriage return, linefeed) instead of just a linefeed character. In the case
20263 of batched SMTP, the byte sequence written to the file is then an exact image
20264 of what would be sent down a real SMTP connection.
20265
20266 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20267 (which are used to supply the traditional &"From&~"& and blank line separators
20268 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20269 carriage return characters if these are needed. In cases where these options
20270 have non-empty defaults, the values end with a single linefeed, so they must be
20271 changed to end with &`\r\n`& if &%use_crlf%& is set.
20272
20273
20274 .option use_fcntl_lock appendfile boolean "see below"
20275 This option controls the use of the &[fcntl()]& function to lock a file for
20276 exclusive use when a message is being appended. It is set by default unless
20277 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20278 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20279 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20280
20281
20282 .option use_flock_lock appendfile boolean false
20283 This option is provided to support the use of &[flock()]& for file locking, for
20284 the few situations where it is needed. Most modern operating systems support
20285 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20286 each other. Exim uses &[fcntl()]& locking by default.
20287
20288 This option is required only if you are using an operating system where
20289 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20290 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20291 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20292
20293 .cindex "Solaris" "&[flock()]& support"
20294 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20295 have it (and some, I think, provide a not quite right version built on top of
20296 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20297 the ability to use it, and any attempt to do so will cause a configuration
20298 error.
20299
20300 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20301 is just being mapped onto &[fcntl()]& by the OS).
20302
20303
20304 .option use_lockfile appendfile boolean "see below"
20305 If this option is turned off, Exim does not attempt to create a lock file when
20306 appending to a mailbox file. In this situation, the only locking is by
20307 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20308 sure that every MUA that is ever going to look at your users' mailboxes uses
20309 &[fcntl()]& rather than a lock file, and even then only when you are not
20310 delivering over NFS from more than one host.
20311
20312 .cindex "NFS" "lock file"
20313 In order to append to an NFS file safely from more than one host, it is
20314 necessary to take out a lock &'before'& opening the file, and the lock file
20315 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20316 file corruption.
20317
20318 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20319 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20320 except when &%mbx_format%& is set.
20321
20322
20323 .option use_mbx_lock appendfile boolean "see below"
20324 This option is available only if Exim has been compiled with SUPPORT_MBX
20325 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20326 locking rules be used. It is set by default if &%mbx_format%& is set and none
20327 of the locking options are mentioned in the configuration. The locking rules
20328 are the same as are used by the &'c-client'& library that underlies Pine and
20329 the IMAP4 and POP daemons that come with it (see the discussion below). The
20330 rules allow for shared access to the mailbox. However, this kind of locking
20331 does not work when the mailbox is NFS mounted.
20332
20333 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20334 &%use_flock_lock%& to control what kind of locking is used in implementing the
20335 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20336 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20337
20338
20339
20340
20341 .section "Operational details for appending" "SECTopappend"
20342 .cindex "appending to a file"
20343 .cindex "file" "appending"
20344 Before appending to a file, the following preparations are made:
20345
20346 .ilist
20347 If the name of the file is &_/dev/null_&, no action is taken, and a success
20348 return is given.
20349
20350 .next
20351 .cindex "directory creation"
20352 If any directories on the file's path are missing, Exim creates them if the
20353 &%create_directory%& option is set. A created directory's mode is given by the
20354 &%directory_mode%& option.
20355
20356 .next
20357 If &%file_format%& is set, the format of an existing file is checked. If this
20358 indicates that a different transport should be used, control is passed to that
20359 transport.
20360
20361 .next
20362 .cindex "file" "locking"
20363 .cindex "locking files"
20364 .cindex "NFS" "lock file"
20365 If &%use_lockfile%& is set, a lock file is built in a way that will work
20366 reliably over NFS, as follows:
20367
20368 .olist
20369 Create a &"hitching post"& file whose name is that of the lock file with the
20370 current time, primary host name, and process id added, by opening for writing
20371 as a new file. If this fails with an access error, delivery is deferred.
20372 .next
20373 Close the hitching post file, and hard link it to the lock file name.
20374 .next
20375 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20376 Unlink the hitching post name.
20377 .next
20378 Otherwise, use &[stat()]& to get information about the hitching post file, and
20379 then unlink hitching post name. If the number of links is exactly two, creation
20380 of the lock file succeeded but something (for example, an NFS server crash and
20381 restart) caused this fact not to be communicated to the &[link()]& call.
20382 .next
20383 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20384 up to &%lock_retries%& times. However, since any program that writes to a
20385 mailbox should complete its task very quickly, it is reasonable to time out old
20386 lock files that are normally the result of user agent and system crashes. If an
20387 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20388 it before trying again.
20389 .endlist olist
20390
20391 .next
20392 A call is made to &[lstat()]& to discover whether the main file exists, and if
20393 so, what its characteristics are. If &[lstat()]& fails for any reason other
20394 than non-existence, delivery is deferred.
20395
20396 .next
20397 .cindex "symbolic link" "to mailbox"
20398 .cindex "mailbox" "symbolic link"
20399 If the file does exist and is a symbolic link, delivery is deferred, unless the
20400 &%allow_symlink%& option is set, in which case the ownership of the link is
20401 checked, and then &[stat()]& is called to find out about the real file, which
20402 is then subjected to the checks below. The check on the top-level link
20403 ownership prevents one user creating a link for another's mailbox in a sticky
20404 directory, though allowing symbolic links in this case is definitely not a good
20405 idea. If there is a chain of symbolic links, the intermediate ones are not
20406 checked.
20407
20408 .next
20409 If the file already exists but is not a regular file, or if the file's owner
20410 and group (if the group is being checked &-- see &%check_group%& above) are
20411 different from the user and group under which the delivery is running,
20412 delivery is deferred.
20413
20414 .next
20415 If the file's permissions are more generous than specified, they are reduced.
20416 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20417 is set false, in which case the delivery is tried using the existing
20418 permissions.
20419
20420 .next
20421 The file's inode number is saved, and the file is then opened for appending.
20422 If this fails because the file has vanished, &(appendfile)& behaves as if it
20423 hadn't existed (see below). For any other failures, delivery is deferred.
20424
20425 .next
20426 If the file is opened successfully, check that the inode number hasn't
20427 changed, that it is still a regular file, and that the owner and permissions
20428 have not changed. If anything is wrong, defer delivery and freeze the message.
20429
20430 .next
20431 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20432 option is set. Otherwise, check that the file is being created in a permitted
20433 directory if the &%create_file%& option is set (deferring on failure), and then
20434 open for writing as a new file, with the O_EXCL and O_CREAT options,
20435 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20436 set). In this case, which can happen if the link points to a non-existent file,
20437 the file is opened for writing using O_CREAT but not O_EXCL, because
20438 that prevents link following.
20439
20440 .next
20441 .cindex "loop" "while file testing"
20442 If opening fails because the file exists, obey the tests given above for
20443 existing files. However, to avoid looping in a situation where the file is
20444 being continuously created and destroyed, the exists/not-exists loop is broken
20445 after 10 repetitions, and the message is then frozen.
20446
20447 .next
20448 If opening fails with any other error, defer delivery.
20449
20450 .next
20451 .cindex "file" "locking"
20452 .cindex "locking files"
20453 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20454 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20455 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20456 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20457 file, and an exclusive lock on the file whose name is
20458 .code
20459 /tmp/.<device-number>.<inode-number>
20460 .endd
20461 using the device and inode numbers of the open mailbox file, in accordance with
20462 the MBX locking rules. This file is created with a mode that is specified by
20463 the &%lockfile_mode%& option.
20464
20465 If Exim fails to lock the file, there are two possible courses of action,
20466 depending on the value of the locking timeout. This is obtained from
20467 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20468
20469 If the timeout value is zero, the file is closed, Exim waits for
20470 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20471 to lock it again. This happens up to &%lock_retries%& times, after which the
20472 delivery is deferred.
20473
20474 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20475 &[flock()]& are used (with the given timeout), so there has already been some
20476 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20477 immediately. It retries up to
20478 .code
20479 (lock_retries * lock_interval) / <timeout>
20480 .endd
20481 times (rounded up).
20482 .endlist
20483
20484 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20485 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20486
20487
20488 .section "Operational details for delivery to a new file" "SECTopdir"
20489 .cindex "delivery" "to single file"
20490 .cindex "&""From""& line"
20491 When the &%directory%& option is set instead of &%file%&, each message is
20492 delivered into a newly-created file or set of files. When &(appendfile)& is
20493 activated directly from a &(redirect)& router, neither &%file%& nor
20494 &%directory%& is normally set, because the path for delivery is supplied by the
20495 router. (See for example, the &(address_file)& transport in the default
20496 configuration.) In this case, delivery is to a new file if either the path name
20497 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20498
20499 No locking is required while writing the message to a new file, so the various
20500 locking options of the transport are ignored. The &"From"& line that by default
20501 separates messages in a single file is not normally needed, nor is the escaping
20502 of message lines that start with &"From"&, and there is no need to ensure a
20503 newline at the end of each message. Consequently, the default values for
20504 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20505 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20506
20507 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20508 the files in the delivery directory by default. However, you can specify a
20509 different directory by setting &%quota_directory%&. Also, for maildir
20510 deliveries (see below) the &_maildirfolder_& convention is honoured.
20511
20512
20513 .cindex "maildir format"
20514 .cindex "mailstore format"
20515 There are three different ways in which delivery to individual files can be
20516 done, controlled by the settings of the &%maildir_format%& and
20517 &%mailstore_format%& options. Note that code to support maildir or mailstore
20518 formats is not included in the binary unless SUPPORT_MAILDIR or
20519 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20520
20521 .cindex "directory creation"
20522 In all three cases an attempt is made to create the directory and any necessary
20523 sub-directories if they do not exist, provided that the &%create_directory%&
20524 option is set (the default). The location of a created directory can be
20525 constrained by setting &%create_file%&. A created directory's mode is given by
20526 the &%directory_mode%& option. If creation fails, or if the
20527 &%create_directory%& option is not set when creation is required, delivery is
20528 deferred.
20529
20530
20531
20532 .section "Maildir delivery" "SECTmaildirdelivery"
20533 .cindex "maildir format" "description of"
20534 If the &%maildir_format%& option is true, Exim delivers each message by writing
20535 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20536 directory that is defined by the &%directory%& option (the &"delivery
20537 directory"&). If the delivery is successful, the file is renamed into the
20538 &_new_& subdirectory.
20539
20540 In the file name, <&'stime'&> is the current time of day in seconds, and
20541 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20542 Exim checks that the time-of-day clock has moved on by at least one microsecond
20543 before terminating the delivery process. This guarantees uniqueness for the
20544 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20545 opening it. If any response other than ENOENT (does not exist) is given,
20546 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20547
20548 Before Exim carries out a maildir delivery, it ensures that subdirectories
20549 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20550 do not exist, Exim tries to create them and any superior directories in their
20551 path, subject to the &%create_directory%& and &%create_file%& options. If the
20552 &%maildirfolder_create_regex%& option is set, and the regular expression it
20553 contains matches the delivery directory, Exim also ensures that a file called
20554 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20555 &_maildirfolder_& file cannot be created, delivery is deferred.
20556
20557 These features make it possible to use Exim to create all the necessary files
20558 and directories in a maildir mailbox, including subdirectories for maildir++
20559 folders. Consider this example:
20560 .code
20561 maildir_format = true
20562 directory = /var/mail/$local_part\
20563            ${if eq{$local_part_suffix}{}{}\
20564            {/.${substr_1:$local_part_suffix}}}
20565 maildirfolder_create_regex = /\.[^/]+$
20566 .endd
20567 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20568 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20569 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20570 not match this name, so Exim will not look for or create the file
20571 &_/var/mail/pimbo/maildirfolder_&, though it will create
20572 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20573
20574 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20575 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20576 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20577 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20578 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20579
20580 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20581 not inadvertently match the toplevel maildir directory, because a
20582 &_maildirfolder_& file at top level would completely break quota calculations.
20583
20584 .cindex "quota" "in maildir delivery"
20585 .cindex "maildir++"
20586 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20587 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20588 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20589 Exim assumes the directory is a maildir++ folder directory, which is one level
20590 down from the user's top level mailbox directory. This causes it to start at
20591 the parent directory instead of the current directory when calculating the
20592 amount of space used.
20593
20594 One problem with delivering into a multi-file mailbox is that it is
20595 computationally expensive to compute the size of the mailbox for quota
20596 checking. Various approaches have been taken to reduce the amount of work
20597 needed. The next two sections describe two of them. A third alternative is to
20598 use some external process for maintaining the size data, and use the expansion
20599 of the &%mailbox_size%& option as a way of importing it into Exim.
20600
20601
20602
20603
20604 .section "Using tags to record message sizes" "SECID135"
20605 If &%maildir_tag%& is set, the string is expanded for each delivery.
20606 When the maildir file is renamed into the &_new_& sub-directory, the
20607 tag is added to its name. However, if adding the tag takes the length of the
20608 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20609 the tag is dropped and the maildir file is created with no tag.
20610
20611
20612 .vindex "&$message_size$&"
20613 Tags can be used to encode the size of files in their names; see
20614 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20615 happens after the message has been written. The value of the &$message_size$&
20616 variable is set to the number of bytes actually written. If the expansion is
20617 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20618 be deferred. The expanded tag may contain any printing characters except &"/"&.
20619 Non-printing characters in the string are ignored; if the resulting string is
20620 empty, it is ignored. If it starts with an alphanumeric character, a leading
20621 colon is inserted; this default has not proven to be the path that popular
20622 maildir implementations have chosen (but changing it in Exim would break
20623 backwards compatibility).
20624
20625 For one common implementation, you might set:
20626 .code
20627 maildir_tag = ,S=${message_size}
20628 .endd
20629 but you should check the documentation of the other software to be sure.
20630
20631 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
20632 as this allows Exim to extract the size from your tag, instead of having to
20633 &[stat()]& each message file.
20634
20635
20636 .section "Using a maildirsize file" "SECID136"
20637 .cindex "quota" "in maildir delivery"
20638 .cindex "maildir format" "&_maildirsize_& file"
20639 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20640 storing quota and message size information in a file called &_maildirsize_&
20641 within the toplevel maildir directory. If this file does not exist, Exim
20642 creates it, setting the quota from the &%quota%& option of the transport. If
20643 the maildir directory itself does not exist, it is created before any attempt
20644 to write a &_maildirsize_& file.
20645
20646 The &_maildirsize_& file is used to hold information about the sizes of
20647 messages in the maildir, thus speeding up quota calculations. The quota value
20648 in the file is just a cache; if the quota is changed in the transport, the new
20649 value overrides the cached value when the next message is delivered. The cache
20650 is maintained for the benefit of other programs that access the maildir and
20651 need to know the quota.
20652
20653 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20654 file is maintained (with a zero quota setting), but no quota is imposed.
20655
20656 A regular expression is available for controlling which directories in the
20657 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20658 See the description of the &%maildir_quota_directory_regex%& option above for
20659 details.
20660
20661
20662 .section "Mailstore delivery" "SECID137"
20663 .cindex "mailstore format" "description of"
20664 If the &%mailstore_format%& option is true, each message is written as two
20665 files in the given directory. A unique base name is constructed from the
20666 message id and the current delivery process, and the files that are written use
20667 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20668 contains the message's envelope, and the &_.msg_& file contains the message
20669 itself. The base name is placed in the variable &$mailstore_basename$&.
20670
20671 During delivery, the envelope is first written to a file with the suffix
20672 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20673 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20674 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20675 file before accessing either of them. An alternative approach is to wait for
20676 the absence of a &_.tmp_& file.
20677
20678 The envelope file starts with any text defined by the &%mailstore_prefix%&
20679 option, expanded and terminated by a newline if there isn't one. Then follows
20680 the sender address on one line, then all the recipient addresses, one per line.
20681 There can be more than one recipient only if the &%batch_max%& option is set
20682 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20683 appended to the file, followed by a newline if it does not end with one.
20684
20685 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20686 failure, it is ignored. Other expansion errors are treated as serious
20687 configuration errors, and delivery is deferred. The variable
20688 &$mailstore_basename$& is available for use during these expansions.
20689
20690
20691 .section "Non-special new file delivery" "SECID138"
20692 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20693 file is created directly in the named directory. For example, when delivering
20694 messages into files in batched SMTP format for later delivery to some host (see
20695 section &<<SECTbatchSMTP>>&), a setting such as
20696 .code
20697 directory = /var/bsmtp/$host
20698 .endd
20699 might be used. A message is written to a file with a temporary name, which is
20700 then renamed when the delivery is complete. The final name is obtained by
20701 expanding the contents of the &%directory_file%& option.
20702 .ecindex IIDapptra1
20703 .ecindex IIDapptra2
20704
20705
20706
20707
20708
20709
20710 . ////////////////////////////////////////////////////////////////////////////
20711 . ////////////////////////////////////////////////////////////////////////////
20712
20713 .chapter "The autoreply transport" "CHID8"
20714 .scindex IIDauttra1 "transports" "&(autoreply)&"
20715 .scindex IIDauttra2 "&(autoreply)& transport"
20716 The &(autoreply)& transport is not a true transport in that it does not cause
20717 the message to be transmitted. Instead, it generates a new mail message as an
20718 automatic reply to the incoming message. &'References:'& and
20719 &'Auto-Submitted:'& header lines are included. These are constructed according
20720 to the rules in RFCs 2822 and 3834, respectively.
20721
20722 If the router that passes the message to this transport does not have the
20723 &%unseen%& option set, the original message (for the current recipient) is not
20724 delivered anywhere. However, when the &%unseen%& option is set on the router
20725 that passes the message to this transport, routing of the address continues, so
20726 another router can set up a normal message delivery.
20727
20728
20729 The &(autoreply)& transport is usually run as the result of mail filtering, a
20730 &"vacation"& message being the standard example. However, it can also be run
20731 directly from a router like any other transport. To reduce the possibility of
20732 message cascades, messages created by the &(autoreply)& transport always have
20733 empty envelope sender addresses, like bounce messages.
20734
20735 The parameters of the message to be sent can be specified in the configuration
20736 by options described below. However, these are used only when the address
20737 passed to the transport does not contain its own reply information. When the
20738 transport is run as a consequence of a
20739 &%mail%&
20740 or &%vacation%& command in a filter file, the parameters of the message are
20741 supplied by the filter, and passed with the address. The transport's options
20742 that define the message are then ignored (so they are not usually set in this
20743 case). The message is specified entirely by the filter or by the transport; it
20744 is never built from a mixture of options. However, the &%file_optional%&,
20745 &%mode%&, and &%return_message%& options apply in all cases.
20746
20747 &(Autoreply)& is implemented as a local transport. When used as a result of a
20748 command in a user's filter file, &(autoreply)& normally runs under the uid and
20749 gid of the user, and with appropriate current and home directories (see chapter
20750 &<<CHAPenvironment>>&).
20751
20752 There is a subtle difference between routing a message to a &(pipe)& transport
20753 that generates some text to be returned to the sender, and routing it to an
20754 &(autoreply)& transport. This difference is noticeable only if more than one
20755 address from the same message is so handled. In the case of a pipe, the
20756 separate outputs from the different addresses are gathered up and returned to
20757 the sender in a single message, whereas if &(autoreply)& is used, a separate
20758 message is generated for each address that is passed to it.
20759
20760 Non-printing characters are not permitted in the header lines generated for the
20761 message that &(autoreply)& creates, with the exception of newlines that are
20762 immediately followed by white space. If any non-printing characters are found,
20763 the transport defers.
20764 Whether characters with the top bit set count as printing characters or not is
20765 controlled by the &%print_topbitchars%& global option.
20766
20767 If any of the generic options for manipulating headers (for example,
20768 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
20769 of the original message that is included in the generated message when
20770 &%return_message%& is set. They do not apply to the generated message itself.
20771
20772 .vindex "&$sender_address$&"
20773 If the &(autoreply)& transport receives return code 2 from Exim when it submits
20774 the message, indicating that there were no recipients, it does not treat this
20775 as an error. This means that autoreplies sent to &$sender_address$& when this
20776 is empty (because the incoming message is a bounce message) do not cause
20777 problems. They are just discarded.
20778
20779
20780
20781 .section "Private options for autoreply" "SECID139"
20782 .cindex "options" "&(autoreply)& transport"
20783
20784 .option bcc autoreply string&!! unset
20785 This specifies the addresses that are to receive &"blind carbon copies"& of the
20786 message when the message is specified by the transport.
20787
20788
20789 .option cc autoreply string&!! unset
20790 This specifies recipients of the message and the contents of the &'Cc:'& header
20791 when the message is specified by the transport.
20792
20793
20794 .option file autoreply string&!! unset
20795 The contents of the file are sent as the body of the message when the message
20796 is specified by the transport. If both &%file%& and &%text%& are set, the text
20797 string comes first.
20798
20799
20800 .option file_expand autoreply boolean false
20801 If this is set, the contents of the file named by the &%file%& option are
20802 subjected to string expansion as they are added to the message.
20803
20804
20805 .option file_optional autoreply boolean false
20806 If this option is true, no error is generated if the file named by the &%file%&
20807 option or passed with the address does not exist or cannot be read.
20808
20809
20810 .option from autoreply string&!! unset
20811 This specifies the contents of the &'From:'& header when the message is
20812 specified by the transport.
20813
20814
20815 .option headers autoreply string&!! unset
20816 This specifies additional RFC 2822 headers that are to be added to the message
20817 when the message is specified by the transport. Several can be given by using
20818 &"\n"& to separate them. There is no check on the format.
20819
20820
20821 .option log autoreply string&!! unset
20822 This option names a file in which a record of every message sent is logged when
20823 the message is specified by the transport.
20824
20825
20826 .option mode autoreply "octal integer" 0600
20827 If either the log file or the &"once"& file has to be created, this mode is
20828 used.
20829
20830
20831 .option never_mail autoreply "address list&!!" unset
20832 If any run of the transport creates a message with a recipient that matches any
20833 item in the list, that recipient is quietly discarded. If all recipients are
20834 discarded, no message is created. This applies both when the recipients are
20835 generated by a filter and when they are specified in the transport.
20836
20837
20838
20839 .option once autoreply string&!! unset
20840 This option names a file or DBM database in which a record of each &'To:'&
20841 recipient is kept when the message is specified by the transport. &*Note*&:
20842 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
20843
20844 If &%once%& is unset, or is set to an empty string, the message is always sent.
20845 By default, if &%once%& is set to a non-empty file name, the message
20846 is not sent if a potential recipient is already listed in the database.
20847 However, if the &%once_repeat%& option specifies a time greater than zero, the
20848 message is sent if that much time has elapsed since a message was last sent to
20849 this recipient. A setting of zero time for &%once_repeat%& (the default)
20850 prevents a message from being sent a second time &-- in this case, zero means
20851 infinity.
20852
20853 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
20854 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
20855 greater than zero, it changes the way Exim implements the &%once%& option.
20856 Instead of using a DBM file to record every recipient it sends to, it uses a
20857 regular file, whose size will never get larger than the given value.
20858
20859 In the file, Exim keeps a linear list of recipient addresses and the times at
20860 which they were sent messages. If the file is full when a new address needs to
20861 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
20862 means that a given recipient may receive multiple messages, but at
20863 unpredictable intervals that depend on the rate of turnover of addresses in the
20864 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
20865
20866
20867 .option once_file_size autoreply integer 0
20868 See &%once%& above.
20869
20870
20871 .option once_repeat autoreply time&!! 0s
20872 See &%once%& above.
20873 After expansion, the value of this option must be a valid time value.
20874
20875
20876 .option reply_to autoreply string&!! unset
20877 This specifies the contents of the &'Reply-To:'& header when the message is
20878 specified by the transport.
20879
20880
20881 .option return_message autoreply boolean false
20882 If this is set, a copy of the original message is returned with the new
20883 message, subject to the maximum size set in the &%return_size_limit%& global
20884 configuration option.
20885
20886
20887 .option subject autoreply string&!! unset
20888 This specifies the contents of the &'Subject:'& header when the message is
20889 specified by the transport. It is tempting to quote the original subject in
20890 automatic responses. For example:
20891 .code
20892 subject = Re: $h_subject:
20893 .endd
20894 There is a danger in doing this, however. It may allow a third party to
20895 subscribe your users to an opt-in mailing list, provided that the list accepts
20896 bounce messages as subscription confirmations. Well-managed lists require a
20897 non-bounce message to confirm a subscription, so the danger is relatively
20898 small.
20899
20900
20901
20902 .option text autoreply string&!! unset
20903 This specifies a single string to be used as the body of the message when the
20904 message is specified by the transport. If both &%text%& and &%file%& are set,
20905 the text comes first.
20906
20907
20908 .option to autoreply string&!! unset
20909 This specifies recipients of the message and the contents of the &'To:'& header
20910 when the message is specified by the transport.
20911 .ecindex IIDauttra1
20912 .ecindex IIDauttra2
20913
20914
20915
20916
20917 . ////////////////////////////////////////////////////////////////////////////
20918 . ////////////////////////////////////////////////////////////////////////////
20919
20920 .chapter "The lmtp transport" "CHAPLMTP"
20921 .cindex "transports" "&(lmtp)&"
20922 .cindex "&(lmtp)& transport"
20923 .cindex "LMTP" "over a pipe"
20924 .cindex "LMTP" "over a socket"
20925 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
20926 specified command
20927 or by interacting with a Unix domain socket.
20928 This transport is something of a cross between the &(pipe)& and &(smtp)&
20929 transports. Exim also has support for using LMTP over TCP/IP; this is
20930 implemented as an option for the &(smtp)& transport. Because LMTP is expected
20931 to be of minority interest, the default build-time configure in &_src/EDITME_&
20932 has it commented out. You need to ensure that
20933 .code
20934 TRANSPORT_LMTP=yes
20935 .endd
20936 .cindex "options" "&(lmtp)& transport"
20937 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
20938 included in the Exim binary. The private options of the &(lmtp)& transport are
20939 as follows:
20940
20941 .option batch_id lmtp string&!! unset
20942 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20943
20944
20945 .option batch_max lmtp integer 1
20946 This limits the number of addresses that can be handled in a single delivery.
20947 Most LMTP servers can handle several addresses at once, so it is normally a
20948 good idea to increase this value. See the description of local delivery
20949 batching in chapter &<<CHAPbatching>>&.
20950
20951
20952 .option command lmtp string&!! unset
20953 This option must be set if &%socket%& is not set. The string is a command which
20954 is run in a separate process. It is split up into a command name and list of
20955 arguments, each of which is separately expanded (so expansion cannot change the
20956 number of arguments). The command is run directly, not via a shell. The message
20957 is passed to the new process using the standard input and output to operate the
20958 LMTP protocol.
20959
20960 .option ignore_quota lmtp boolean false
20961 .cindex "LMTP" "ignoring quota errors"
20962 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
20963 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
20964 in its response to the LHLO command.
20965
20966 .option socket lmtp string&!! unset
20967 This option must be set if &%command%& is not set. The result of expansion must
20968 be the name of a Unix domain socket. The transport connects to the socket and
20969 delivers the message to it using the LMTP protocol.
20970
20971
20972 .option timeout lmtp time 5m
20973 The transport is aborted if the created process or Unix domain socket does not
20974 respond to LMTP commands or message input within this timeout. Delivery
20975 is deferred, and will be tried again later. Here is an example of a typical
20976 LMTP transport:
20977 .code
20978 lmtp:
20979   driver = lmtp
20980   command = /some/local/lmtp/delivery/program
20981   batch_max = 20
20982   user = exim
20983 .endd
20984 This delivers up to 20 addresses at a time, in a mixture of domains if
20985 necessary, running as the user &'exim'&.
20986
20987
20988
20989 . ////////////////////////////////////////////////////////////////////////////
20990 . ////////////////////////////////////////////////////////////////////////////
20991
20992 .chapter "The pipe transport" "CHAPpipetransport"
20993 .scindex IIDpiptra1 "transports" "&(pipe)&"
20994 .scindex IIDpiptra2 "&(pipe)& transport"
20995 The &(pipe)& transport is used to deliver messages via a pipe to a command
20996 running in another process. One example is the use of &(pipe)& as a
20997 pseudo-remote transport for passing messages to some other delivery mechanism
20998 (such as UUCP). Another is the use by individual users to automatically process
20999 their incoming messages. The &(pipe)& transport can be used in one of the
21000 following ways:
21001
21002 .ilist
21003 .vindex "&$local_part$&"
21004 A router routes one address to a transport in the normal way, and the
21005 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21006 contains the local part of the address (as usual), and the command that is run
21007 is specified by the &%command%& option on the transport.
21008 .next
21009 .vindex "&$pipe_addresses$&"
21010 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21011 transport can handle more than one address in a single run. In this case, when
21012 more than one address is routed to the transport, &$local_part$& is not set
21013 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21014 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21015 that are routed to the transport.
21016 .next
21017 .vindex "&$address_pipe$&"
21018 A router redirects an address directly to a pipe command (for example, from an
21019 alias or forward file). In this case, &$address_pipe$& contains the text of the
21020 pipe command, and the &%command%& option on the transport is ignored. If only
21021 one address is being transported (&%batch_max%& is not greater than one, or
21022 only one address was redirected to this pipe command), &$local_part$& contains
21023 the local part that was redirected.
21024 .endlist
21025
21026
21027 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21028 deliver messages over pipes using the LMTP interactive protocol. This is
21029 implemented by the &(lmtp)& transport.
21030
21031 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21032 &_.forward_& file, the command runs under the uid and gid of that user. In
21033 other cases, the uid and gid have to be specified explicitly, either on the
21034 transport or on the router that handles the address. Current and &"home"&
21035 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21036 details of the local delivery environment and chapter &<<CHAPbatching>>&
21037 for a discussion of local delivery batching.
21038
21039
21040 .section "Concurrent delivery" "SECID140"
21041 If two messages arrive at almost the same time, and both are routed to a pipe
21042 delivery, the two pipe transports may be run concurrently. You must ensure that
21043 any pipe commands you set up are robust against this happening. If the commands
21044 write to a file, the &%exim_lock%& utility might be of use.
21045
21046
21047
21048
21049 .section "Returned status and data" "SECID141"
21050 .cindex "&(pipe)& transport" "returned data"
21051 If the command exits with a non-zero return code, the delivery is deemed to
21052 have failed, unless either the &%ignore_status%& option is set (in which case
21053 the return code is treated as zero), or the return code is one of those listed
21054 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21055 later"&. In this case, delivery is deferred. Details of a permanent failure are
21056 logged, but are not included in the bounce message, which merely contains
21057 &"local delivery failed"&.
21058
21059 If the command exits on a signal and the &%freeze_signal%& option is set then
21060 the message will be frozen in the queue. If that option is not set, a bounce
21061 will be sent as normal.
21062
21063 If the return code is greater than 128 and the command being run is a shell
21064 script, it normally means that the script was terminated by a signal whose
21065 value is the return code minus 128. The &%freeze_signal%& option does not
21066 apply in this case.
21067
21068 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21069 return code is set to 127. This is the value that a shell returns if it is
21070 asked to run a non-existent command. The wording for the log line suggests that
21071 a non-existent command may be the problem.
21072
21073 The &%return_output%& option can affect the result of a pipe delivery. If it is
21074 set and the command produces any output on its standard output or standard
21075 error streams, the command is considered to have failed, even if it gave a zero
21076 return code or if &%ignore_status%& is set. The output from the command is
21077 included as part of the bounce message. The &%return_fail_output%& option is
21078 similar, except that output is returned only when the command exits with a
21079 failure return code, that is, a value other than zero or a code that matches
21080 &%temp_errors%&.
21081
21082
21083
21084 .section "How the command is run" "SECThowcommandrun"
21085 .cindex "&(pipe)& transport" "path for command"
21086 The command line is (by default) broken down into a command name and arguments
21087 by the &(pipe)& transport itself. The &%allow_commands%& and
21088 &%restrict_to_path%& options can be used to restrict the commands that may be
21089 run.
21090
21091 .cindex "quoting" "in pipe command"
21092 Unquoted arguments are delimited by white space. If an argument appears in
21093 double quotes, backslash is interpreted as an escape character in the usual
21094 way. If an argument appears in single quotes, no escaping is done.
21095
21096 String expansion is applied to the command line except when it comes from a
21097 traditional &_.forward_& file (commands from a filter file are expanded). The
21098 expansion is applied to each argument in turn rather than to the whole line.
21099 For this reason, any string expansion item that contains white space must be
21100 quoted so as to be contained within a single argument. A setting such as
21101 .code
21102 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21103 .endd
21104 will not work, because the expansion item gets split between several
21105 arguments. You have to write
21106 .code
21107 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21108 .endd
21109 to ensure that it is all in one argument. The expansion is done in this way,
21110 argument by argument, so that the number of arguments cannot be changed as a
21111 result of expansion, and quotes or backslashes in inserted variables do not
21112 interact with external quoting. However, this leads to problems if you want to
21113 generate multiple arguments (or the command name plus arguments) from a single
21114 expansion. In this situation, the simplest solution is to use a shell. For
21115 example:
21116 .code
21117 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21118 .endd
21119
21120 .cindex "transport" "filter"
21121 .cindex "filter" "transport filter"
21122 .vindex "&$pipe_addresses$&"
21123 Special handling takes place when an argument consists of precisely the text
21124 &`$pipe_addresses`&. This is not a general expansion variable; the only
21125 place this string is recognized is when it appears as an argument for a pipe or
21126 transport filter command. It causes each address that is being handled to be
21127 inserted in the argument list at that point &'as a separate argument'&. This
21128 avoids any problems with spaces or shell metacharacters, and is of use when a
21129 &(pipe)& transport is handling groups of addresses in a batch.
21130
21131 After splitting up into arguments and expansion, the resulting command is run
21132 in a subprocess directly from the transport, &'not'& under a shell. The
21133 message that is being delivered is supplied on the standard input, and the
21134 standard output and standard error are both connected to a single pipe that is
21135 read by Exim. The &%max_output%& option controls how much output the command
21136 may produce, and the &%return_output%& and &%return_fail_output%& options
21137 control what is done with it.
21138
21139 Not running the command under a shell (by default) lessens the security risks
21140 in cases when a command from a user's filter file is built out of data that was
21141 taken from an incoming message. If a shell is required, it can of course be
21142 explicitly specified as the command to be run. However, there are circumstances
21143 where existing commands (for example, in &_.forward_& files) expect to be run
21144 under a shell and cannot easily be modified. To allow for these cases, there is
21145 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21146 works. Instead of breaking up the command line as just described, it expands it
21147 as a single string and passes the result to &_/bin/sh_&. The
21148 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21149 with &%use_shell%&, and the whole mechanism is inherently less secure.
21150
21151
21152
21153 .section "Environment variables" "SECTpipeenv"
21154 .cindex "&(pipe)& transport" "environment for command"
21155 .cindex "environment for pipe transport"
21156 The environment variables listed below are set up when the command is invoked.
21157 This list is a compromise for maximum compatibility with other MTAs. Note that
21158 the &%environment%& option can be used to add additional variables to this
21159 environment.
21160 .display
21161 &`DOMAIN            `&   the domain of the address
21162 &`HOME              `&   the home directory, if set
21163 &`HOST              `&   the host name when called from a router (see below)
21164 &`LOCAL_PART        `&   see below
21165 &`LOCAL_PART_PREFIX `&   see below
21166 &`LOCAL_PART_SUFFIX `&   see below
21167 &`LOGNAME           `&   see below
21168 &`MESSAGE_ID        `&   Exim's local ID for the message
21169 &`PATH              `&   as specified by the &%path%& option below
21170 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21171 &`RECIPIENT         `&   the complete recipient address
21172 &`SENDER            `&   the sender of the message (empty if a bounce)
21173 &`SHELL             `&   &`/bin/sh`&
21174 &`TZ                `&   the value of the &%timezone%& option, if set
21175 &`USER              `&   see below
21176 .endd
21177 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21178 router, LOCAL_PART is set to the local part of the address. When it is
21179 called as a result of a forward or alias expansion, LOCAL_PART is set to
21180 the local part of the address that was expanded. In both cases, any affixes are
21181 removed from the local part, and made available in LOCAL_PART_PREFIX and
21182 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21183 same value as LOCAL_PART for compatibility with other MTAs.
21184
21185 .cindex "HOST"
21186 HOST is set only when a &(pipe)& transport is called from a router that
21187 associates hosts with an address, typically when using &(pipe)& as a
21188 pseudo-remote transport. HOST is set to the first host name specified by
21189 the router.
21190
21191 .cindex "HOME"
21192 If the transport's generic &%home_directory%& option is set, its value is used
21193 for the HOME environment variable. Otherwise, a home directory may be set
21194 by the router's &%transport_home_directory%& option, which defaults to the
21195 user's home directory if &%check_local_user%& is set.
21196
21197
21198 .section "Private options for pipe" "SECID142"
21199 .cindex "options" "&(pipe)& transport"
21200
21201
21202
21203 .option allow_commands pipe "string list&!!" unset
21204 .cindex "&(pipe)& transport" "permitted commands"
21205 The string is expanded, and is then interpreted as a colon-separated list of
21206 permitted commands. If &%restrict_to_path%& is not set, the only commands
21207 permitted are those in the &%allow_commands%& list. They need not be absolute
21208 paths; the &%path%& option is still used for relative paths. If
21209 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21210 in the &%allow_commands%& list, or a name without any slashes that is found on
21211 the path. In other words, if neither &%allow_commands%& nor
21212 &%restrict_to_path%& is set, there is no restriction on the command, but
21213 otherwise only commands that are permitted by one or the other are allowed. For
21214 example, if
21215 .code
21216 allow_commands = /usr/bin/vacation
21217 .endd
21218 and &%restrict_to_path%& is not set, the only permitted command is
21219 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21220 &%use_shell%& is set.
21221
21222
21223 .option batch_id pipe string&!! unset
21224 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21225
21226
21227 .option batch_max pipe integer 1
21228 This limits the number of addresses that can be handled in a single delivery.
21229 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21230
21231
21232 .option check_string pipe string unset
21233 As &(pipe)& writes the message, the start of each line is tested for matching
21234 &%check_string%&, and if it does, the initial matching characters are replaced
21235 by the contents of &%escape_string%&, provided both are set. The value of
21236 &%check_string%& is a literal string, not a regular expression, and the case of
21237 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21238 of &%check_string%& and &%escape_string%& are forced to values that implement
21239 the SMTP escaping protocol. Any settings made in the configuration file are
21240 ignored.
21241
21242
21243 .option command pipe string&!! unset
21244 This option need not be set when &(pipe)& is being used to deliver to pipes
21245 obtained directly from address redirections. In other cases, the option must be
21246 set, to provide a command to be run. It need not yield an absolute path (see
21247 the &%path%& option below). The command is split up into separate arguments by
21248 Exim, and each argument is separately expanded, as described in section
21249 &<<SECThowcommandrun>>& above.
21250
21251
21252 .option environment pipe string&!! unset
21253 .cindex "&(pipe)& transport" "environment for command"
21254 .cindex "environment for &(pipe)& transport"
21255 This option is used to add additional variables to the environment in which the
21256 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21257 a string which is expanded, and then interpreted as a colon-separated list of
21258 environment settings of the form <&'name'&>=<&'value'&>.
21259
21260
21261 .option escape_string pipe string unset
21262 See &%check_string%& above.
21263
21264
21265 .option freeze_exec_fail pipe boolean false
21266 .cindex "exec failure"
21267 .cindex "failure of exec"
21268 .cindex "&(pipe)& transport" "failure of exec"
21269 Failure to exec the command in a pipe transport is by default treated like
21270 any other failure while running the command. However, if &%freeze_exec_fail%&
21271 is set, failure to exec is treated specially, and causes the message to be
21272 frozen, whatever the setting of &%ignore_status%&.
21273
21274
21275 .option freeze_signal pipe boolean false
21276 .cindex "signal exit"
21277 .cindex "&(pipe)& transport", "signal exit"
21278 Normally if the process run by a command in a pipe transport exits on a signal,
21279 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21280 frozen in Exim's queue instead.
21281
21282
21283 .option ignore_status pipe boolean false
21284 If this option is true, the status returned by the subprocess that is set up to
21285 run the command is ignored, and Exim behaves as if zero had been returned.
21286 Otherwise, a non-zero status or termination by signal causes an error return
21287 from the transport unless the status value is one of those listed in
21288 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21289
21290 &*Note*&: This option does not apply to timeouts, which do not return a status.
21291 See the &%timeout_defer%& option for how timeouts are handled.
21292
21293 .option log_defer_output pipe boolean false
21294 .cindex "&(pipe)& transport" "logging output"
21295 If this option is set, and the status returned by the command is
21296 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21297 and any output was produced, the first line of it is written to the main log.
21298
21299
21300 .option log_fail_output pipe boolean false
21301 If this option is set, and the command returns any output, and also ends with a
21302 return code that is neither zero nor one of the return codes listed in
21303 &%temp_errors%& (that is, the delivery failed), the first line of output is
21304 written to the main log. This option and &%log_output%& are mutually exclusive.
21305 Only one of them may be set.
21306
21307
21308
21309 .option log_output pipe boolean false
21310 If this option is set and the command returns any output, the first line of
21311 output is written to the main log, whatever the return code. This option and
21312 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21313
21314
21315
21316 .option max_output pipe integer 20K
21317 This specifies the maximum amount of output that the command may produce on its
21318 standard output and standard error file combined. If the limit is exceeded, the
21319 process running the command is killed. This is intended as a safety measure to
21320 catch runaway processes. The limit is applied independently of the settings of
21321 the options that control what is done with such output (for example,
21322 &%return_output%&). Because of buffering effects, the amount of output may
21323 exceed the limit by a small amount before Exim notices.
21324
21325
21326 .option message_prefix pipe string&!! "see below"
21327 The string specified here is expanded and output at the start of every message.
21328 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21329 .code
21330 message_prefix = \
21331   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21332   ${tod_bsdinbox}\n
21333 .endd
21334 .cindex "Cyrus"
21335 .cindex "&%tmail%&"
21336 .cindex "&""From""& line"
21337 This is required by the commonly used &_/usr/bin/vacation_& program.
21338 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21339 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21340 setting
21341 .code
21342 message_prefix =
21343 .endd
21344 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21345 &`\n`& to &`\r\n`& in &%message_prefix%&.
21346
21347
21348 .option message_suffix pipe string&!! "see below"
21349 The string specified here is expanded and output at the end of every message.
21350 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21351 The suffix can be suppressed by setting
21352 .code
21353 message_suffix =
21354 .endd
21355 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21356 &`\n`& to &`\r\n`& in &%message_suffix%&.
21357
21358
21359 .option path pipe string "see below"
21360 This option specifies the string that is set up in the PATH environment
21361 variable of the subprocess. The default is:
21362 .code
21363 /bin:/usr/bin
21364 .endd
21365 If the &%command%& option does not yield an absolute path name, the command is
21366 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21367 apply to a command specified as a transport filter.
21368
21369
21370 .option permit_coredump pipe boolean false
21371 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21372 a core-dump of a pipe command, enable this command.  This enables core-dumps
21373 during delivery and affects both the Exim binary and the pipe command run.
21374 It is recommended that this option remain off unless and until you have a need
21375 for it and that this only be enabled when needed, as the risk of excessive
21376 resource consumption can be quite high.  Note also that Exim is typically
21377 installed as a setuid binary and most operating systems will inhibit coredumps
21378 of these by default, so further OS-specific action may be required.
21379
21380
21381 .option pipe_as_creator pipe boolean false
21382 .cindex "uid (user id)" "local delivery"
21383 If the generic &%user%& option is not set and this option is true, the delivery
21384 process is run under the uid that was in force when Exim was originally called
21385 to accept the message. If the group id is not otherwise set (via the generic
21386 &%group%& option), the gid that was in force when Exim was originally called to
21387 accept the message is used.
21388
21389
21390 .option restrict_to_path pipe boolean false
21391 When this option is set, any command name not listed in &%allow_commands%& must
21392 contain no slashes. The command is searched for only in the directories listed
21393 in the &%path%& option. This option is intended for use in the case when a pipe
21394 command has been generated from a user's &_.forward_& file. This is usually
21395 handled by a &(pipe)& transport called &%address_pipe%&.
21396
21397
21398 .option return_fail_output pipe boolean false
21399 If this option is true, and the command produced any output and ended with a
21400 return code other than zero or one of the codes listed in &%temp_errors%& (that
21401 is, the delivery failed), the output is returned in the bounce message.
21402 However, if the message has a null sender (that is, it is itself a bounce
21403 message), output from the command is discarded. This option and
21404 &%return_output%& are mutually exclusive. Only one of them may be set.
21405
21406
21407
21408 .option return_output pipe boolean false
21409 If this option is true, and the command produced any output, the delivery is
21410 deemed to have failed whatever the return code from the command, and the output
21411 is returned in the bounce message. Otherwise, the output is just discarded.
21412 However, if the message has a null sender (that is, it is a bounce message),
21413 output from the command is always discarded, whatever the setting of this
21414 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21415 of them may be set.
21416
21417
21418
21419 .option temp_errors pipe "string list" "see below"
21420 .cindex "&(pipe)& transport" "temporary failure"
21421 This option contains either a colon-separated list of numbers, or a single
21422 asterisk. If &%ignore_status%& is false
21423 and &%return_output%& is not set,
21424 and the command exits with a non-zero return code, the failure is treated as
21425 temporary and the delivery is deferred if the return code matches one of the
21426 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21427 codes are treated as permanent errors. The default setting contains the codes
21428 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21429 compiled on a system that does not define these macros, it assumes values of 75
21430 and 73, respectively.
21431
21432
21433 .option timeout pipe time 1h
21434 If the command fails to complete within this time, it is killed. This normally
21435 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21436 specifies no timeout. In order to ensure that any subprocesses created by the
21437 command are also killed, Exim makes the initial process a process group leader,
21438 and kills the whole process group on a timeout. However, this can be defeated
21439 if one of the processes starts a new process group.
21440
21441 .option timeout_defer pipe boolean false
21442 A timeout in a &(pipe)& transport, either in the command that the transport
21443 runs, or in a transport filter that is associated with it, is by default
21444 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21445 is set true, both kinds of timeout become temporary errors, causing the
21446 delivery to be deferred.
21447
21448 .option umask pipe "octal integer" 022
21449 This specifies the umask setting for the subprocess that runs the command.
21450
21451
21452 .option use_bsmtp pipe boolean false
21453 .cindex "envelope sender"
21454 If this option is set true, the &(pipe)& transport writes messages in &"batch
21455 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21456 commands. If you want to include a leading HELO command with such messages,
21457 you can do so by setting the &%message_prefix%& option. See section
21458 &<<SECTbatchSMTP>>& for details of batch SMTP.
21459
21460 .option use_classresources pipe boolean false
21461 .cindex "class resources (BSD)"
21462 This option is available only when Exim is running on FreeBSD, NetBSD, or
21463 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21464 resource limits when a &(pipe)& transport is run to perform a delivery. The
21465 limits for the uid under which the pipe is to run are obtained from the login
21466 class database.
21467
21468
21469 .option use_crlf pipe boolean false
21470 .cindex "carriage return"
21471 .cindex "linefeed"
21472 This option causes lines to be terminated with the two-character CRLF sequence
21473 (carriage return, linefeed) instead of just a linefeed character. In the case
21474 of batched SMTP, the byte sequence written to the pipe is then an exact image
21475 of what would be sent down a real SMTP connection.
21476
21477 The contents of the &%message_prefix%& and &%message_suffix%& options are
21478 written verbatim, so must contain their own carriage return characters if these
21479 are needed. When &%use_bsmtp%& is not set, the default values for both
21480 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21481 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21482
21483
21484 .option use_shell pipe boolean false
21485 .vindex "&$pipe_addresses$&"
21486 If this option is set, it causes the command to be passed to &_/bin/sh_&
21487 instead of being run directly from the transport, as described in section
21488 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21489 where the command is expected to be run under a shell and cannot easily be
21490 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21491 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21492 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21493 its &%-c%& option.
21494
21495
21496
21497 .section "Using an external local delivery agent" "SECID143"
21498 .cindex "local delivery" "using an external agent"
21499 .cindex "&'procmail'&"
21500 .cindex "external local delivery"
21501 .cindex "delivery" "&'procmail'&"
21502 .cindex "delivery" "by external agent"
21503 The &(pipe)& transport can be used to pass all messages that require local
21504 delivery to a separate local delivery agent such as &%procmail%&. When doing
21505 this, care must be taken to ensure that the pipe is run under an appropriate
21506 uid and gid. In some configurations one wants this to be a uid that is trusted
21507 by the delivery agent to supply the correct sender of the message. It may be
21508 necessary to recompile or reconfigure the delivery agent so that it trusts an
21509 appropriate user. The following is an example transport and router
21510 configuration for &%procmail%&:
21511 .code
21512 # transport
21513 procmail_pipe:
21514   driver = pipe
21515   command = /usr/local/bin/procmail -d $local_part
21516   return_path_add
21517   delivery_date_add
21518   envelope_to_add
21519   check_string = "From "
21520   escape_string = ">From "
21521   umask = 077
21522   user = $local_part
21523   group = mail
21524
21525 # router
21526 procmail:
21527   driver = accept
21528   check_local_user
21529   transport = procmail_pipe
21530 .endd
21531 In this example, the pipe is run as the local user, but with the group set to
21532 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21533 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21534 user to supply a correct sender address. If you do not specify either a
21535 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21536 home directory is the user's home directory by default.
21537
21538 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21539 .code
21540 IFS=" "
21541 .endd
21542 as shown in some &%procmail%& documentation, because Exim does not by default
21543 use a shell to run pipe commands.
21544
21545 .cindex "Cyrus"
21546 The next example shows a transport and a router for a system where local
21547 deliveries are handled by the Cyrus IMAP server.
21548 .code
21549 # transport
21550 local_delivery_cyrus:
21551   driver = pipe
21552   command = /usr/cyrus/bin/deliver \
21553             -m ${substr_1:$local_part_suffix} -- $local_part
21554   user = cyrus
21555   group = mail
21556   return_output
21557   log_output
21558   message_prefix =
21559   message_suffix =
21560
21561 # router
21562 local_user_cyrus:
21563   driver = accept
21564   check_local_user
21565   local_part_suffix = .*
21566   transport = local_delivery_cyrus
21567 .endd
21568 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21569 &%return_output%& to cause any text written by Cyrus to be returned to the
21570 sender.
21571 .ecindex IIDpiptra1
21572 .ecindex IIDpiptra2
21573
21574
21575 . ////////////////////////////////////////////////////////////////////////////
21576 . ////////////////////////////////////////////////////////////////////////////
21577
21578 .chapter "The smtp transport" "CHAPsmtptrans"
21579 .scindex IIDsmttra1 "transports" "&(smtp)&"
21580 .scindex IIDsmttra2 "&(smtp)& transport"
21581 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21582 or LMTP protocol. The list of hosts to try can either be taken from the address
21583 that is being processed (having been set up by the router), or specified
21584 explicitly for the transport. Timeout and retry processing (see chapter
21585 &<<CHAPretry>>&) is applied to each IP address independently.
21586
21587
21588 .section "Multiple messages on a single connection" "SECID144"
21589 The sending of multiple messages over a single TCP/IP connection can arise in
21590 two ways:
21591
21592 .ilist
21593 If a message contains more than &%max_rcpt%& (see below) addresses that are
21594 routed to the same host, more than one copy of the message has to be sent to
21595 that host. In this situation, multiple copies may be sent in a single run of
21596 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21597 does when it has too many addresses to send in one message also depends on the
21598 value of the global &%remote_max_parallel%& option. Details are given in
21599 section &<<SECToutSMTPTCP>>&.)
21600 .next
21601 .cindex "hints database" "remembering routing"
21602 When a message has been successfully delivered over a TCP/IP connection, Exim
21603 looks in its hints database to see if there are any other messages awaiting a
21604 connection to the same host. If there are, a new delivery process is started
21605 for one of them, and the current TCP/IP connection is passed on to it. The new
21606 process may in turn send multiple copies and possibly create yet another
21607 process.
21608 .endlist
21609
21610
21611 For each copy sent over the same TCP/IP connection, a sequence counter is
21612 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21613 no further messages are sent over that connection.
21614
21615
21616
21617 .section "Use of the $host and $host_address variables" "SECID145"
21618 .vindex "&$host$&"
21619 .vindex "&$host_address$&"
21620 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21621 &$host_address$& are the name and IP address of the first host on the host list
21622 passed by the router. However, when the transport is about to connect to a
21623 specific host, and while it is connected to that host, &$host$& and
21624 &$host_address$& are set to the values for that host. These are the values
21625 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21626 &%serialize_hosts%&, and the various TLS options are expanded.
21627
21628
21629 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21630 .vindex &$tls_cipher$&
21631 .vindex &$tls_peerdn$&
21632 At the start of a run of the &(smtp)& transport, the values of &$tls_cipher$&
21633 and &$tls_peerdn$& are the values that were set when the message was received.
21634 These are the values that are used for options that are expanded before any
21635 SMTP connections are made. Just before each connection is made, these two
21636 variables are emptied. If TLS is subsequently started, they are set to the
21637 appropriate values for the outgoing connection, and these are the values that
21638 are in force when any authenticators are run and when the
21639 &%authenticated_sender%& option is expanded.
21640
21641
21642 .section "Private options for smtp" "SECID146"
21643 .cindex "options" "&(smtp)& transport"
21644 The private options of the &(smtp)& transport are as follows:
21645
21646
21647 .option address_retry_include_sender smtp boolean true
21648 .cindex "4&'xx'& responses" "retrying after"
21649 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21650 is the combination of sender and recipient that is delayed in subsequent queue
21651 runs until the retry time is reached. You can delay the recipient without
21652 reference to the sender (which is what earlier versions of Exim did), by
21653 setting &%address_retry_include_sender%& false. However, this can lead to
21654 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21655
21656 .option allow_localhost smtp boolean false
21657 .cindex "local host" "sending to"
21658 .cindex "fallback" "hosts specified on transport"
21659 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21660 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21661 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21662 the delivery anyway. This should be used only in special cases when the
21663 configuration ensures that no looping will result (for example, a differently
21664 configured Exim is listening on the port to which the message is sent).
21665
21666
21667 .option authenticated_sender smtp string&!! unset
21668 .cindex "Cyrus"
21669 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21670 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21671 overriding any existing authenticated sender value. If the string expansion is
21672 forced to fail, the option is ignored. Other expansion failures cause delivery
21673 to be deferred. If the result of expansion is an empty string, that is also
21674 ignored.
21675
21676 The expansion happens after the outgoing connection has been made and TLS
21677 started, if required. This means that the &$host$&, &$host_address$&,
21678 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21679 particular connection.
21680
21681 If the SMTP session is not authenticated, the expansion of
21682 &%authenticated_sender%& still happens (and can cause the delivery to be
21683 deferred if it fails), but no AUTH= item is added to MAIL commands
21684 unless &%authenticated_sender_force%& is true.
21685
21686 This option allows you to use the &(smtp)& transport in LMTP mode to
21687 deliver mail to Cyrus IMAP and provide the proper local part as the
21688 &"authenticated sender"&, via a setting such as:
21689 .code
21690 authenticated_sender = $local_part
21691 .endd
21692 This removes the need for IMAP subfolders to be assigned special ACLs to
21693 allow direct delivery to those subfolders.
21694
21695 Because of expected uses such as that just described for Cyrus (when no
21696 domain is involved), there is no checking on the syntax of the provided
21697 value.
21698
21699
21700 .option authenticated_sender_force smtp boolean false
21701 If this option is set true, the &%authenticated_sender%& option's value
21702 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21703 authenticated as a client.
21704
21705
21706 .option command_timeout smtp time 5m
21707 This sets a timeout for receiving a response to an SMTP command that has been
21708 sent out. It is also used when waiting for the initial banner line from the
21709 remote host. Its value must not be zero.
21710
21711
21712 .option connect_timeout smtp time 5m
21713 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21714 to a remote host. A setting of zero allows the system timeout (typically
21715 several minutes) to act. To have any effect, the value of this option must be
21716 less than the system timeout. However, it has been observed that on some
21717 systems there is no system timeout, which is why the default value for this
21718 option is 5 minutes, a value recommended by RFC 1123.
21719
21720
21721 .option connection_max_messages smtp integer 500
21722 .cindex "SMTP" "passed connection"
21723 .cindex "SMTP" "multiple deliveries"
21724 .cindex "multiple SMTP deliveries"
21725 This controls the maximum number of separate message deliveries that are sent
21726 over a single TCP/IP connection. If the value is zero, there is no limit.
21727 For testing purposes, this value can be overridden by the &%-oB%& command line
21728 option.
21729
21730
21731 .option data_timeout smtp time 5m
21732 This sets a timeout for the transmission of each block in the data portion of
21733 the message. As a result, the overall timeout for a message depends on the size
21734 of the message. Its value must not be zero. See also &%final_timeout%&.
21735
21736
21737 .option delay_after_cutoff smtp boolean true
21738 This option controls what happens when all remote IP addresses for a given
21739 domain have been inaccessible for so long that they have passed their retry
21740 cutoff times.
21741
21742 In the default state, if the next retry time has not been reached for any of
21743 them, the address is bounced without trying any deliveries. In other words,
21744 Exim delays retrying an IP address after the final cutoff time until a new
21745 retry time is reached, and can therefore bounce an address without ever trying
21746 a delivery, when machines have been down for a long time. Some people are
21747 unhappy at this prospect, so...
21748
21749 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
21750 addresses are past their final cutoff time, Exim tries to deliver to those
21751 IP addresses that have not been tried since the message arrived. If there are
21752 none, of if they all fail, the address is bounced. In other words, it does not
21753 delay when a new message arrives, but immediately tries those expired IP
21754 addresses that haven't been tried since the message arrived. If there is a
21755 continuous stream of messages for the dead hosts, unsetting
21756 &%delay_after_cutoff%& means that there will be many more attempts to deliver
21757 to them.
21758
21759
21760 .option dns_qualify_single smtp boolean true
21761 If the &%hosts%& or &%fallback_hosts%& option is being used,
21762 and the &%gethostbyname%& option is false,
21763 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
21764 in chapter &<<CHAPdnslookup>>& for more details.
21765
21766
21767 .option dns_search_parents smtp boolean false
21768 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
21769 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
21770 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
21771 details.
21772
21773
21774
21775 .option fallback_hosts smtp "string list" unset
21776 .cindex "fallback" "hosts specified on transport"
21777 String expansion is not applied to this option. The argument must be a
21778 colon-separated list of host names or IP addresses, optionally also including
21779 port numbers, though the separator can be changed, as described in section
21780 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21781 item in a &%route_list%& setting for the &(manualroute)& router, as described
21782 in section &<<SECTformatonehostitem>>&.
21783
21784 Fallback hosts can also be specified on routers, which associate them with the
21785 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
21786 &%fallback_hosts%& specified on the transport is used only if the address does
21787 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
21788 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
21789 However, &%hosts_randomize%& does apply to fallback host lists.
21790
21791 If Exim is unable to deliver to any of the hosts for a particular address, and
21792 the errors are not permanent rejections, the address is put on a separate
21793 transport queue with its host list replaced by the fallback hosts, unless the
21794 address was routed via MX records and the current host was in the original MX
21795 list. In that situation, the fallback host list is not used.
21796
21797 Once normal deliveries are complete, the fallback queue is delivered by
21798 re-running the same transports with the new host lists. If several failing
21799 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
21800 copy of the message is sent.
21801
21802 The resolution of the host names on the fallback list is controlled by the
21803 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
21804 both to cases when the host list comes with the address and when it is taken
21805 from &%hosts%&. This option provides a &"use a smart host only if delivery
21806 fails"& facility.
21807
21808
21809 .option final_timeout smtp time 10m
21810 This is the timeout that applies while waiting for the response to the final
21811 line containing just &"."& that terminates a message. Its value must not be
21812 zero.
21813
21814 .option gethostbyname smtp boolean false
21815 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
21816 being used, names are looked up using &[gethostbyname()]&
21817 (or &[getipnodebyname()]& when available)
21818 instead of using the DNS. Of course, that function may in fact use the DNS, but
21819 it may also consult other sources of information such as &_/etc/hosts_&.
21820
21821 .option gnutls_require_kx smtp string unset
21822 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
21823 client. For details, see section &<<SECTreqciphgnu>>&.
21824
21825 .option gnutls_require_mac smtp string unset
21826 This option controls the MAC algorithms when GnuTLS is used in an Exim
21827 client. For details, see section &<<SECTreqciphgnu>>&.
21828
21829 .option gnutls_require_protocols smtp string unset
21830 This option controls the protocols when GnuTLS is used in an Exim
21831 client. For details, see section &<<SECTreqciphgnu>>&.
21832
21833 .option gnutls_compat_mode smtp boolean unset
21834 This option controls whether GnuTLS is used in compatibility mode in an Exim
21835 server. This reduces security slightly, but improves interworking with older
21836 implementations of TLS.
21837
21838 .option helo_data smtp string&!! "see below"
21839 .cindex "HELO" "argument, setting"
21840 .cindex "EHLO" "argument, setting"
21841 .cindex "LHLO argument setting"
21842 The value of this option is expanded after a connection to a another host has
21843 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
21844 command that starts the outgoing SMTP or LMTP session. The default value of the
21845 option is:
21846 .code
21847 $primary_hostname
21848 .endd
21849 During the expansion, the variables &$host$& and &$host_address$& are set to
21850 the identity of the remote host, and the variables &$sending_ip_address$& and
21851 &$sending_port$& are set to the local IP address and port number that are being
21852 used. These variables can be used to generate different values for different
21853 servers or different local IP addresses. For example, if you want the string
21854 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
21855 interface address, you could use this:
21856 .code
21857 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
21858   {$primary_hostname}}
21859 .endd
21860 The use of &%helo_data%& applies both to sending messages and when doing
21861 callouts.
21862
21863 .option hosts smtp "string list&!!" unset
21864 Hosts are associated with an address by a router such as &(dnslookup)&, which
21865 finds the hosts by looking up the address domain in the DNS, or by
21866 &(manualroute)&, which has lists of hosts in its configuration. However,
21867 email addresses can be passed to the &(smtp)& transport by any router, and not
21868 all of them can provide an associated list of hosts.
21869
21870 The &%hosts%& option specifies a list of hosts to be used if the address being
21871 processed does not have any hosts associated with it. The hosts specified by
21872 &%hosts%& are also used, whether or not the address has its own hosts, if
21873 &%hosts_override%& is set.
21874
21875 The string is first expanded, before being interpreted as a colon-separated
21876 list of host names or IP addresses, possibly including port numbers. The
21877 separator may be changed to something other than colon, as described in section
21878 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21879 item in a &%route_list%& setting for the &(manualroute)& router, as described
21880 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
21881 of the &(manualroute)& router is not available here.
21882
21883 If the expansion fails, delivery is deferred. Unless the failure was caused by
21884 the inability to complete a lookup, the error is logged to the panic log as
21885 well as the main log. Host names are looked up either by searching directly for
21886 address records in the DNS or by calling &[gethostbyname()]& (or
21887 &[getipnodebyname()]& when available), depending on the setting of the
21888 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
21889 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
21890 address are used.
21891
21892 During delivery, the hosts are tried in order, subject to their retry status,
21893 unless &%hosts_randomize%& is set.
21894
21895
21896 .option hosts_avoid_esmtp smtp "host list&!!" unset
21897 .cindex "ESMTP, avoiding use of"
21898 .cindex "HELO" "forcing use of"
21899 .cindex "EHLO" "avoiding use of"
21900 .cindex "PIPELINING" "avoiding the use of"
21901 This option is for use with broken hosts that announce ESMTP facilities (for
21902 example, PIPELINING) and then fail to implement them properly. When a host
21903 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
21904 start of the SMTP session. This means that it cannot use any of the ESMTP
21905 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
21906
21907
21908 .option hosts_avoid_pipelining smtp "host list&!!" unset
21909 .cindex "PIPELINING" "avoiding the use of"
21910 Exim will not use the SMTP PIPELINING extension when delivering to any host
21911 that matches this list, even if the server host advertises PIPELINING support.
21912
21913
21914 .option hosts_avoid_tls smtp "host list&!!" unset
21915 .cindex "TLS" "avoiding for certain hosts"
21916 Exim will not try to start a TLS session when delivering to any host that
21917 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21918
21919
21920 .option hosts_max_try smtp integer 5
21921 .cindex "host" "maximum number to try"
21922 .cindex "limit" "number of hosts tried"
21923 .cindex "limit" "number of MX tried"
21924 .cindex "MX record" "maximum tried"
21925 This option limits the number of IP addresses that are tried for any one
21926 delivery in cases where there are temporary delivery errors. Section
21927 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
21928
21929
21930 .option hosts_max_try_hardlimit smtp integer 50
21931 This is an additional check on the maximum number of IP addresses that Exim
21932 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
21933 why it exists.
21934
21935
21936
21937 .option hosts_nopass_tls smtp "host list&!!" unset
21938 .cindex "TLS" "passing connection"
21939 .cindex "multiple SMTP deliveries"
21940 .cindex "TLS" "multiple message deliveries"
21941 For any host that matches this list, a connection on which a TLS session has
21942 been started will not be passed to a new delivery process for sending another
21943 message on the same connection. See section &<<SECTmulmessam>>& for an
21944 explanation of when this might be needed.
21945
21946
21947 .option hosts_override smtp boolean false
21948 If this option is set and the &%hosts%& option is also set, any hosts that are
21949 attached to the address are ignored, and instead the hosts specified by the
21950 &%hosts%& option are always used. This option does not apply to
21951 &%fallback_hosts%&.
21952
21953
21954 .option hosts_randomize smtp boolean false
21955 .cindex "randomized host list"
21956 .cindex "host" "list of; randomized"
21957 .cindex "fallback" "randomized hosts"
21958 If this option is set, and either the list of hosts is taken from the
21959 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
21960 were not obtained from MX records (this includes fallback hosts from the
21961 router), and were not randomized by the router, the order of trying the hosts
21962 is randomized each time the transport runs. Randomizing the order of a host
21963 list can be used to do crude load sharing.
21964
21965 When &%hosts_randomize%& is true, a host list may be split into groups whose
21966 order is separately randomized. This makes it possible to set up MX-like
21967 behaviour. The boundaries between groups are indicated by an item that is just
21968 &`+`& in the host list. For example:
21969 .code
21970 hosts = host1:host2:host3:+:host4:host5
21971 .endd
21972 The order of the first three hosts and the order of the last two hosts is
21973 randomized for each use, but the first three always end up before the last two.
21974 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
21975
21976 .option hosts_require_auth smtp "host list&!!" unset
21977 .cindex "authentication" "required by client"
21978 This option provides a list of servers for which authentication must succeed
21979 before Exim will try to transfer a message. If authentication fails for
21980 servers which are not in this list, Exim tries to send unauthenticated. If
21981 authentication fails for one of these servers, delivery is deferred. This
21982 temporary error is detectable in the retry rules, so it can be turned into a
21983 hard failure if required. See also &%hosts_try_auth%&, and chapter
21984 &<<CHAPSMTPAUTH>>& for details of authentication.
21985
21986
21987 .option hosts_require_tls smtp "host list&!!" unset
21988 .cindex "TLS" "requiring for certain servers"
21989 Exim will insist on using a TLS session when delivering to any host that
21990 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21991 &*Note*&: This option affects outgoing mail only. To insist on TLS for
21992 incoming messages, use an appropriate ACL.
21993
21994 .option hosts_try_auth smtp "host list&!!" unset
21995 .cindex "authentication" "optional in client"
21996 This option provides a list of servers to which, provided they announce
21997 authentication support, Exim will attempt to authenticate as a client when it
21998 connects. If authentication fails, Exim will try to transfer the message
21999 unauthenticated. See also &%hosts_require_auth%&, and chapter
22000 &<<CHAPSMTPAUTH>>& for details of authentication.
22001
22002 .option interface smtp "string list&!!" unset
22003 .cindex "bind IP address"
22004 .cindex "IP address" "binding"
22005 .vindex "&$host$&"
22006 .vindex "&$host_address$&"
22007 This option specifies which interface to bind to when making an outgoing SMTP
22008 call. The value is an IP address, not an interface name such as
22009 &`eth0`&. Do not confuse this with the interface address that was used when a
22010 message was received, which is in &$received_ip_address$&, formerly known as
22011 &$interface_address$&. The name was changed to minimize confusion with the
22012 outgoing interface address. There is no variable that contains an outgoing
22013 interface address because, unless it is set by this option, its value is
22014 unknown.
22015
22016 During the expansion of the &%interface%& option the variables &$host$& and
22017 &$host_address$& refer to the host to which a connection is about to be made
22018 during the expansion of the string. Forced expansion failure, or an empty
22019 string result causes the option to be ignored. Otherwise, after expansion, the
22020 string must be a list of IP addresses, colon-separated by default, but the
22021 separator can be changed in the usual way. For example:
22022 .code
22023 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22024 .endd
22025 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22026 connection. If none of them are the correct type, the option is ignored. If
22027 &%interface%& is not set, or is ignored, the system's IP functions choose which
22028 interface to use if the host has more than one.
22029
22030
22031 .option keepalive smtp boolean true
22032 .cindex "keepalive" "on outgoing connection"
22033 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22034 connections. When set, it causes the kernel to probe idle connections
22035 periodically, by sending packets with &"old"& sequence numbers. The other end
22036 of the connection should send a acknowledgment if the connection is still okay
22037 or a reset if the connection has been aborted. The reason for doing this is
22038 that it has the beneficial effect of freeing up certain types of connection
22039 that can get stuck when the remote host is disconnected without tidying up the
22040 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22041 unreachable hosts.
22042
22043
22044 .option lmtp_ignore_quota smtp boolean false
22045 .cindex "LMTP" "ignoring quota errors"
22046 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22047 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22048 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22049
22050 .option max_rcpt smtp integer 100
22051 .cindex "RCPT" "maximum number of outgoing"
22052 This option limits the number of RCPT commands that are sent in a single
22053 SMTP message transaction. Each set of addresses is treated independently, and
22054 so can cause parallel connections to the same host if &%remote_max_parallel%&
22055 permits this.
22056
22057
22058 .option multi_domain smtp boolean true
22059 .vindex "&$domain$&"
22060 When this option is set, the &(smtp)& transport can handle a number of
22061 addresses containing a mixture of different domains provided they all resolve
22062 to the same list of hosts. Turning the option off restricts the transport to
22063 handling only one domain at a time. This is useful if you want to use
22064 &$domain$& in an expansion for the transport, because it is set only when there
22065 is a single domain involved in a remote delivery.
22066
22067
22068 .option port smtp string&!! "see below"
22069 .cindex "port" "sending TCP/IP"
22070 .cindex "TCP/IP" "setting outgoing port"
22071 This option specifies the TCP/IP port on the server to which Exim connects.
22072 &*Note:*& Do not confuse this with the port that was used when a message was
22073 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22074 The name was changed to minimize confusion with the outgoing port. There is no
22075 variable that contains an outgoing port.
22076
22077 If the value of this option begins with a digit it is taken as a port number;
22078 otherwise it is looked up using &[getservbyname()]&. The default value is
22079 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22080 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22081 is deferred.
22082
22083
22084
22085 .option protocol smtp string smtp
22086 .cindex "LMTP" "over TCP/IP"
22087 .cindex "ssmtp protocol" "outbound"
22088 .cindex "TLS" "SSL-on-connect outbound"
22089 .vindex "&$port$&"
22090 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22091 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22092 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22093 deliveries into closed message stores. Exim also has support for running LMTP
22094 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22095
22096 .new
22097 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22098 changes to &"smtps"&, and the transport initiates TLS immediately after
22099 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22100 The Internet standards bodies strongly discourage use of this mode.
22101 .wen
22102
22103
22104 .option retry_include_ip_address smtp boolean true
22105 Exim normally includes both the host name and the IP address in the key it
22106 constructs for indexing retry data after a temporary delivery failure. This
22107 means that when one of several IP addresses for a host is failing, it gets
22108 tried periodically (controlled by the retry rules), but use of the other IP
22109 addresses is not affected.
22110
22111 However, in some dialup environments hosts are assigned a different IP address
22112 each time they connect. In this situation the use of the IP address as part of
22113 the retry key leads to undesirable behaviour. Setting this option false causes
22114 Exim to use only the host name. This should normally be done on a separate
22115 instance of the &(smtp)& transport, set up specially to handle the dialup
22116 hosts.
22117
22118
22119 .option serialize_hosts smtp "host list&!!" unset
22120 .cindex "serializing connections"
22121 .cindex "host" "serializing connections"
22122 Because Exim operates in a distributed manner, if several messages for the same
22123 host arrive at around the same time, more than one simultaneous connection to
22124 the remote host can occur. This is not usually a problem except when there is a
22125 slow link between the hosts. In that situation it may be helpful to restrict
22126 Exim to one connection at a time. This can be done by setting
22127 &%serialize_hosts%& to match the relevant hosts.
22128
22129 .cindex "hints database" "serializing deliveries to a host"
22130 Exim implements serialization by means of a hints database in which a record is
22131 written whenever a process connects to one of the restricted hosts. The record
22132 is deleted when the connection is completed. Obviously there is scope for
22133 records to get left lying around if there is a system or program crash. To
22134 guard against this, Exim ignores any records that are more than six hours old.
22135
22136 If you set up this kind of serialization, you should also arrange to delete the
22137 relevant hints database whenever your system reboots. The names of the files
22138 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22139 may be one or two files, depending on the type of DBM in use. The same files
22140 are used for ETRN serialization.
22141
22142
22143 .option size_addition smtp integer 1024
22144 .cindex "SMTP" "SIZE"
22145 .cindex "message" "size issue for transport filter"
22146 .cindex "size" "of message"
22147 .cindex "transport" "filter"
22148 .cindex "filter" "transport filter"
22149 If a remote SMTP server indicates that it supports the SIZE option of the
22150 MAIL command, Exim uses this to pass over the message size at the start of
22151 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22152 sends, to allow for headers and other text that may be added during delivery by
22153 configuration options or in a transport filter. It may be necessary to increase
22154 this if a lot of text is added to messages.
22155
22156 Alternatively, if the value of &%size_addition%& is set negative, it disables
22157 the use of the SIZE option altogether.
22158
22159
22160 .option tls_certificate smtp string&!! unset
22161 .cindex "TLS" "client certificate, location of"
22162 .cindex "certificate" "client, location of"
22163 .vindex "&$host$&"
22164 .vindex "&$host_address$&"
22165 The value of this option must be the absolute path to a file which contains the
22166 client's certificate, for possible use when sending a message over an encrypted
22167 connection. The values of &$host$& and &$host_address$& are set to the name and
22168 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22169 details of TLS.
22170
22171 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22172 certificate when sending messages as a client. The global option of the same
22173 name specifies the certificate for Exim as a server; it is not automatically
22174 assumed that the same certificate should be used when Exim is operating as a
22175 client.
22176
22177
22178 .option tls_crl smtp string&!! unset
22179 .cindex "TLS" "client certificate revocation list"
22180 .cindex "certificate" "revocation list for client"
22181 This option specifies a certificate revocation list. The expanded value must
22182 be the name of a file that contains a CRL in PEM format.
22183
22184
22185 .option tls_privatekey smtp string&!! unset
22186 .cindex "TLS" "client private key, location of"
22187 .vindex "&$host$&"
22188 .vindex "&$host_address$&"
22189 The value of this option must be the absolute path to a file which contains the
22190 client's private key. This is used when sending a message over an encrypted
22191 connection using a client certificate. The values of &$host$& and
22192 &$host_address$& are set to the name and address of the server during the
22193 expansion. If this option is unset, or the expansion is forced to fail, or the
22194 result is an empty string, the private key is assumed to be in the same file as
22195 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22196
22197
22198 .option tls_require_ciphers smtp string&!! unset
22199 .cindex "TLS" "requiring specific ciphers"
22200 .cindex "cipher" "requiring specific"
22201 .vindex "&$host$&"
22202 .vindex "&$host_address$&"
22203 The value of this option must be a list of permitted cipher suites, for use
22204 when setting up an outgoing encrypted connection. (There is a global option of
22205 the same name for controlling incoming connections.) The values of &$host$& and
22206 &$host_address$& are set to the name and address of the server during the
22207 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22208 is used in different ways by OpenSSL and GnuTLS (see sections
22209 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22210 ciphers is a preference order.
22211
22212
22213
22214 .option tls_tempfail_tryclear smtp boolean true
22215 .cindex "4&'xx'& responses" "to STARTTLS"
22216 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22217 setting up a TLS session, this option determines whether or not Exim should try
22218 to deliver the message unencrypted. If it is set false, delivery to the
22219 current host is deferred; if there are other hosts, they are tried. If this
22220 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22221 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22222 TLS negotiation fails, Exim closes the current connection (because it is in an
22223 unknown state), opens a new one to the same host, and then tries the delivery
22224 in clear.
22225
22226
22227 .option tls_verify_certificates smtp string&!! unset
22228 .cindex "TLS" "server certificate verification"
22229 .cindex "certificate" "verification of server"
22230 .vindex "&$host$&"
22231 .vindex "&$host_address$&"
22232 The value of this option must be the absolute path to a file containing
22233 permitted server certificates, for use when setting up an encrypted connection.
22234 Alternatively, if you are using OpenSSL, you can set
22235 &%tls_verify_certificates%& to the name of a directory containing certificate
22236 files. This does not work with GnuTLS; the option must be set to the name of a
22237 single file if you are using GnuTLS. The values of &$host$& and
22238 &$host_address$& are set to the name and address of the server during the
22239 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22240
22241
22242
22243
22244 .section "How the limits for the number of hosts to try are used" &&&
22245          "SECTvalhosmax"
22246 .cindex "host" "maximum number to try"
22247 .cindex "limit" "hosts; maximum number tried"
22248 There are two options that are concerned with the number of hosts that are
22249 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22250 &%hosts_max_try_hardlimit%&.
22251
22252
22253 The &%hosts_max_try%& option limits the number of hosts that are tried
22254 for a single delivery. However, despite the term &"host"& in its name, the
22255 option actually applies to each IP address independently. In other words, a
22256 multihomed host is treated as several independent hosts, just as it is for
22257 retrying.
22258
22259 Many of the larger ISPs have multiple MX records which often point to
22260 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22261 created as a result of routing one of these domains.
22262
22263 Trying every single IP address on such a long list does not seem sensible; if
22264 several at the top of the list fail, it is reasonable to assume there is some
22265 problem that is likely to affect all of them. Roughly speaking, the value of
22266 &%hosts_max_try%& is the maximum number that are tried before deferring the
22267 delivery. However, the logic cannot be quite that simple.
22268
22269 Firstly, IP addresses that are skipped because their retry times have not
22270 arrived do not count, and in addition, addresses that are past their retry
22271 limits are also not counted, even when they are tried. This means that when
22272 some IP addresses are past their retry limits, more than the value of
22273 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22274 that all IP addresses are considered before timing out an email address (but
22275 see below for an exception).
22276
22277 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22278 list to see if there is a subsequent host with a different (higher valued) MX.
22279 If there is, that host is considered next, and the current IP address is used
22280 but not counted. This behaviour helps in the case of a domain with a retry rule
22281 that hardly ever delays any hosts, as is now explained:
22282
22283 Consider the case of a long list of hosts with one MX value, and a few with a
22284 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22285 hosts at the top of the list are tried at first. With the default retry rule,
22286 which specifies increasing retry times, the higher MX hosts are eventually
22287 tried when those at the top of the list are skipped because they have not
22288 reached their retry times.
22289
22290 However, it is common practice to put a fixed short retry time on domains for
22291 large ISPs, on the grounds that their servers are rarely down for very long.
22292 Unfortunately, these are exactly the domains that tend to resolve to long lists
22293 of hosts. The short retry time means that the lowest MX hosts are tried every
22294 time. The attempts may be in a different order because of random sorting, but
22295 without the special MX check, the higher MX hosts would never be tried until
22296 all the lower MX hosts had timed out (which might be several days), because
22297 there are always some lower MX hosts that have reached their retry times. With
22298 the special check, Exim considers at least one IP address from each MX value at
22299 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22300 reached.
22301
22302 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22303 particular, Exim normally eventually tries all the IP addresses before timing
22304 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22305 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22306 been set up with hundreds of IP addresses for some domains. It can
22307 take a very long time indeed for an address to time out in these cases.
22308
22309 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22310 Exim never tries more than this number of IP addresses; if it hits this limit
22311 and they are all timed out, the email address is bounced, even though not all
22312 possible IP addresses have been tried.
22313 .ecindex IIDsmttra1
22314 .ecindex IIDsmttra2
22315
22316
22317
22318
22319
22320 . ////////////////////////////////////////////////////////////////////////////
22321 . ////////////////////////////////////////////////////////////////////////////
22322
22323 .chapter "Address rewriting" "CHAPrewrite"
22324 .scindex IIDaddrew "rewriting" "addresses"
22325 There are some circumstances in which Exim automatically rewrites domains in
22326 addresses. The two most common are when an address is given without a domain
22327 (referred to as an &"unqualified address"&) or when an address contains an
22328 abbreviated domain that is expanded by DNS lookup.
22329
22330 Unqualified envelope addresses are accepted only for locally submitted
22331 messages, or for messages that are received from hosts matching
22332 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22333 appropriate. Unqualified addresses in header lines are qualified if they are in
22334 locally submitted messages, or messages from hosts that are permitted to send
22335 unqualified envelope addresses. Otherwise, unqualified addresses in header
22336 lines are neither qualified nor rewritten.
22337
22338 One situation in which Exim does &'not'& automatically rewrite a domain is
22339 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22340 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22341 do this. The new RFCs do not contain this suggestion.
22342
22343
22344 .section "Explicitly configured address rewriting" "SECID147"
22345 This chapter describes the rewriting rules that can be used in the
22346 main rewrite section of the configuration file, and also in the generic
22347 &%headers_rewrite%& option that can be set on any transport.
22348
22349 Some people believe that configured address rewriting is a Mortal Sin.
22350 Others believe that life is not possible without it. Exim provides the
22351 facility; you do not have to use it.
22352
22353 The main rewriting rules that appear in the &"rewrite"& section of the
22354 configuration file are applied to addresses in incoming messages, both envelope
22355 addresses and addresses in header lines. Each rule specifies the types of
22356 address to which it applies.
22357
22358 Whether or not addresses in header lines are rewritten depends on the origin of
22359 the headers and the type of rewriting. Global rewriting, that is, rewriting
22360 rules from the rewrite section of the configuration file, is applied only to
22361 those headers that were received with the message. Header lines that are added
22362 by ACLs or by a system filter or by individual routers or transports (which
22363 are specific to individual recipient addresses) are not rewritten by the global
22364 rules.
22365
22366 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22367 applies all headers except those added by routers and transports. That is, as
22368 well as the headers that were received with the message, it also applies to
22369 headers that were added by an ACL or a system filter.
22370
22371
22372 In general, rewriting addresses from your own system or domain has some
22373 legitimacy. Rewriting other addresses should be done only with great care and
22374 in special circumstances. The author of Exim believes that rewriting should be
22375 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22376 Although it can sometimes be used as a routing tool, this is very strongly
22377 discouraged.
22378
22379 There are two commonly encountered circumstances where rewriting is used, as
22380 illustrated by these examples:
22381
22382 .ilist
22383 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22384 exchange mail with each other behind a firewall, but there is only a single
22385 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22386 &'hitch.fict.example'& when sending mail off-site.
22387 .next
22388 A host rewrites the local parts of its own users so that, for example,
22389 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22390 .endlist
22391
22392
22393
22394 .section "When does rewriting happen?" "SECID148"
22395 .cindex "rewriting" "timing of"
22396 .cindex "&ACL;" "rewriting addresses in"
22397 Configured address rewriting can take place at several different stages of a
22398 message's processing.
22399
22400 .vindex "&$sender_address$&"
22401 At the start of an ACL for MAIL, the sender address may have been rewritten
22402 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22403 ordinary rewrite rules have yet been applied. If, however, the sender address
22404 is verified in the ACL, it is rewritten before verification, and remains
22405 rewritten thereafter. The subsequent value of &$sender_address$& is the
22406 rewritten address. This also applies if sender verification happens in a
22407 RCPT ACL. Otherwise, when the sender address is not verified, it is
22408 rewritten as soon as a message's header lines have been received.
22409
22410 .vindex "&$domain$&"
22411 .vindex "&$local_part$&"
22412 Similarly, at the start of an ACL for RCPT, the current recipient's address
22413 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22414 rewrite rules have yet been applied to it. However, the behaviour is different
22415 from the sender address when a recipient is verified. The address is rewritten
22416 for the verification, but the rewriting is not remembered at this stage. The
22417 value of &$local_part$& and &$domain$& after verification are always the same
22418 as they were before (that is, they contain the unrewritten &-- except for
22419 SMTP-time rewriting &-- address).
22420
22421 As soon as a message's header lines have been received, all the envelope
22422 recipient addresses are permanently rewritten, and rewriting is also applied to
22423 the addresses in the header lines (if configured). This happens before adding
22424 any header lines that were specified in MAIL or RCPT ACLs, and
22425 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22426 before the DATA ACL and &[local_scan()]& functions are run.
22427
22428 When an address is being routed, either for delivery or for verification,
22429 rewriting is applied immediately to child addresses that are generated by
22430 redirection, unless &%no_rewrite%& is set on the router.
22431
22432 .cindex "envelope sender" "rewriting at transport time"
22433 .cindex "rewriting" "at transport time"
22434 .cindex "header lines" "rewriting at transport time"
22435 At transport time, additional rewriting of addresses in header lines can be
22436 specified by setting the generic &%headers_rewrite%& option on a transport.
22437 This option contains rules that are identical in form to those in the rewrite
22438 section of the configuration file. They are applied to the original message
22439 header lines and any that were added by ACLs or a system filter. They are not
22440 applied to header lines that are added by routers or the transport.
22441
22442 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22443 transport option. However, it is not possible to rewrite envelope recipients at
22444 transport time.
22445
22446
22447
22448
22449 .section "Testing the rewriting rules that apply on input" "SECID149"
22450 .cindex "rewriting" "testing"
22451 .cindex "testing" "rewriting"
22452 Exim's input rewriting configuration appears in a part of the run time
22453 configuration file headed by &"begin rewrite"&. It can be tested by the
22454 &%-brw%& command line option. This takes an address (which can be a full RFC
22455 2822 address) as its argument. The output is a list of how the address would be
22456 transformed by the rewriting rules for each of the different places it might
22457 appear in an incoming message, that is, for each different header and for the
22458 envelope sender and recipient fields. For example,
22459 .code
22460 exim -brw ph10@exim.workshop.example
22461 .endd
22462 might produce the output
22463 .code
22464 sender: Philip.Hazel@exim.workshop.example
22465 from: Philip.Hazel@exim.workshop.example
22466 to: ph10@exim.workshop.example
22467 cc: ph10@exim.workshop.example
22468 bcc: ph10@exim.workshop.example
22469 reply-to: Philip.Hazel@exim.workshop.example
22470 env-from: Philip.Hazel@exim.workshop.example
22471 env-to: ph10@exim.workshop.example
22472 .endd
22473 which shows that rewriting has been set up for that address when used in any of
22474 the source fields, but not when it appears as a recipient address. At the
22475 present time, there is no equivalent way of testing rewriting rules that are
22476 set for a particular transport.
22477
22478
22479 .section "Rewriting rules" "SECID150"
22480 .cindex "rewriting" "rules"
22481 The rewrite section of the configuration file consists of lines of rewriting
22482 rules in the form
22483 .display
22484 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22485 .endd
22486 Rewriting rules that are specified for the &%headers_rewrite%& generic
22487 transport option are given as a colon-separated list. Each item in the list
22488 takes the same form as a line in the main rewriting configuration (except that
22489 any colons must be doubled, of course).
22490
22491 The formats of source patterns and replacement strings are described below.
22492 Each is terminated by white space, unless enclosed in double quotes, in which
22493 case normal quoting conventions apply inside the quotes. The flags are single
22494 characters which may appear in any order. Spaces and tabs between them are
22495 ignored.
22496
22497 For each address that could potentially be rewritten, the rules are scanned in
22498 order, and replacements for the address from earlier rules can themselves be
22499 replaced by later rules (but see the &"q"& and &"R"& flags).
22500
22501 The order in which addresses are rewritten is undefined, may change between
22502 releases, and must not be relied on, with one exception: when a message is
22503 received, the envelope sender is always rewritten first, before any header
22504 lines are rewritten. For example, the replacement string for a rewrite of an
22505 address in &'To:'& must not assume that the message's address in &'From:'& has
22506 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22507 that the envelope sender has already been rewritten.
22508
22509 .vindex "&$domain$&"
22510 .vindex "&$local_part$&"
22511 The variables &$local_part$& and &$domain$& can be used in the replacement
22512 string to refer to the address that is being rewritten. Note that lookup-driven
22513 rewriting can be done by a rule of the form
22514 .code
22515 *@*   ${lookup ...
22516 .endd
22517 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22518 refer to the address that is being rewritten.
22519
22520
22521 .section "Rewriting patterns" "SECID151"
22522 .cindex "rewriting" "patterns"
22523 .cindex "address list" "in a rewriting pattern"
22524 The source pattern in a rewriting rule is any item which may appear in an
22525 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22526 single-item address list, which means that it is expanded before being tested
22527 against the address. As always, if you use a regular expression as a pattern,
22528 you must take care to escape dollar and backslash characters, or use the &`\N`&
22529 facility to suppress string expansion within the regular expression.
22530
22531 Domains in patterns should be given in lower case. Local parts in patterns are
22532 case-sensitive. If you want to do case-insensitive matching of local parts, you
22533 can use a regular expression that starts with &`^(?i)`&.
22534
22535 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22536 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22537 depending on the type of match which occurred. These can be used in the
22538 replacement string to insert portions of the incoming address. &$0$& always
22539 refers to the complete incoming address. When a regular expression is used, the
22540 numerical variables are set from its capturing subexpressions. For other types
22541 of pattern they are set as follows:
22542
22543 .ilist
22544 If a local part or domain starts with an asterisk, the numerical variables
22545 refer to the character strings matched by asterisks, with &$1$& associated with
22546 the first asterisk, and &$2$& with the second, if present. For example, if the
22547 pattern
22548 .code
22549 *queen@*.fict.example
22550 .endd
22551 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22552 .code
22553 $0 = hearts-queen@wonderland.fict.example
22554 $1 = hearts-
22555 $2 = wonderland
22556 .endd
22557 Note that if the local part does not start with an asterisk, but the domain
22558 does, it is &$1$& that contains the wild part of the domain.
22559
22560 .next
22561 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22562 of the domain are placed in the next available numerical variables. Suppose,
22563 for example, that the address &'foo@bar.baz.example'& is processed by a
22564 rewriting rule of the form
22565 .display
22566 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22567 .endd
22568 and the key in the file that matches the domain is &`*.baz.example`&. Then
22569 .code
22570 $1 = foo
22571 $2 = bar
22572 $3 = baz.example
22573 .endd
22574 If the address &'foo@baz.example'& is looked up, this matches the same
22575 wildcard file entry, and in this case &$2$& is set to the empty string, but
22576 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22577 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22578 whole domain. For non-partial domain lookups, no numerical variables are set.
22579 .endlist
22580
22581
22582 .section "Rewriting replacements" "SECID152"
22583 .cindex "rewriting" "replacements"
22584 If the replacement string for a rule is a single asterisk, addresses that
22585 match the pattern and the flags are &'not'& rewritten, and no subsequent
22586 rewriting rules are scanned. For example,
22587 .code
22588 hatta@lookingglass.fict.example  *  f
22589 .endd
22590 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22591 &'From:'& headers.
22592
22593 .vindex "&$domain$&"
22594 .vindex "&$local_part$&"
22595 If the replacement string is not a single asterisk, it is expanded, and must
22596 yield a fully qualified address. Within the expansion, the variables
22597 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22598 Any letters they contain retain their original case &-- they are not lower
22599 cased. The numerical variables are set up according to the type of pattern that
22600 matched the address, as described above. If the expansion is forced to fail by
22601 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22602 current rule is abandoned, but subsequent rules may take effect. Any other
22603 expansion failure causes the entire rewriting operation to be abandoned, and an
22604 entry written to the panic log.
22605
22606
22607
22608 .section "Rewriting flags" "SECID153"
22609 There are three different kinds of flag that may appear on rewriting rules:
22610
22611 .ilist
22612 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22613 c, f, h, r, s, t.
22614 .next
22615 A flag that specifies rewriting at SMTP time: S.
22616 .next
22617 Flags that control the rewriting process: Q, q, R, w.
22618 .endlist
22619
22620 For rules that are part of the &%headers_rewrite%& generic transport option,
22621 E, F, T, and S are not permitted.
22622
22623
22624
22625 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22626          "SECID154"
22627 .cindex "rewriting" "flags"
22628 If none of the following flag letters, nor the &"S"& flag (see section
22629 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22630 and to both the sender and recipient fields of the envelope, whereas a
22631 transport-time rewriting rule just applies to all headers. Otherwise, the
22632 rewriting rule is skipped unless the relevant addresses are being processed.
22633 .display
22634 &`E`&       rewrite all envelope fields
22635 &`F`&       rewrite the envelope From field
22636 &`T`&       rewrite the envelope To field
22637 &`b`&       rewrite the &'Bcc:'& header
22638 &`c`&       rewrite the &'Cc:'& header
22639 &`f`&       rewrite the &'From:'& header
22640 &`h`&       rewrite all headers
22641 &`r`&       rewrite the &'Reply-To:'& header
22642 &`s`&       rewrite the &'Sender:'& header
22643 &`t`&       rewrite the &'To:'& header
22644 .endd
22645 "All headers" means all of the headers listed above that can be selected
22646 individually, plus their &'Resent-'& versions. It does not include
22647 other headers such as &'Subject:'& etc.
22648
22649 You should be particularly careful about rewriting &'Sender:'& headers, and
22650 restrict this to special known cases in your own domains.
22651
22652
22653 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22654 .cindex "SMTP" "rewriting malformed addresses"
22655 .cindex "RCPT" "rewriting argument of"
22656 .cindex "MAIL" "rewriting argument of"
22657 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22658 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22659 before any other processing; even before syntax checking. The pattern is
22660 required to be a regular expression, and it is matched against the whole of the
22661 data for the command, including any surrounding angle brackets.
22662
22663 .vindex "&$domain$&"
22664 .vindex "&$local_part$&"
22665 This form of rewrite rule allows for the handling of addresses that are not
22666 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22667 input). Because the input is not required to be a syntactically valid address,
22668 the variables &$local_part$& and &$domain$& are not available during the
22669 expansion of the replacement string. The result of rewriting replaces the
22670 original address in the MAIL or RCPT command.
22671
22672
22673 .section "Flags controlling the rewriting process" "SECID155"
22674 There are four flags which control the way the rewriting process works. These
22675 take effect only when a rule is invoked, that is, when the address is of the
22676 correct type (matches the flags) and matches the pattern:
22677
22678 .ilist
22679 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22680 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22681 absence of &"Q"& the rewritten address must always include a domain.
22682 .next
22683 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22684 even if no rewriting actually takes place because of a &"fail"& in the
22685 expansion. The &"q"& flag is not effective if the address is of the wrong type
22686 (does not match the flags) or does not match the pattern.
22687 .next
22688 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22689 address, up to ten times. It can be combined with the &"q"& flag, to stop
22690 rewriting once it fails to match (after at least one successful rewrite).
22691 .next
22692 .cindex "rewriting" "whole addresses"
22693 When an address in a header is rewritten, the rewriting normally applies only
22694 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22695 left unchanged. For example, rewriting might change
22696 .code
22697 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22698 .endd
22699 into
22700 .code
22701 From: Ford Prefect <prefectf@hitch.fict.example>
22702 .endd
22703 .cindex "RFC 2047"
22704 Sometimes there is a need to replace the whole address item, and this can be
22705 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22706 causes an address in a header line to be rewritten, the entire address is
22707 replaced, not just the working part. The replacement must be a complete RFC
22708 2822 address, including the angle brackets if necessary. If text outside angle
22709 brackets contains a character whose value is greater than 126 or less than 32
22710 (except for tab), the text is encoded according to RFC 2047. The character set
22711 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22712
22713 When the &"w"& flag is set on a rule that causes an envelope address to be
22714 rewritten, all but the working part of the replacement address is discarded.
22715 .endlist
22716
22717
22718 .section "Rewriting examples" "SECID156"
22719 Here is an example of the two common rewriting paradigms:
22720 .code
22721 *@*.hitch.fict.example  $1@hitch.fict.example
22722 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
22723                      {$value}fail}@hitch.fict.example bctfrF
22724 .endd
22725 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22726 the string expansion to fail if the lookup does not succeed. In this context it
22727 has the effect of leaving the original address unchanged, but Exim goes on to
22728 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22729 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22730 explicitly, which would cause the rewritten address to be the same as before,
22731 at the cost of a small bit of processing. Not supplying either of these is an
22732 error, since the rewritten address would then contain no local part.
22733
22734 The first example above replaces the domain with a superior, more general
22735 domain. This may not be desirable for certain local parts. If the rule
22736 .code
22737 root@*.hitch.fict.example  *
22738 .endd
22739 were inserted before the first rule, rewriting would be suppressed for the
22740 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22741
22742 Rewriting can be made conditional on a number of tests, by making use of
22743 &${if$& in the expansion item. For example, to apply a rewriting rule only to
22744 messages that originate outside the local host:
22745 .code
22746 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
22747                          {$1@hitch.fict.example}fail}"
22748 .endd
22749 The replacement string is quoted in this example because it contains white
22750 space.
22751
22752 .cindex "rewriting" "bang paths"
22753 .cindex "bang paths" "rewriting"
22754 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
22755 an address it treats it as an unqualified local part which it qualifies with
22756 the local qualification domain (if the source of the message is local or if the
22757 remote host is permitted to send unqualified addresses). Rewriting can
22758 sometimes be used to handle simple bang paths with a fixed number of
22759 components. For example, the rule
22760 .code
22761 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
22762 .endd
22763 rewrites a two-component bang path &'host.name!user'& as the domain address
22764 &'user@host.name'&. However, there is a security implication in using this as
22765 a global rewriting rule for envelope addresses. It can provide a backdoor
22766 method for using your system as a relay, because the incoming addresses appear
22767 to be local. If the bang path addresses are received via SMTP, it is safer to
22768 use the &"S"& flag to rewrite them as they are received, so that relay checking
22769 can be done on the rewritten addresses.
22770 .ecindex IIDaddrew
22771
22772
22773
22774
22775
22776 . ////////////////////////////////////////////////////////////////////////////
22777 . ////////////////////////////////////////////////////////////////////////////
22778
22779 .chapter "Retry configuration" "CHAPretry"
22780 .scindex IIDretconf1 "retry" "configuration, description of"
22781 .scindex IIDregconf2 "configuration file" "retry section"
22782 The &"retry"& section of the runtime configuration file contains a list of
22783 retry rules that control how often Exim tries to deliver messages that cannot
22784 be delivered at the first attempt. If there are no retry rules (the section is
22785 empty or not present), there are no retries. In this situation, temporary
22786 errors are treated as permanent. The default configuration contains a single,
22787 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
22788 line option can be used to test which retry rule will be used for a given
22789 address, domain and error.
22790
22791 The most common cause of retries is temporary failure to deliver to a remote
22792 host because the host is down, or inaccessible because of a network problem.
22793 Exim's retry processing in this case is applied on a per-host (strictly, per IP
22794 address) basis, not on a per-message basis. Thus, if one message has recently
22795 been delayed, delivery of a new message to the same host is not immediately
22796 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
22797 log selector is set, the message
22798 .cindex "retry" "time not reached"
22799 &"retry time not reached"& is written to the main log whenever a delivery is
22800 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
22801 the handling of errors during remote deliveries.
22802
22803 Retry processing applies to routing as well as to delivering, except as covered
22804 in the next paragraph. The retry rules do not distinguish between these
22805 actions. It is not possible, for example, to specify different behaviour for
22806 failures to route the domain &'snark.fict.example'& and failures to deliver to
22807 the host &'snark.fict.example'&. I didn't think anyone would ever need this
22808 added complication, so did not implement it. However, although they share the
22809 same retry rule, the actual retry times for routing and transporting a given
22810 domain are maintained independently.
22811
22812 When a delivery is not part of a queue run (typically an immediate delivery on
22813 receipt of a message), the routers are always run, and local deliveries are
22814 always attempted, even if retry times are set for them. This makes for better
22815 behaviour if one particular message is causing problems (for example, causing
22816 quota overflow, or provoking an error in a filter file). If such a delivery
22817 suffers a temporary failure, the retry data is updated as normal, and
22818 subsequent delivery attempts from queue runs occur only when the retry time for
22819 the local address is reached.
22820
22821 .section "Changing retry rules" "SECID157"
22822 If you change the retry rules in your configuration, you should consider
22823 whether or not to delete the retry data that is stored in Exim's spool area in
22824 files with names like &_db/retry_&. Deleting any of Exim's hints files is
22825 always safe; that is why they are called &"hints"&.
22826
22827 The hints retry data contains suggested retry times based on the previous
22828 rules. In the case of a long-running problem with a remote host, it might
22829 record the fact that the host has timed out. If your new rules increase the
22830 timeout time for such a host, you should definitely remove the old retry data
22831 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
22832 messages that it should now be retaining.
22833
22834
22835
22836 .section "Format of retry rules" "SECID158"
22837 .cindex "retry" "rules"
22838 Each retry rule occupies one line and consists of three or four parts,
22839 separated by white space: a pattern, an error name, an optional list of sender
22840 addresses, and a list of retry parameters. The pattern and sender lists must be
22841 enclosed in double quotes if they contain white space. The rules are searched
22842 in order until one is found where the pattern, error name, and sender list (if
22843 present) match the failing host or address, the error that occurred, and the
22844 message's sender, respectively.
22845
22846
22847 The pattern is any single item that may appear in an address list (see section
22848 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
22849 which means that it is expanded before being tested against the address that
22850 has been delayed. A negated address list item is permitted. Address
22851 list processing treats a plain domain name as if it were preceded by &"*@"&,
22852 which makes it possible for many retry rules to start with just a domain. For
22853 example,
22854 .code
22855 lookingglass.fict.example        *  F,24h,30m;
22856 .endd
22857 provides a rule for any address in the &'lookingglass.fict.example'& domain,
22858 whereas
22859 .code
22860 alice@lookingglass.fict.example  *  F,24h,30m;
22861 .endd
22862 applies only to temporary failures involving the local part &%alice%&.
22863 In practice, almost all rules start with a domain name pattern without a local
22864 part.
22865
22866 .cindex "regular expressions" "in retry rules"
22867 &*Warning*&: If you use a regular expression in a routing rule pattern, it
22868 must match a complete address, not just a domain, because that is how regular
22869 expressions work in address lists.
22870 .display
22871 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
22872 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
22873 .endd
22874
22875
22876 .section "Choosing which retry rule to use for address errors" "SECID159"
22877 When Exim is looking for a retry rule after a routing attempt has failed (for
22878 example, after a DNS timeout), each line in the retry configuration is tested
22879 against the complete address only if &%retry_use_local_part%& is set for the
22880 router. Otherwise, only the domain is used, except when matching against a
22881 regular expression, when the local part of the address is replaced with &"*"&.
22882 A domain on its own can match a domain pattern, or a pattern that starts with
22883 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
22884 &%check_local_user%& is true, and false for other routers.
22885
22886 Similarly, when Exim is looking for a retry rule after a local delivery has
22887 failed (for example, after a mailbox full error), each line in the retry
22888 configuration is tested against the complete address only if
22889 &%retry_use_local_part%& is set for the transport (it defaults true for all
22890 local transports).
22891
22892 .cindex "4&'xx'& responses" "retry rules for"
22893 However, when Exim is looking for a retry rule after a remote delivery attempt
22894 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
22895 whole address is always used as the key when searching the retry rules. The
22896 rule that is found is used to create a retry time for the combination of the
22897 failing address and the message's sender. It is the combination of sender and
22898 recipient that is delayed in subsequent queue runs until its retry time is
22899 reached. You can delay the recipient without regard to the sender by setting
22900 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
22901 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
22902 commands.
22903
22904
22905
22906 .section "Choosing which retry rule to use for host and message errors" &&&
22907          "SECID160"
22908 For a temporary error that is not related to an individual address (for
22909 example, a connection timeout), each line in the retry configuration is checked
22910 twice. First, the name of the remote host is used as a domain name (preceded by
22911 &"*@"& when matching a regular expression). If this does not match the line,
22912 the domain from the email address is tried in a similar fashion. For example,
22913 suppose the MX records for &'a.b.c.example'& are
22914 .code
22915 a.b.c.example  MX  5  x.y.z.example
22916                MX  6  p.q.r.example
22917                MX  7  m.n.o.example
22918 .endd
22919 and the retry rules are
22920 .code
22921 p.q.r.example    *      F,24h,30m;
22922 a.b.c.example    *      F,4d,45m;
22923 .endd
22924 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
22925 first rule matches neither the host nor the domain, so Exim looks at the second
22926 rule. This does not match the host, but it does match the domain, so it is used
22927 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
22928 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
22929 first retry rule is used, because it matches the host.
22930
22931 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
22932 first rule to determine retry times, but for all the other hosts for the domain
22933 &'a.b.c.example'&, the second rule is used. The second rule is also used if
22934 routing to &'a.b.c.example'& suffers a temporary failure.
22935
22936 &*Note*&: The host name is used when matching the patterns, not its IP address.
22937 However, if a message is routed directly to an IP address without the use of a
22938 host name, for example, if a &(manualroute)& router contains a setting such as:
22939 .code
22940 route_list = *.a.example  192.168.34.23
22941 .endd
22942 then the &"host name"& that is used when searching for a retry rule is the
22943 textual form of the IP address.
22944
22945 .section "Retry rules for specific errors" "SECID161"
22946 .cindex "retry" "specific errors; specifying"
22947 The second field in a retry rule is the name of a particular error, or an
22948 asterisk, which matches any error. The errors that can be tested for are:
22949
22950 .vlist
22951 .vitem &%auth_failed%&
22952 Authentication failed when trying to send to a host in the
22953 &%hosts_require_auth%& list in an &(smtp)& transport.
22954
22955 .vitem &%data_4xx%&
22956 A 4&'xx'& error was received for an outgoing DATA command, either immediately
22957 after the command, or after sending the message's data.
22958
22959 .vitem &%mail_4xx%&
22960 A 4&'xx'& error was received for an outgoing MAIL command.
22961
22962 .vitem &%rcpt_4xx%&
22963 A 4&'xx'& error was received for an outgoing RCPT command.
22964 .endlist
22965
22966 For the three 4&'xx'& errors, either the first or both of the x's can be given
22967 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
22968 recognize 452 errors given to RCPT commands for addresses in a certain domain,
22969 and have retries every ten minutes with a one-hour timeout, you could set up a
22970 retry rule of this form:
22971 .code
22972 the.domain.name  rcpt_452   F,1h,10m
22973 .endd
22974 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
22975 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
22976
22977 .vlist
22978 .vitem &%lost_connection%&
22979 A server unexpectedly closed the SMTP connection. There may, of course,
22980 legitimate reasons for this (host died, network died), but if it repeats a lot
22981 for the same host, it indicates something odd.
22982
22983 .vitem &%refused_MX%&
22984 A connection to a host obtained from an MX record was refused.
22985
22986 .vitem &%refused_A%&
22987 A connection to a host not obtained from an MX record was refused.
22988
22989 .vitem &%refused%&
22990 A connection was refused.
22991
22992 .vitem &%timeout_connect_MX%&
22993 A connection attempt to a host obtained from an MX record timed out.
22994
22995 .vitem &%timeout_connect_A%&
22996 A connection attempt to a host not obtained from an MX record timed out.
22997
22998 .vitem &%timeout_connect%&
22999 A connection attempt timed out.
23000
23001 .vitem &%timeout_MX%&
23002 There was a timeout while connecting or during an SMTP session with a host
23003 obtained from an MX record.
23004
23005 .vitem &%timeout_A%&
23006 There was a timeout while connecting or during an SMTP session with a host not
23007 obtained from an MX record.
23008
23009 .vitem &%timeout%&
23010 There was a timeout while connecting or during an SMTP session.
23011
23012 .vitem &%tls_required%&
23013 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23014 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23015 to STARTTLS, or there was a problem setting up the TLS connection.
23016
23017 .vitem &%quota%&
23018 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23019 transport.
23020
23021 .vitem &%quota_%&<&'time'&>
23022 .cindex "quota" "error testing in retry rule"
23023 .cindex "retry" "quota error testing"
23024 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23025 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23026 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23027 for four days.
23028 .endlist
23029
23030 .cindex "mailbox" "time of last read"
23031 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23032 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23033 it should be based on the last time that the user accessed the mailbox.
23034 However, it is not always possible to determine this. Exim uses the following
23035 heuristic rules:
23036
23037 .ilist
23038 If the mailbox is a single file, the time of last access (the &"atime"&) is
23039 used. As no new messages are being delivered (because the mailbox is over
23040 quota), Exim does not access the file, so this is the time of last user access.
23041 .next
23042 .cindex "maildir format" "time of last read"
23043 For a maildir delivery, the time of last modification of the &_new_&
23044 subdirectory is used. As the mailbox is over quota, no new files are created in
23045 the &_new_& subdirectory, because no new messages are being delivered. Any
23046 change to the &_new_& subdirectory is therefore assumed to be the result of an
23047 MUA moving a new message to the &_cur_& directory when it is first read. The
23048 time that is used is therefore the last time that the user read a new message.
23049 .next
23050 For other kinds of multi-file mailbox, the time of last access cannot be
23051 obtained, so a retry rule that uses this type of error field is never matched.
23052 .endlist
23053
23054 The quota errors apply both to system-enforced quotas and to Exim's own quota
23055 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23056 when a local delivery is deferred because a partition is full (the ENOSPC
23057 error).
23058
23059
23060
23061 .section "Retry rules for specified senders" "SECID162"
23062 .cindex "retry" "rules; sender-specific"
23063 You can specify retry rules that apply only when the failing message has a
23064 specific sender. In particular, this can be used to define retry rules that
23065 apply only to bounce messages. The third item in a retry rule can be of this
23066 form:
23067 .display
23068 &`senders=`&<&'address list'&>
23069 .endd
23070 The retry timings themselves are then the fourth item. For example:
23071 .code
23072 *   rcpt_4xx   senders=:   F,1h,30m
23073 .endd
23074 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23075 host. If the address list contains white space, it must be enclosed in quotes.
23076 For example:
23077 .code
23078 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23079 .endd
23080 &*Warning*&: This facility can be unhelpful if it is used for host errors
23081 (which do not depend on the recipient). The reason is that the sender is used
23082 only to match the retry rule. Once the rule has been found for a host error,
23083 its contents are used to set a retry time for the host, and this will apply to
23084 all messages, not just those with specific senders.
23085
23086 When testing retry rules using &%-brt%&, you can supply a sender using the
23087 &%-f%& command line option, like this:
23088 .code
23089 exim -f "" -brt user@dom.ain
23090 .endd
23091 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23092 list is never matched.
23093
23094
23095
23096
23097
23098 .section "Retry parameters" "SECID163"
23099 .cindex "retry" "parameters in rules"
23100 The third (or fourth, if a senders list is present) field in a retry rule is a
23101 sequence of retry parameter sets, separated by semicolons. Each set consists of
23102 .display
23103 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23104 .endd
23105 The letter identifies the algorithm for computing a new retry time; the cutoff
23106 time is the time beyond which this algorithm no longer applies, and the
23107 arguments vary the algorithm's action. The cutoff time is measured from the
23108 time that the first failure for the domain (combined with the local part if
23109 relevant) was detected, not from the time the message was received.
23110
23111 .cindex "retry" "algorithms"
23112 .cindex "retry" "fixed intervals"
23113 .cindex "retry" "increasing intervals"
23114 .cindex "retry" "random intervals"
23115 The available algorithms are:
23116
23117 .ilist
23118 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23119 the interval.
23120 .next
23121 &'G'&: retry at geometrically increasing intervals. The first argument
23122 specifies a starting value for the interval, and the second a multiplier, which
23123 is used to increase the size of the interval at each retry.
23124 .next
23125 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23126 retry, the previous interval is multiplied by the factor in order to get a
23127 maximum for the next interval. The minimum interval is the first argument of
23128 the parameter, and an actual interval is chosen randomly between them. Such a
23129 rule has been found to be helpful in cluster configurations when all the
23130 members of the cluster restart at once, and may therefore synchronize their
23131 queue processing times.
23132 .endlist
23133
23134 When computing the next retry time, the algorithm definitions are scanned in
23135 order until one whose cutoff time has not yet passed is reached. This is then
23136 used to compute a new retry time that is later than the current time. In the
23137 case of fixed interval retries, this simply means adding the interval to the
23138 current time. For geometrically increasing intervals, retry intervals are
23139 computed from the rule's parameters until one that is greater than the previous
23140 interval is found. The main configuration variable
23141 .cindex "limit" "retry interval"
23142 .cindex "retry" "interval, maximum"
23143 .oindex "&%retry_interval_max%&"
23144 &%retry_interval_max%& limits the maximum interval between retries. It
23145 cannot be set greater than &`24h`&, which is its default value.
23146
23147 A single remote domain may have a number of hosts associated with it, and each
23148 host may have more than one IP address. Retry algorithms are selected on the
23149 basis of the domain name, but are applied to each IP address independently. If,
23150 for example, a host has two IP addresses and one is unusable, Exim will
23151 generate retry times for it and will not try to use it until its next retry
23152 time comes. Thus the good IP address is likely to be tried first most of the
23153 time.
23154
23155 .cindex "hints database" "use for retrying"
23156 Retry times are hints rather than promises. Exim does not make any attempt to
23157 run deliveries exactly at the computed times. Instead, a queue runner process
23158 starts delivery processes for delayed messages periodically, and these attempt
23159 new deliveries only for those addresses that have passed their next retry time.
23160 If a new message arrives for a deferred address, an immediate delivery attempt
23161 occurs only if the address has passed its retry time. In the absence of new
23162 messages, the minimum time between retries is the interval between queue runner
23163 processes. There is not much point in setting retry times of five minutes if
23164 your queue runners happen only once an hour, unless there are a significant
23165 number of incoming messages (which might be the case on a system that is
23166 sending everything to a smart host, for example).
23167
23168 The data in the retry hints database can be inspected by using the
23169 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23170 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23171 &'exinext'& utility script can be used to find out what the next retry times
23172 are for the hosts associated with a particular mail domain, and also for local
23173 deliveries that have been deferred.
23174
23175
23176 .section "Retry rule examples" "SECID164"
23177 Here are some example retry rules:
23178 .code
23179 alice@wonderland.fict.example quota_5d  F,7d,3h
23180 wonderland.fict.example       quota_5d
23181 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23182 lookingglass.fict.example     *         F,24h,30m;
23183 *                 refused_A   F,2h,20m;
23184 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23185 .endd
23186 The first rule sets up special handling for mail to
23187 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23188 mailbox has not been read for at least 5 days. Retries continue every three
23189 hours for 7 days. The second rule handles over-quota errors for all other local
23190 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23191 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23192 fail are bounced immediately if the mailbox has not been read for at least 5
23193 days.
23194
23195 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23196 happen every 15 minutes for an hour, then with geometrically increasing
23197 intervals until two days have passed since a delivery first failed. After the
23198 first hour there is a delay of one hour, then two hours, then four hours, and
23199 so on (this is a rather extreme example).
23200
23201 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23202 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23203 all other domains, with special action for connection refusal from hosts that
23204 were not obtained from an MX record.
23205
23206 The final rule in a retry configuration should always have asterisks in the
23207 first two fields so as to provide a general catch-all for any addresses that do
23208 not have their own special handling. This example tries every 15 minutes for 2
23209 hours, then with intervals starting at one hour and increasing by a factor of
23210 1.5 up to 16 hours, then every 8 hours up to 5 days.
23211
23212
23213
23214 .section "Timeout of retry data" "SECID165"
23215 .cindex "timeout" "of retry data"
23216 .oindex "&%retry_data_expire%&"
23217 .cindex "hints database" "data expiry"
23218 .cindex "retry" "timeout of data"
23219 Exim timestamps the data that it writes to its retry hints database. When it
23220 consults the data during a delivery it ignores any that is older than the value
23221 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23222 been tried for 7 days, Exim will try to deliver to it immediately a message
23223 arrives, and if that fails, it will calculate a retry time as if it were
23224 failing for the first time.
23225
23226 This improves the behaviour for messages routed to rarely-used hosts such as MX
23227 backups. If such a host was down at one time, and happens to be down again when
23228 Exim tries a month later, using the old retry data would imply that it had been
23229 down all the time, which is not a justified assumption.
23230
23231 If a host really is permanently dead, this behaviour causes a burst of retries
23232 every now and again, but only if messages routed to it are rare. If there is a
23233 message at least once every 7 days the retry data never expires.
23234
23235
23236
23237
23238 .section "Long-term failures" "SECID166"
23239 .cindex "delivery failure, long-term"
23240 .cindex "retry" "after long-term failure"
23241 Special processing happens when an email address has been failing for so long
23242 that the cutoff time for the last algorithm is reached. For example, using the
23243 default retry rule:
23244 .code
23245 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23246 .endd
23247 the cutoff time is four days. Reaching the retry cutoff is independent of how
23248 long any specific message has been failing; it is the length of continuous
23249 failure for the recipient address that counts.
23250
23251 When the cutoff time is reached for a local delivery, or for all the IP
23252 addresses associated with a remote delivery, a subsequent delivery failure
23253 causes Exim to give up on the address, and a bounce message is generated.
23254 In order to cater for new messages that use the failing address, a next retry
23255 time is still computed from the final algorithm, and is used as follows:
23256
23257 For local deliveries, one delivery attempt is always made for any subsequent
23258 messages. If this delivery fails, the address fails immediately. The
23259 post-cutoff retry time is not used.
23260
23261 If the delivery is remote, there are two possibilities, controlled by the
23262 .oindex "&%delay_after_cutoff%&"
23263 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23264 default. Until the post-cutoff retry time for one of the IP addresses is
23265 reached, the failing email address is bounced immediately, without a delivery
23266 attempt taking place. After that time, one new delivery attempt is made to
23267 those IP addresses that are past their retry times, and if that still fails,
23268 the address is bounced and new retry times are computed.
23269
23270 In other words, when all the hosts for a given email address have been failing
23271 for a long time, Exim bounces rather then defers until one of the hosts' retry
23272 times is reached. Then it tries once, and bounces if that attempt fails. This
23273 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23274 to a broken destination, but if the host does recover, Exim will eventually
23275 notice.
23276
23277 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23278 addresses are past their final cutoff time, Exim tries to deliver to those IP
23279 addresses that have not been tried since the message arrived. If there are
23280 no suitable IP addresses, or if they all fail, the address is bounced. In other
23281 words, it does not delay when a new message arrives, but tries the expired
23282 addresses immediately, unless they have been tried since the message arrived.
23283 If there is a continuous stream of messages for the failing domains, setting
23284 &%delay_after_cutoff%& false means that there will be many more attempts to
23285 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23286 true.
23287
23288 .section "Deliveries that work intermittently" "SECID167"
23289 .cindex "retry" "intermittently working deliveries"
23290 Some additional logic is needed to cope with cases where a host is
23291 intermittently available, or when a message has some attribute that prevents
23292 its delivery when others to the same address get through. In this situation,
23293 because some messages are successfully delivered, the &"retry clock"& for the
23294 host or address keeps getting reset by the successful deliveries, and so
23295 failing messages remain on the queue for ever because the cutoff time is never
23296 reached.
23297
23298 Two exceptional actions are applied to prevent this happening. The first
23299 applies to errors that are related to a message rather than a remote host.
23300 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23301 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23302 commands, and quota failures. For this type of error, if a message's arrival
23303 time is earlier than the &"first failed"& time for the error, the earlier time
23304 is used when scanning the retry rules to decide when to try next and when to
23305 time out the address.
23306
23307 The exceptional second action applies in all cases. If a message has been on
23308 the queue for longer than the cutoff time of any applicable retry rule for a
23309 given address, a delivery is attempted for that address, even if it is not yet
23310 time, and if this delivery fails, the address is timed out. A new retry time is
23311 not computed in this case, so that other messages for the same address are
23312 considered immediately.
23313 .ecindex IIDretconf1
23314 .ecindex IIDregconf2
23315
23316
23317
23318
23319
23320
23321 . ////////////////////////////////////////////////////////////////////////////
23322 . ////////////////////////////////////////////////////////////////////////////
23323
23324 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23325 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23326 .scindex IIDauthconf2 "authentication"
23327 The &"authenticators"& section of Exim's run time configuration is concerned
23328 with SMTP authentication. This facility is an extension to the SMTP protocol,
23329 described in RFC 2554, which allows a client SMTP host to authenticate itself
23330 to a server. This is a common way for a server to recognize clients that are
23331 permitted to use it as a relay. SMTP authentication is not of relevance to the
23332 transfer of mail between servers that have no managerial connection with each
23333 other.
23334
23335 .cindex "AUTH" "description of"
23336 Very briefly, the way SMTP authentication works is as follows:
23337
23338 .ilist
23339 The server advertises a number of authentication &'mechanisms'& in response to
23340 the client's EHLO command.
23341 .next
23342 The client issues an AUTH command, naming a specific mechanism. The command
23343 may, optionally, contain some authentication data.
23344 .next
23345 The server may issue one or more &'challenges'&, to which the client must send
23346 appropriate responses. In simple authentication mechanisms, the challenges are
23347 just prompts for user names and passwords. The server does not have to issue
23348 any challenges &-- in some mechanisms the relevant data may all be transmitted
23349 with the AUTH command.
23350 .next
23351 The server either accepts or denies authentication.
23352 .next
23353 If authentication succeeds, the client may optionally make use of the AUTH
23354 option on the MAIL command to pass an authenticated sender in subsequent
23355 mail transactions. Authentication lasts for the remainder of the SMTP
23356 connection.
23357 .next
23358 If authentication fails, the client may give up, or it may try a different
23359 authentication mechanism, or it may try transferring mail over the
23360 unauthenticated connection.
23361 .endlist
23362
23363 If you are setting up a client, and want to know which authentication
23364 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23365 SMTP port) on the server, and issue an EHLO command. The response to this
23366 includes the list of supported mechanisms. For example:
23367 .display
23368 &`$ `&&*&`telnet server.example 25`&*&
23369 &`Trying 192.168.34.25...`&
23370 &`Connected to server.example.`&
23371 &`Escape character is &#x0027;^]&#x0027;.`&
23372 &`220 server.example ESMTP Exim 4.20 ...`&
23373 &*&`ehlo client.example`&*&
23374 &`250-server.example Hello client.example [10.8.4.5]`&
23375 &`250-SIZE 52428800`&
23376 &`250-PIPELINING`&
23377 &`250-AUTH PLAIN`&
23378 &`250 HELP`&
23379 .endd
23380 The second-last line of this example output shows that the server supports
23381 authentication using the PLAIN mechanism. In Exim, the different authentication
23382 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23383 routers and transports, which authenticators are included in the binary is
23384 controlled by build-time definitions. The following are currently available,
23385 included by setting
23386 .code
23387 AUTH_CRAM_MD5=yes
23388 AUTH_CYRUS_SASL=yes
23389 AUTH_PLAINTEXT=yes
23390 AUTH_SPA=yes
23391 .endd
23392 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23393 authentication mechanism (RFC 2195), and the second provides an interface to
23394 the Cyrus SASL authentication library. The third can be configured to support
23395 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23396 not formally documented, but used by several MUAs. The fourth authenticator
23397 supports Microsoft's &'Secure Password Authentication'& mechanism.
23398
23399 The authenticators are configured using the same syntax as other drivers (see
23400 section &<<SECTfordricon>>&). If no authenticators are required, no
23401 authentication section need be present in the configuration file. Each
23402 authenticator can in principle have both server and client functions. When Exim
23403 is receiving SMTP mail, it is acting as a server; when it is sending out
23404 messages over SMTP, it is acting as a client. Authenticator configuration
23405 options are provided for use in both these circumstances.
23406
23407 To make it clear which options apply to which situation, the prefixes
23408 &%server_%& and &%client_%& are used on option names that are specific to
23409 either the server or the client function, respectively. Server and client
23410 functions are disabled if none of their options are set. If an authenticator is
23411 to be used for both server and client functions, a single definition, using
23412 both sets of options, is required. For example:
23413 .code
23414 cram:
23415   driver = cram_md5
23416   public_name = CRAM-MD5
23417   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23418   client_name = ph10
23419   client_secret = secret2
23420 .endd
23421 The &%server_%& option is used when Exim is acting as a server, and the
23422 &%client_%& options when it is acting as a client.
23423
23424 Descriptions of the individual authenticators are given in subsequent chapters.
23425 The remainder of this chapter covers the generic options for the
23426 authenticators, followed by general discussion of the way authentication works
23427 in Exim.
23428
23429
23430
23431 .section "Generic options for authenticators" "SECID168"
23432 .cindex "authentication" "generic options"
23433 .cindex "options" "generic; for authenticators"
23434
23435 .option client_condition authenticators string&!! unset
23436 When Exim is authenticating as a client, it skips any authenticator whose
23437 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23438 used, for example, to skip plain text authenticators when the connection is not
23439 encrypted by a setting such as:
23440 .code
23441 client_condition = ${if !eq{$tls_cipher}{}}
23442 .endd
23443 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23444 used for incoming messages. In fact, during SMTP delivery, it contains the
23445 cipher used for the delivery.)
23446
23447
23448 .option driver authenticators string unset
23449 This option must always be set. It specifies which of the available
23450 authenticators is to be used.
23451
23452
23453 .option public_name authenticators string unset
23454 This option specifies the name of the authentication mechanism that the driver
23455 implements, and by which it is known to the outside world. These names should
23456 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23457 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23458 defaults to the driver's instance name.
23459
23460
23461 .option server_advertise_condition authenticators string&!! unset
23462 When a server is about to advertise an authentication mechanism, the condition
23463 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23464 mechanism is not advertised.
23465 If the expansion fails, the mechanism is not advertised. If the failure was not
23466 forced, and was not caused by a lookup defer, the incident is logged.
23467 See section &<<SECTauthexiser>>& below for further discussion.
23468
23469
23470 .option server_condition authenticators string&!! unset
23471 This option must be set for a &%plaintext%& server authenticator, where it
23472 is used directly to control authentication. See section &<<SECTplainserver>>&
23473 for details.
23474
23475 For the other authenticators, &%server_condition%& can be used as an additional
23476 authentication or authorization mechanism that is applied after the other
23477 authenticator conditions succeed. If it is set, it is expanded when the
23478 authenticator would otherwise return a success code. If the expansion is forced
23479 to fail, authentication fails. Any other expansion failure causes a temporary
23480 error code to be returned. If the result of a successful expansion is an empty
23481 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23482 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23483 other result, a temporary error code is returned, with the expanded string as
23484 the error text.
23485
23486
23487 .option server_debug_print authenticators string&!! unset
23488 If this option is set and authentication debugging is enabled (see the &%-d%&
23489 command line option), the string is expanded and included in the debugging
23490 output when the authenticator is run as a server. This can help with checking
23491 out the values of variables.
23492 If expansion of the string fails, the error message is written to the debugging
23493 output, and Exim carries on processing.
23494
23495
23496 .option server_set_id authenticators string&!! unset
23497 .vindex "&$authenticated_id$&"
23498 When an Exim server successfully authenticates a client, this string is
23499 expanded using data from the authentication, and preserved for any incoming
23500 messages in the variable &$authenticated_id$&. It is also included in the log
23501 lines for incoming messages. For example, a user/password authenticator
23502 configuration might preserve the user name that was used to authenticate, and
23503 refer to it subsequently during delivery of the message.
23504 If expansion fails, the option is ignored.
23505
23506
23507 .option server_mail_auth_condition authenticators string&!! unset
23508 This option allows a server to discard authenticated sender addresses supplied
23509 as part of MAIL commands in SMTP connections that are authenticated by the
23510 driver on which &%server_mail_auth_condition%& is set. The option is not used
23511 as part of the authentication process; instead its (unexpanded) value is
23512 remembered for later use.
23513 How it is used is described in the following section.
23514
23515
23516
23517
23518
23519 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23520 .cindex "authentication" "sender; authenticated"
23521 .cindex "AUTH" "on MAIL command"
23522 When a client supplied an AUTH= item on a MAIL command, Exim applies
23523 the following checks before accepting it as the authenticated sender of the
23524 message:
23525
23526 .ilist
23527 If the connection is not using extended SMTP (that is, HELO was used rather
23528 than EHLO), the use of AUTH= is a syntax error.
23529 .next
23530 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23531 .next
23532 .vindex "&$authenticated_sender$&"
23533 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23534 running, the value of &$authenticated_sender$& is set to the value obtained
23535 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23536 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23537 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23538 given for the MAIL command.
23539 .next
23540 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23541 is accepted and placed in &$authenticated_sender$& only if the client has
23542 authenticated.
23543 .next
23544 If the AUTH= value was accepted by either of the two previous rules, and
23545 the client has authenticated, and the authenticator has a setting for the
23546 &%server_mail_auth_condition%&, the condition is checked at this point. The
23547 valued that was saved from the authenticator is expanded. If the expansion
23548 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23549 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23550 the value of &$authenticated_sender$& is retained and passed on with the
23551 message.
23552 .endlist
23553
23554
23555 When &$authenticated_sender$& is set for a message, it is passed on to other
23556 hosts to which Exim authenticates as a client. Do not confuse this value with
23557 &$authenticated_id$&, which is a string obtained from the authentication
23558 process, and which is not usually a complete email address.
23559
23560 .vindex "&$sender_address$&"
23561 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23562 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23563 therefore make use of &$authenticated_sender$&. The converse is not true: the
23564 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23565 ACL is run.
23566
23567
23568
23569 .section "Authentication on an Exim server" "SECTauthexiser"
23570 .cindex "authentication" "on an Exim server"
23571 When Exim receives an EHLO command, it advertises the public names of those
23572 authenticators that are configured as servers, subject to the following
23573 conditions:
23574
23575 .ilist
23576 The client host must match &%auth_advertise_hosts%& (default *).
23577 .next
23578 It the &%server_advertise_condition%& option is set, its expansion must not
23579 yield the empty string, &"0"&, &"no"&, or &"false"&.
23580 .endlist
23581
23582 The order in which the authenticators are defined controls the order in which
23583 the mechanisms are advertised.
23584
23585 Some mail clients (for example, some versions of Netscape) require the user to
23586 provide a name and password for authentication whenever AUTH is advertised,
23587 even though authentication may not in fact be needed (for example, Exim may be
23588 set up to allow unconditional relaying from the client by an IP address check).
23589 You can make such clients more friendly by not advertising AUTH to them.
23590 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23591 that runs for RCPT) to relay without authentication, you should set
23592 .code
23593 auth_advertise_hosts = ! 10.9.8.0/24
23594 .endd
23595 so that no authentication mechanisms are advertised to them.
23596
23597 The &%server_advertise_condition%& controls the advertisement of individual
23598 authentication mechanisms. For example, it can be used to restrict the
23599 advertisement of a particular mechanism to encrypted connections, by a setting
23600 such as:
23601 .code
23602 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23603 .endd
23604 .vindex "&$tls_cipher$&"
23605 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23606 yields &"yes"&, which allows the advertisement to happen.
23607
23608 When an Exim server receives an AUTH command from a client, it rejects it
23609 immediately if AUTH was not advertised in response to an earlier EHLO
23610 command. This is the case if
23611
23612 .ilist
23613 The client host does not match &%auth_advertise_hosts%&; or
23614 .next
23615 No authenticators are configured with server options; or
23616 .next
23617 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23618 server authenticators.
23619 .endlist
23620
23621
23622 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23623 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23624 AUTH is accepted from any client host.
23625
23626 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23627 server authentication mechanism that was advertised in response to EHLO and
23628 that matches the one named in the AUTH command. If it finds one, it runs
23629 the appropriate authentication protocol, and authentication either succeeds or
23630 fails. If there is no matching advertised mechanism, the AUTH command is
23631 rejected with a 504 error.
23632
23633 .vindex "&$received_protocol$&"
23634 .vindex "&$sender_host_authenticated$&"
23635 When a message is received from an authenticated host, the value of
23636 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23637 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23638 public name) of the authenticator driver that successfully authenticated the
23639 client from which the message was received. This variable is empty if there was
23640 no successful authentication.
23641
23642
23643
23644
23645 .section "Testing server authentication" "SECID169"
23646 .cindex "authentication" "testing a server"
23647 .cindex "AUTH" "testing a server"
23648 .cindex "base64 encoding" "creating authentication test data"
23649 Exim's &%-bh%& option can be useful for testing server authentication
23650 configurations. The data for the AUTH command has to be sent using base64
23651 encoding. A quick way to produce such data for testing is the following Perl
23652 script:
23653 .code
23654 use MIME::Base64;
23655 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23656 .endd
23657 .cindex "binary zero" "in authentication data"
23658 This interprets its argument as a Perl string, and then encodes it. The
23659 interpretation as a Perl string allows binary zeros, which are required for
23660 some kinds of authentication, to be included in the data. For example, a
23661 command line to run this script on such data might be
23662 .code
23663 encode '\0user\0password'
23664 .endd
23665 Note the use of single quotes to prevent the shell interpreting the
23666 backslashes, so that they can be interpreted by Perl to specify characters
23667 whose code value is zero.
23668
23669 &*Warning 1*&: If either of the user or password strings starts with an octal
23670 digit, you must use three zeros instead of one after the leading backslash. If
23671 you do not, the octal digit that starts your string will be incorrectly
23672 interpreted as part of the code for the first character.
23673
23674 &*Warning 2*&: If there are characters in the strings that Perl interprets
23675 specially, you must use a Perl escape to prevent them being misinterpreted. For
23676 example, a command such as
23677 .code
23678 encode '\0user@domain.com\0pas$$word'
23679 .endd
23680 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23681
23682 If you have the &%mimencode%& command installed, another way to do produce
23683 base64-encoded strings is to run the command
23684 .code
23685 echo -e -n `\0user\0password' | mimencode
23686 .endd
23687 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23688 in the argument, and the &%-n%& option specifies no newline at the end of its
23689 output. However, not all versions of &%echo%& recognize these options, so you
23690 should check your version before relying on this suggestion.
23691
23692
23693
23694 .section "Authentication by an Exim client" "SECID170"
23695 .cindex "authentication" "on an Exim client"
23696 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23697 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23698 announces support for authentication, and the host matches an entry in either
23699 of these options, Exim (as a client) tries to authenticate as follows:
23700
23701 .ilist
23702 For each authenticator that is configured as a client, in the order in which
23703 they are defined in the configuration, it searches the authentication
23704 mechanisms announced by the server for one whose name matches the public name
23705 of the authenticator.
23706 .next
23707 .vindex "&$host$&"
23708 .vindex "&$host_address$&"
23709 When it finds one that matches, it runs the authenticator's client code. The
23710 variables &$host$& and &$host_address$& are available for any string expansions
23711 that the client might do. They are set to the server's name and IP address. If
23712 any expansion is forced to fail, the authentication attempt is abandoned, and
23713 Exim moves on to the next authenticator. Otherwise an expansion failure causes
23714 delivery to be deferred.
23715 .next
23716 If the result of the authentication attempt is a temporary error or a timeout,
23717 Exim abandons trying to send the message to the host for the moment. It will
23718 try again later. If there are any backup hosts available, they are tried in the
23719 usual way.
23720 .next
23721 If the response to authentication is a permanent error (5&'xx'& code), Exim
23722 carries on searching the list of authenticators and tries another one if
23723 possible. If all authentication attempts give permanent errors, or if there are
23724 no attempts because no mechanisms match (or option expansions force failure),
23725 what happens depends on whether the host matches &%hosts_require_auth%& or
23726 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
23727 delivery is deferred. The error can be detected in the retry rules, and thereby
23728 turned into a permanent error if you wish. In the second case, Exim tries to
23729 deliver the message unauthenticated.
23730 .endlist
23731
23732 .cindex "AUTH" "on MAIL command"
23733 When Exim has authenticated itself to a remote server, it adds the AUTH
23734 parameter to the MAIL commands it sends, if it has an authenticated sender for
23735 the message. If the message came from a remote host, the authenticated sender
23736 is the one that was receiving on an incoming MAIL command, provided that the
23737 incoming connection was authenticated and the &%server_mail_auth%& condition
23738 allowed the authenticated sender to be retained. If a local process calls Exim
23739 to send a message, the sender address that is built from the login name and
23740 &%qualify_domain%& is treated as authenticated. However, if the
23741 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
23742 the authenticated sender that was received with the message.
23743 .ecindex IIDauthconf1
23744 .ecindex IIDauthconf2
23745
23746
23747
23748
23749
23750
23751 . ////////////////////////////////////////////////////////////////////////////
23752 . ////////////////////////////////////////////////////////////////////////////
23753
23754 .chapter "The plaintext authenticator" "CHAPplaintext"
23755 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
23756 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
23757 The &(plaintext)& authenticator can be configured to support the PLAIN and
23758 LOGIN authentication mechanisms, both of which transfer authentication data as
23759 plain (unencrypted) text (though base64 encoded). The use of plain text is a
23760 security risk; you are strongly advised to insist on the use of SMTP encryption
23761 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
23762 use unencrypted plain text, you should not use the same passwords for SMTP
23763 connections as you do for login accounts.
23764
23765 .section "Plaintext options" "SECID171"
23766 .cindex "options" "&(plaintext)& authenticator (server)"
23767 When configured as a server, &(plaintext)& uses the following options:
23768
23769 .option server_condition authenticators string&!! unset
23770 This is actually a global authentication option, but it must be set in order to
23771 configure the &(plaintext)& driver as a server. Its use is described below.
23772
23773 .option server_prompts plaintext string&!! unset
23774 The contents of this option, after expansion, must be a colon-separated list of
23775 prompt strings. If expansion fails, a temporary authentication rejection is
23776 given.
23777
23778 .section "Using plaintext in a server" "SECTplainserver"
23779 .cindex "AUTH" "in &(plaintext)& authenticator"
23780 .cindex "binary zero" "in &(plaintext)& authenticator"
23781 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
23782         "in &(plaintext)& authenticator"
23783 .vindex "&$auth1$&, &$auth2$&, etc"
23784 .cindex "base64 encoding" "in &(plaintext)& authenticator"
23785
23786 When running as a server, &(plaintext)& performs the authentication test by
23787 expanding a string. The data sent by the client with the AUTH command, or in
23788 response to subsequent prompts, is base64 encoded, and so may contain any byte
23789 values when decoded. If any data is supplied with the command, it is treated as
23790 a list of strings, separated by NULs (binary zeros), the first three of which
23791 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
23792 (neither LOGIN nor PLAIN uses more than three strings).
23793
23794 For compatibility with previous releases of Exim, the values are also placed in
23795 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
23796 variables for this purpose is now deprecated, as it can lead to confusion in
23797 string expansions that also use them for other things.
23798
23799 If there are more strings in &%server_prompts%& than the number of strings
23800 supplied with the AUTH command, the remaining prompts are used to obtain more
23801 data. Each response from the client may be a list of NUL-separated strings.
23802
23803 .vindex "&$authenticated_id$&"
23804 Once a sufficient number of data strings have been received,
23805 &%server_condition%& is expanded. If the expansion is forced to fail,
23806 authentication fails. Any other expansion failure causes a temporary error code
23807 to be returned. If the result of a successful expansion is an empty string,
23808 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23809 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
23810 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
23811 For any other result, a temporary error code is returned, with the expanded
23812 string as the error text.
23813
23814 &*Warning*&: If you use a lookup in the expansion to find the user's
23815 password, be sure to make the authentication fail if the user is unknown.
23816 There are good and bad examples at the end of the next section.
23817
23818
23819
23820 .section "The PLAIN authentication mechanism" "SECID172"
23821 .cindex "PLAIN authentication mechanism"
23822 .cindex "authentication" "PLAIN mechanism"
23823 .cindex "binary zero" "in &(plaintext)& authenticator"
23824 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
23825 sent as one item of data (that is, one combined string containing two NUL
23826 separators). The data is sent either as part of the AUTH command, or
23827 subsequently in response to an empty prompt from the server.
23828
23829 The second and third strings are a user name and a corresponding password.
23830 Using a single fixed user name and password as an example, this could be
23831 configured as follows:
23832 .code
23833 fixed_plain:
23834   driver = plaintext
23835   public_name = PLAIN
23836   server_prompts = :
23837   server_condition = \
23838     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
23839   server_set_id = $auth2
23840 .endd
23841 Note that the default result strings from &%if%& (&"true"& or an empty string)
23842 are exactly what we want here, so they need not be specified. Obviously, if the
23843 password contains expansion-significant characters such as dollar, backslash,
23844 or closing brace, they have to be escaped.
23845
23846 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
23847 the end of a string list are ignored). If all the data comes as part of the
23848 AUTH command, as is commonly the case, the prompt is not used. This
23849 authenticator is advertised in the response to EHLO as
23850 .code
23851 250-AUTH PLAIN
23852 .endd
23853 and a client host can authenticate itself by sending the command
23854 .code
23855 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
23856 .endd
23857 As this contains three strings (more than the number of prompts), no further
23858 data is required from the client. Alternatively, the client may just send
23859 .code
23860 AUTH PLAIN
23861 .endd
23862 to initiate authentication, in which case the server replies with an empty
23863 prompt. The client must respond with the combined data string.
23864
23865 The data string is base64 encoded, as required by the RFC. This example,
23866 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
23867 represents a zero byte. This is split up into three strings, the first of which
23868 is empty. The &%server_condition%& option in the authenticator checks that the
23869 second two are &`username`& and &`mysecret`& respectively.
23870
23871 Having just one fixed user name and password, as in this example, is not very
23872 realistic, though for a small organization with only a handful of
23873 authenticating clients it could make sense.
23874
23875 A more sophisticated instance of this authenticator could use the user name in
23876 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
23877 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
23878 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
23879 This is an incorrect example:
23880 .code
23881 server_condition = \
23882   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
23883 .endd
23884 The expansion uses the user name (&$auth2$&) as the key to look up a password,
23885 which it then compares to the supplied password (&$auth3$&). Why is this example
23886 incorrect? It works fine for existing users, but consider what happens if a
23887 non-existent user name is given. The lookup fails, but as no success/failure
23888 strings are given for the lookup, it yields an empty string. Thus, to defeat
23889 the authentication, all a client has to do is to supply a non-existent user
23890 name and an empty password. The correct way of writing this test is:
23891 .code
23892 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
23893   {${if eq{$value}{$auth3}}} {false}}
23894 .endd
23895 In this case, if the lookup succeeds, the result is checked; if the lookup
23896 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
23897 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
23898 always fails if its second argument is empty. However, the second way of
23899 writing the test makes the logic clearer.
23900
23901
23902 .section "The LOGIN authentication mechanism" "SECID173"
23903 .cindex "LOGIN authentication mechanism"
23904 .cindex "authentication" "LOGIN mechanism"
23905 The LOGIN authentication mechanism is not documented in any RFC, but is in use
23906 in a number of programs. No data is sent with the AUTH command. Instead, a
23907 user name and password are supplied separately, in response to prompts. The
23908 plaintext authenticator can be configured to support this as in this example:
23909 .code
23910 fixed_login:
23911   driver = plaintext
23912   public_name = LOGIN
23913   server_prompts = User Name : Password
23914   server_condition = \
23915     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
23916   server_set_id = $auth1
23917 .endd
23918 Because of the way plaintext operates, this authenticator accepts data supplied
23919 with the AUTH command (in contravention of the specification of LOGIN), but
23920 if the client does not supply it (as is the case for LOGIN clients), the prompt
23921 strings are used to obtain two data items.
23922
23923 Some clients are very particular about the precise text of the prompts. For
23924 example, Outlook Express is reported to recognize only &"Username:"& and
23925 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
23926 strings. It uses the &%ldapauth%& expansion condition to check the user
23927 name and password by binding to an LDAP server:
23928 .code
23929 login:
23930   driver = plaintext
23931   public_name = LOGIN
23932   server_prompts = Username:: : Password::
23933   server_condition = ${if and{{ \
23934     !eq{}{$auth1} }{ \
23935     ldapauth{user="cn=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
23936              pass=${quote:$auth2} \
23937              ldap://ldap.example.org/} }} }
23938   server_set_id = uid=$auth1,ou=people,o=example.org
23939 .endd
23940 We have to check that the username is not empty before using it, because LDAP
23941 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
23942 operator to correctly quote the DN for authentication. However, the basic
23943 &%quote%& operator, rather than any of the LDAP quoting operators, is the
23944 correct one to use for the password, because quoting is needed only to make
23945 the password conform to the Exim syntax. At the LDAP level, the password is an
23946 uninterpreted string.
23947
23948
23949 .section "Support for different kinds of authentication" "SECID174"
23950 A number of string expansion features are provided for the purpose of
23951 interfacing to different ways of user authentication. These include checking
23952 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
23953 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
23954 &<<SECTexpcond>>&.
23955
23956
23957
23958
23959 .section "Using plaintext in a client" "SECID175"
23960 .cindex "options" "&(plaintext)& authenticator (client)"
23961 The &(plaintext)& authenticator has two client options:
23962
23963 .option client_ignore_invalid_base64 plaintext boolean false
23964 If the client receives a server prompt that is not a valid base64 string,
23965 authentication is abandoned by default. However, if this option is set true,
23966 the error in the challenge is ignored and the client sends the response as
23967 usual.
23968
23969 .option client_send plaintext string&!! unset
23970 The string is a colon-separated list of authentication data strings. Each
23971 string is independently expanded before being sent to the server. The first
23972 string is sent with the AUTH command; any more strings are sent in response
23973 to prompts from the server. Before each string is expanded, the value of the
23974 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
23975 with &$auth1$& for the first prompt. Up to three prompts are stored in this
23976 way. Thus, the prompt that is received in response to sending the first string
23977 (with the AUTH command) can be used in the expansion of the second string, and
23978 so on. If an invalid base64 string is received when
23979 &%client_ignore_invalid_base64%& is set, an empty string is put in the
23980 &$auth$&<&'n'&> variable.
23981
23982 &*Note*&: You cannot use expansion to create multiple strings, because
23983 splitting takes priority and happens first.
23984
23985 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
23986 the data, further processing is applied to each string before it is sent. If
23987 there are any single circumflex characters in the string, they are converted to
23988 NULs. Should an actual circumflex be required as data, it must be doubled in
23989 the string.
23990
23991 This is an example of a client configuration that implements the PLAIN
23992 authentication mechanism with a fixed user name and password:
23993 .code
23994 fixed_plain:
23995   driver = plaintext
23996   public_name = PLAIN
23997   client_send = ^username^mysecret
23998 .endd
23999 The lack of colons means that the entire text is sent with the AUTH
24000 command, with the circumflex characters converted to NULs. A similar example
24001 that uses the LOGIN mechanism is:
24002 .code
24003 fixed_login:
24004   driver = plaintext
24005   public_name = LOGIN
24006   client_send = : username : mysecret
24007 .endd
24008 The initial colon means that the first string is empty, so no data is sent with
24009 the AUTH command itself. The remaining strings are sent in response to
24010 prompts.
24011 .ecindex IIDplaiauth1
24012 .ecindex IIDplaiauth2
24013
24014
24015
24016
24017 . ////////////////////////////////////////////////////////////////////////////
24018 . ////////////////////////////////////////////////////////////////////////////
24019
24020 .chapter "The cram_md5 authenticator" "CHID9"
24021 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24022 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24023 .cindex "CRAM-MD5 authentication mechanism"
24024 .cindex "authentication" "CRAM-MD5 mechanism"
24025 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24026 sends a challenge string to the client, and the response consists of a user
24027 name and the CRAM-MD5 digest of the challenge string combined with a secret
24028 string (password) which is known to both server and client. Thus, the secret
24029 is not sent over the network as plain text, which makes this authenticator more
24030 secure than &(plaintext)&. However, the downside is that the secret has to be
24031 available in plain text at either end.
24032
24033
24034 .section "Using cram_md5 as a server" "SECID176"
24035 .cindex "options" "&(cram_md5)& authenticator (server)"
24036 This authenticator has one server option, which must be set to configure the
24037 authenticator as a server:
24038
24039 .option server_secret cram_md5 string&!! unset
24040 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24041 When the server receives the client's response, the user name is placed in
24042 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24043 obtain the password for that user. The server then computes the CRAM-MD5 digest
24044 that the client should have sent, and checks that it received the correct
24045 string. If the expansion of &%server_secret%& is forced to fail, authentication
24046 fails. If the expansion fails for some other reason, a temporary error code is
24047 returned to the client.
24048
24049 For compatibility with previous releases of Exim, the user name is also placed
24050 in &$1$&. However, the use of this variables for this purpose is now
24051 deprecated, as it can lead to confusion in string expansions that also use
24052 numeric variables for other things.
24053
24054 For example, the following authenticator checks that the user name given by the
24055 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24056 user name, authentication fails.
24057 .code
24058 fixed_cram:
24059   driver = cram_md5
24060   public_name = CRAM-MD5
24061   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24062   server_set_id = $auth1
24063 .endd
24064 .vindex "&$authenticated_id$&"
24065 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24066 name in &$authenticated_id$&. A more typical configuration might look up the
24067 secret string in a file, using the user name as the key. For example:
24068 .code
24069 lookup_cram:
24070   driver = cram_md5
24071   public_name = CRAM-MD5
24072   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24073                   {$value}fail}
24074   server_set_id = $auth1
24075 .endd
24076 Note that this expansion explicitly forces failure if the lookup fails
24077 because &$auth1$& contains an unknown user name.
24078
24079
24080 .section "Using cram_md5 as a client" "SECID177"
24081 .cindex "options" "&(cram_md5)& authenticator (client)"
24082 When used as a client, the &(cram_md5)& authenticator has two options:
24083
24084
24085
24086 .option client_name cram_md5 string&!! "the primary host name"
24087 This string is expanded, and the result used as the user name data when
24088 computing the response to the server's challenge.
24089
24090
24091 .option client_secret cram_md5 string&!! unset
24092 This option must be set for the authenticator to work as a client. Its value is
24093 expanded and the result used as the secret string when computing the response.
24094
24095
24096 .vindex "&$host$&"
24097 .vindex "&$host_address$&"
24098 Different user names and secrets can be used for different servers by referring
24099 to &$host$& or &$host_address$& in the options. Forced failure of either
24100 expansion string is treated as an indication that this authenticator is not
24101 prepared to handle this case. Exim moves on to the next configured client
24102 authenticator. Any other expansion failure causes Exim to give up trying to
24103 send the message to the current server.
24104
24105 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24106 strings, is:
24107 .code
24108 fixed_cram:
24109   driver = cram_md5
24110   public_name = CRAM-MD5
24111   client_name = ph10
24112   client_secret = secret
24113 .endd
24114 .ecindex IIDcramauth1
24115 .ecindex IIDcramauth2
24116
24117
24118
24119 . ////////////////////////////////////////////////////////////////////////////
24120 . ////////////////////////////////////////////////////////////////////////////
24121
24122 .chapter "The cyrus_sasl authenticator" "CHID10"
24123 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24124 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24125 .cindex "Cyrus" "SASL library"
24126 .cindex "Kerberos"
24127 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24128 Digital Ltd (&url(http://www.aldigital.co.uk)).
24129
24130 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24131 library implementation of the RFC 2222 (&"Simple Authentication and Security
24132 Layer"&). This library supports a number of authentication mechanisms,
24133 including PLAIN and LOGIN, but also several others that Exim does not support
24134 directly. In particular, there is support for Kerberos authentication.
24135
24136 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24137 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24138 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24139 name of the driver to determine which mechanism to support.
24140
24141 Where access to some kind of secret file is required, for example in GSSAPI
24142 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24143 user, and that the Cyrus SASL library has no way of escalating privileges
24144 by default. You may also find you need to set environment variables,
24145 depending on the driver you are using.
24146
24147 The application name provided by Exim is &"exim"&, so various SASL options may
24148 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24149 Kerberos, note that because of limitations in the GSSAPI interface,
24150 changing the server keytab might need to be communicated down to the Kerberos
24151 layer independently. The mechanism for doing so is dependent upon the Kerberos
24152 implementation. For example, for Heimdal, the environment variable KRB5_KTNAME
24153 may be set to point to an alternative keytab file. Exim will pass this
24154 variable through from its own inherited environment when started as root or the
24155 Exim user. The keytab file needs to be readable by the Exim user.
24156
24157
24158 .section "Using cyrus_sasl as a server" "SECID178"
24159 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24160 (on a successful authentication) into &$auth1$&. For compatibility with
24161 previous releases of Exim, the username is also placed in &$1$&. However, the
24162 use of this variable for this purpose is now deprecated, as it can lead to
24163 confusion in string expansions that also use numeric variables for other
24164 things.
24165
24166
24167 .option server_hostname cyrus_sasl string&!! "see below"
24168 This option selects the hostname that is used when communicating with the
24169 library. The default value is &`$primary_hostname`&. It is up to the underlying
24170 SASL plug-in what it does with this data.
24171
24172
24173 .option server_mech cyrus_sasl string "see below"
24174 This option selects the authentication mechanism this driver should use. The
24175 default is the value of the generic &%public_name%& option. This option allows
24176 you to use a different underlying mechanism from the advertised name. For
24177 example:
24178 .code
24179 sasl:
24180   driver = cyrus_sasl
24181   public_name = X-ANYTHING
24182   server_mech = CRAM-MD5
24183   server_set_id = $auth1
24184 .endd
24185
24186 .option server_realm cyrus_sasl string unset
24187 This specifies the SASL realm that the server claims to be in.
24188
24189
24190 .option server_service cyrus_sasl string &`smtp`&
24191 This is the SASL service that the server claims to implement.
24192
24193
24194 For straightforward cases, you do not need to set any of the authenticator's
24195 private options. All you need to do is to specify an appropriate mechanism as
24196 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24197 PLAIN, you could have two authenticators as follows:
24198 .code
24199 sasl_cram_md5:
24200   driver = cyrus_sasl
24201   public_name = CRAM-MD5
24202   server_set_id = $auth1
24203
24204 sasl_plain:
24205   driver = cyrus_sasl
24206   public_name = PLAIN
24207   server_set_id = $auth2
24208 .endd
24209 Cyrus SASL does implement the LOGIN authentication method, even though it is
24210 not a standard method. It is disabled by default in the source distribution,
24211 but it is present in many binary distributions.
24212 .ecindex IIDcyrauth1
24213 .ecindex IIDcyrauth2
24214
24215
24216
24217
24218 . ////////////////////////////////////////////////////////////////////////////
24219 . ////////////////////////////////////////////////////////////////////////////
24220 .chapter "The dovecot authenticator" "CHAPdovecot"
24221 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24222 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24223 This authenticator is an interface to the authentication facility of the
24224 Dovecot POP/IMAP server, which can support a number of authentication methods.
24225 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24226 to use the same mechanisms for SMTP authentication. This is a server
24227 authenticator only. There is only one option:
24228
24229 .option server_socket dovecot string unset
24230
24231 This option must specify the socket that is the interface to Dovecot
24232 authentication. The &%public_name%& option must specify an authentication
24233 mechanism that Dovecot is configured to support. You can have several
24234 authenticators for different mechanisms. For example:
24235 .code
24236 dovecot_plain:
24237   driver = dovecot
24238   public_name = PLAIN
24239   server_socket = /var/run/dovecot/auth-client
24240   server_set_id = $auth2
24241
24242 dovecot_ntlm:
24243   driver = dovecot
24244   public_name = NTLM
24245   server_socket = /var/run/dovecot/auth-client
24246   server_set_id = $auth1
24247 .endd
24248 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24249 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24250 option is passed in the Dovecot authentication command. If, for a TLS
24251 connection, a client certificate has been verified, the &"valid-client-cert"&
24252 option is passed. When authentication succeeds, the identity of the user
24253 who authenticated is placed in &$auth1$&.
24254 .ecindex IIDdcotauth1
24255 .ecindex IIDdcotauth2
24256
24257
24258 . ////////////////////////////////////////////////////////////////////////////
24259 . ////////////////////////////////////////////////////////////////////////////
24260
24261 .chapter "The spa authenticator" "CHAPspa"
24262 .scindex IIDspaauth1 "&(spa)& authenticator"
24263 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24264 .cindex "authentication" "Microsoft Secure Password"
24265 .cindex "authentication" "NTLM"
24266 .cindex "Microsoft Secure Password Authentication"
24267 .cindex "NTLM authentication"
24268 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24269 Password Authentication'& mechanism,
24270 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24271 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24272 taken from the Samba project (&url(http://www.samba.org)). The code for the
24273 server side was subsequently contributed by Tom Kistner. The mechanism works as
24274 follows:
24275
24276 .ilist
24277 After the AUTH command has been accepted, the client sends an SPA
24278 authentication request based on the user name and optional domain.
24279 .next
24280 The server sends back a challenge.
24281 .next
24282 The client builds a challenge response which makes use of the user's password
24283 and sends it to the server, which then accepts or rejects it.
24284 .endlist
24285
24286 Encryption is used to protect the password in transit.
24287
24288
24289
24290 .section "Using spa as a server" "SECID179"
24291 .cindex "options" "&(spa)& authenticator (server)"
24292 The &(spa)& authenticator has just one server option:
24293
24294 .option server_password spa string&!! unset
24295 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24296 This option is expanded, and the result must be the cleartext password for the
24297 authenticating user, whose name is at this point in &$auth1$&. For
24298 compatibility with previous releases of Exim, the user name is also placed in
24299 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24300 it can lead to confusion in string expansions that also use numeric variables
24301 for other things. For example:
24302 .code
24303 spa:
24304   driver = spa
24305   public_name = NTLM
24306   server_password = \
24307     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24308 .endd
24309 If the expansion is forced to fail, authentication fails. Any other expansion
24310 failure causes a temporary error code to be returned.
24311
24312
24313
24314
24315
24316 .section "Using spa as a client" "SECID180"
24317 .cindex "options" "&(spa)& authenticator (client)"
24318 The &(spa)& authenticator has the following client options:
24319
24320
24321
24322 .option client_domain spa string&!! unset
24323 This option specifies an optional domain for the authentication.
24324
24325
24326 .option client_password spa string&!! unset
24327 This option specifies the user's password, and must be set.
24328
24329
24330 .option client_username spa string&!! unset
24331 This option specifies the user name, and must be set. Here is an example of a
24332 configuration of this authenticator for use with the mail servers at
24333 &'msn.com'&:
24334 .code
24335 msn:
24336   driver = spa
24337   public_name = MSN
24338   client_username = msn/msn_username
24339   client_password = msn_plaintext_password
24340   client_domain = DOMAIN_OR_UNSET
24341 .endd
24342 .ecindex IIDspaauth1
24343 .ecindex IIDspaauth2
24344
24345
24346
24347
24348
24349 . ////////////////////////////////////////////////////////////////////////////
24350 . ////////////////////////////////////////////////////////////////////////////
24351
24352 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24353          "Encrypted SMTP connections"
24354 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24355 .scindex IIDencsmtp2 "SMTP" "encryption"
24356 .cindex "TLS" "on SMTP connection"
24357 .cindex "OpenSSL"
24358 .cindex "GnuTLS"
24359 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24360 Sockets Layer), is implemented by making use of the OpenSSL library or the
24361 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24362 cryptographic code in the Exim distribution itself for implementing TLS. In
24363 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24364 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24365 You also need to understand the basic concepts of encryption at a managerial
24366 level, and in particular, the way that public keys, private keys, and
24367 certificates are used.
24368
24369 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24370 connection is established, the client issues a STARTTLS command. If the
24371 server accepts this, the client and the server negotiate an encryption
24372 mechanism. If the negotiation succeeds, the data that subsequently passes
24373 between them is encrypted.
24374
24375 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24376 and if so, what cipher suite is in use, whether the client supplied a
24377 certificate, and whether or not that certificate was verified. This makes it
24378 possible for an Exim server to deny or accept certain commands based on the
24379 encryption state.
24380
24381 &*Warning*&: Certain types of firewall and certain anti-virus products can
24382 disrupt TLS connections. You need to turn off SMTP scanning for these products
24383 in order to get TLS to work.
24384
24385
24386
24387 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24388          "SECID284"
24389 .cindex "ssmtp protocol"
24390 .cindex "smtps protocol"
24391 .cindex "SMTP" "ssmtp protocol"
24392 .cindex "SMTP" "smtps protocol"
24393 Early implementations of encrypted SMTP used a different TCP port from normal
24394 SMTP, and expected an encryption negotiation to start immediately, instead of
24395 waiting for a STARTTLS command from the client using the standard SMTP
24396 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24397 allocated for this purpose.
24398
24399 This approach was abandoned when encrypted SMTP was standardized, but there are
24400 still some legacy clients that use it. Exim supports these clients by means of
24401 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24402 numbers; the most common use is expected to be:
24403 .code
24404 tls_on_connect_ports = 465
24405 .endd
24406 The port numbers specified by this option apply to all SMTP connections, both
24407 via the daemon and via &'inetd'&. You still need to specify all the ports that
24408 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24409 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24410 an extra port &-- rather, it specifies different behaviour on a port that is
24411 defined elsewhere.
24412
24413 There is also a &%-tls-on-connect%& command line option. This overrides
24414 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24415
24416
24417
24418
24419
24420
24421 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24422 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24423 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24424 followed later, when the first versions of GnuTLS were released. To build Exim
24425 to use GnuTLS, you need to set
24426 .code
24427 USE_GNUTLS=yes
24428 .endd
24429 in Local/Makefile, in addition to
24430 .code
24431 SUPPORT_TLS=yes
24432 .endd
24433 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24434 include files and libraries for GnuTLS can be found.
24435
24436 There are some differences in usage when using GnuTLS instead of OpenSSL:
24437
24438 .ilist
24439 The &%tls_verify_certificates%& option must contain the name of a file, not the
24440 name of a directory (for OpenSSL it can be either).
24441 .next
24442 The &%tls_dhparam%& option is ignored, because early versions of GnuTLS had no
24443 facility for varying its Diffie-Hellman parameters. I understand that this has
24444 changed, but Exim has not been updated to provide this facility.
24445 .next
24446 .vindex "&$tls_peerdn$&"
24447 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24448 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24449 affects the value of the &$tls_peerdn$& variable.
24450 .next
24451 OpenSSL identifies cipher suites using hyphens as separators, for example:
24452 DES-CBC3-SHA. GnuTLS uses underscores, for example: RSA_ARCFOUR_SHA. What is
24453 more, OpenSSL complains if underscores are present in a cipher list. To make
24454 life simpler, Exim changes underscores to hyphens for OpenSSL and hyphens to
24455 underscores for GnuTLS when processing lists of cipher suites in the
24456 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24457 option).
24458 .next
24459 The &%tls_require_ciphers%& options operate differently, as described in the
24460 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24461 .endlist
24462
24463
24464 .section "GnuTLS parameter computation" "SECID181"
24465 GnuTLS uses D-H parameters that may take a substantial amount of time
24466 to compute. It is unreasonable to re-compute them for every TLS session.
24467 Therefore, Exim keeps this data in a file in its spool directory, called
24468 &_gnutls-params_&. The file is owned by the Exim user and is readable only by
24469 its owner. Every Exim process that start up GnuTLS reads the D-H
24470 parameters from this file. If the file does not exist, the first Exim process
24471 that needs it computes the data and writes it to a temporary file which is
24472 renamed once it is complete. It does not matter if several Exim processes do
24473 this simultaneously (apart from wasting a few resources). Once a file is in
24474 place, new Exim processes immediately start using it.
24475
24476 For maximum security, the parameters that are stored in this file should be
24477 recalculated periodically, the frequency depending on your paranoia level.
24478 Arranging this is easy in principle; just delete the file when you want new
24479 values to be computed. However, there may be a problem. The calculation of new
24480 parameters needs random numbers, and these are obtained from &_/dev/random_&.
24481 If the system is not very active, &_/dev/random_& may delay returning data
24482 until enough randomness (entropy) is available. This may cause Exim to hang for
24483 a substantial amount of time, causing timeouts on incoming connections.
24484
24485 The solution is to generate the parameters externally to Exim. They are stored
24486 in &_gnutls-params_& in PEM format, which means that they can be generated
24487 externally using the &(certtool)& command that is part of GnuTLS.
24488
24489 To replace the parameters with new ones, instead of deleting the file
24490 and letting Exim re-create it, you can generate new parameters using
24491 &(certtool)& and, when this has been done, replace Exim's cache file by
24492 renaming. The relevant commands are something like this:
24493 .code
24494 # rm -f new-params
24495 # touch new-params
24496 # chown exim:exim new-params
24497 # chmod 0400 new-params
24498 # certtool --generate-privkey --bits 512 >new-params
24499 # echo "" >>new-params
24500 # certtool --generate-dh-params --bits 1024 >> new-params
24501 # mv new-params gnutls-params
24502 .endd
24503 If Exim never has to generate the parameters itself, the possibility of
24504 stalling is removed.
24505
24506
24507 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
24508 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
24509 .oindex "&%tls_require_ciphers%&" "OpenSSL"
24510 There is a function in the OpenSSL library that can be passed a list of cipher
24511 suites before the cipher negotiation takes place. This specifies which ciphers
24512 are acceptable. The list is colon separated and may contain names like
24513 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
24514 directly to this function call. The following quotation from the OpenSSL
24515 documentation specifies what forms of item are allowed in the cipher string:
24516
24517 .ilist
24518 It can consist of a single cipher suite such as RC4-SHA.
24519 .next
24520 It can represent a list of cipher suites containing a certain algorithm,
24521 or cipher suites of a certain type. For example SHA1 represents all
24522 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
24523 SSL v3 algorithms.
24524 .next
24525 Lists of cipher suites can be combined in a single cipher string using
24526 the + character. This is used as a logical and operation. For example
24527 SHA1+DES represents all cipher suites containing the SHA1 and the DES
24528 algorithms.
24529 .endlist
24530
24531 Each cipher string can be optionally preceded by one of the characters &`!`&,
24532 &`-`& or &`+`&.
24533 .ilist
24534 If &`!`& is used, the ciphers are permanently deleted from the list. The
24535 ciphers deleted can never reappear in the list even if they are explicitly
24536 stated.
24537 .next
24538 If &`-`& is used, the ciphers are deleted from the list, but some or all
24539 of the ciphers can be added again by later options.
24540 .next
24541 If &`+`& is used, the ciphers are moved to the end of the list. This
24542 option does not add any new ciphers; it just moves matching existing ones.
24543 .endlist
24544
24545 If none of these characters is present, the string is interpreted as
24546 a list of ciphers to be appended to the current preference list. If the list
24547 includes any ciphers already present they will be ignored: that is, they will
24548 not be moved to the end of the list.
24549 .endlist
24550
24551
24552
24553 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
24554          "SECTreqciphgnu"
24555 .cindex "GnuTLS" "specifying parameters for"
24556 .cindex "TLS" "specifying ciphers (GnuTLS)"
24557 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
24558 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
24559 .cindex "TLS" "specifying protocols (GnuTLS)"
24560 .oindex "&%tls_require_ciphers%&" "GnuTLS"
24561 The GnuTLS library allows the caller to specify separate lists of permitted key
24562 exchange methods, main cipher algorithms, MAC algorithms, and protocols.
24563 Unfortunately, these lists are numerical, and the library does not have a
24564 function for turning names into numbers. Consequently, lists of recognized
24565 names have to be built into the application. The permitted key exchange
24566 methods, ciphers, and MAC algorithms may be used in any combination to form a
24567 cipher suite. This is unlike OpenSSL, where complete cipher suite names are
24568 passed to its control function.
24569
24570 For compatibility with OpenSSL, the &%tls_require_ciphers%& option can be set
24571 to complete cipher suite names such as RSA_ARCFOUR_SHA, but for GnuTLS this
24572 option controls only the cipher algorithms. Exim searches each item in the
24573 list for the name of an available algorithm. For example, if the list
24574 contains RSA_AES_SHA, then AES is recognized, and the behaviour is exactly
24575 the same as if just AES were given.
24576
24577 .oindex "&%gnutls_require_kx%&"
24578 .oindex "&%gnutls_require_mac%&"
24579 .oindex "&%gnutls_require_protocols%&"
24580 There are additional options called &%gnutls_require_kx%&,
24581 &%gnutls_require_mac%&, and &%gnutls_require_protocols%& that can be used to
24582 restrict the key exchange methods, MAC algorithms, and protocols, respectively.
24583 These options are ignored if OpenSSL is in use.
24584
24585 All four options are available as global options, controlling how Exim
24586 behaves as a server, and also as options of the &(smtp)& transport, controlling
24587 how Exim behaves as a client. All the values are string expanded. After
24588 expansion, the values must be colon-separated lists, though the separator
24589 can be changed in the usual way.
24590
24591 Each of the four lists starts out with a default set of algorithms. If the
24592 first item in a list does &'not'& start with an exclamation mark, all the
24593 default items are deleted. In this case, only those that are explicitly
24594 specified can be used. If the first item in a list &'does'& start with an
24595 exclamation mark, the defaults are left on the list.
24596
24597 Then, any item that starts with an exclamation mark causes the relevant
24598 entry to be removed from the list, and any item that does not start with an
24599 exclamation mark causes a new entry to be added to the list. Unrecognized
24600 items in the list are ignored. Thus:
24601 .code
24602 tls_require_ciphers = !ARCFOUR
24603 .endd
24604 allows all the defaults except ARCFOUR, whereas
24605 .code
24606 tls_require_ciphers = AES : 3DES
24607 .endd
24608 allows only cipher suites that use AES or 3DES.
24609
24610 For &%tls_require_ciphers%& the recognized names are AES_256, AES_128, AES
24611 (both of the preceding), 3DES, ARCFOUR_128, ARCFOUR_40, and ARCFOUR (both of
24612 the preceding). The default list does not contain all of these; it just has
24613 AES_256, AES_128, 3DES, and ARCFOUR_128.
24614
24615 For &%gnutls_require_kx%&, the recognized names are DHE_RSA, RSA (which
24616 includes DHE_RSA), DHE_DSS, and DHE (which includes both DHE_RSA and
24617 DHE_DSS). The default list contains RSA, DHE_DSS, DHE_RSA.
24618
24619 For &%gnutls_require_mac%&, the recognized names are SHA (synonym SHA1), and
24620 MD5. The default list contains SHA, MD5.
24621
24622 .new
24623 For &%gnutls_require_protocols%&, the recognized names are TLS1.2, TLS1.1,
24624 TLS1.0, (TLS1) and SSL3.
24625 The default list contains TLS1.2, TLS1.1, TLS1.0, SSL3.
24626 TLS1 is an alias for TLS1.0, for backwards compatibility.
24627 For sufficiently old versions of the GnuTLS library, TLS1.2 or TLS1.1 might
24628 not be supported and will not be recognised by Exim.
24629 .wen
24630
24631 In a server, the order of items in these lists is unimportant. The server
24632 advertises the availability of all the relevant cipher suites. However, in a
24633 client, the order in the &%tls_require_ciphers%& list specifies a preference
24634 order for the cipher algorithms. The first one in the client's list that is
24635 also advertised by the server is tried first. The default order is as listed
24636 above.
24637
24638
24639
24640 .section "Configuring an Exim server to use TLS" "SECID182"
24641 .cindex "TLS" "configuring an Exim server"
24642 When Exim has been built with TLS support, it advertises the availability of
24643 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
24644 but not to any others. The default value of this option is unset, which means
24645 that STARTTLS is not advertised at all. This default is chosen because you
24646 need to set some other options in order to make TLS available, and also it is
24647 sensible for systems that want to use TLS only as a client.
24648
24649 If a client issues a STARTTLS command and there is some configuration
24650 problem in the server, the command is rejected with a 454 error. If the client
24651 persists in trying to issue SMTP commands, all except QUIT are rejected
24652 with the error
24653 .code
24654 554 Security failure
24655 .endd
24656 If a STARTTLS command is issued within an existing TLS session, it is
24657 rejected with a 554 error code.
24658
24659 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
24660 match some hosts. You can, of course, set it to * to match all hosts.
24661 However, this is not all you need to do. TLS sessions to a server won't work
24662 without some further configuration at the server end.
24663
24664 It is rumoured that all existing clients that support TLS/SSL use RSA
24665 encryption. To make this work you need to set, in the server,
24666 .code
24667 tls_certificate = /some/file/name
24668 tls_privatekey = /some/file/name
24669 .endd
24670 These options are, in fact, expanded strings, so you can make them depend on
24671 the identity of the client that is connected if you wish. The first file
24672 contains the server's X509 certificate, and the second contains the private key
24673 that goes with it. These files need to be readable by the Exim user, and must
24674 always be given as full path names. They can be the same file if both the
24675 certificate and the key are contained within it. If &%tls_privatekey%& is not
24676 set, or if its expansion is forced to fail or results in an empty string, this
24677 is assumed to be the case. The certificate file may also contain intermediate
24678 certificates that need to be sent to the client to enable it to authenticate
24679 the server's certificate.
24680
24681 If you do not understand about certificates and keys, please try to find a
24682 source of this background information, which is not Exim-specific. (There are a
24683 few comments below in section &<<SECTcerandall>>&.)
24684
24685 &*Note*&: These options do not apply when Exim is operating as a client &--
24686 they apply only in the case of a server. If you need to use a certificate in an
24687 Exim client, you must set the options of the same names in an &(smtp)&
24688 transport.
24689
24690 With just these options, an Exim server will be able to use TLS. It does not
24691 require the client to have a certificate (but see below for how to insist on
24692 this). There is one other option that may be needed in other situations. If
24693 .code
24694 tls_dhparam = /some/file/name
24695 .endd
24696 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
24697 with the parameters contained in the file. This increases the set of cipher
24698 suites that the server supports. See the command
24699 .code
24700 openssl dhparam
24701 .endd
24702 for a way of generating this data. At present, &%tls_dhparam%& is used only
24703 when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used.
24704
24705 The strings supplied for these three options are expanded every time a client
24706 host connects. It is therefore possible to use different certificates and keys
24707 for different hosts, if you so wish, by making use of the client's IP address
24708 in &$sender_host_address$& to control the expansion. If a string expansion is
24709 forced to fail, Exim behaves as if the option is not set.
24710
24711 .cindex "cipher" "logging"
24712 .cindex "log" "TLS cipher"
24713 .vindex "&$tls_cipher$&"
24714 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
24715 an incoming TLS connection. It is included in the &'Received:'& header of an
24716 incoming message (by default &-- you can, of course, change this), and it is
24717 also included in the log line that records a message's arrival, keyed by
24718 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
24719 condition can be used to test for specific cipher suites in ACLs.
24720 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
24721 &<<SECID185>>&.)
24722
24723 Once TLS has been established, the ACLs that run for subsequent SMTP commands
24724 can check the name of the cipher suite and vary their actions accordingly. The
24725 cipher suite names vary, depending on which TLS library is being used. For
24726 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
24727 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
24728 documentation for more details.
24729
24730
24731 .section "Requesting and verifying client certificates" "SECID183"
24732 .cindex "certificate" "verification of client"
24733 .cindex "TLS" "client certificate verification"
24734 If you want an Exim server to request a certificate when negotiating a TLS
24735 session with a client, you must set either &%tls_verify_hosts%& or
24736 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
24737 apply to all TLS connections. For any host that matches one of these options,
24738 Exim requests a certificate as part of the setup of the TLS session. The
24739 contents of the certificate are verified by comparing it with a list of
24740 expected certificates. These must be available in a file or,
24741 for OpenSSL only (not GnuTLS), a directory, identified by
24742 &%tls_verify_certificates%&.
24743
24744 A file can contain multiple certificates, concatenated end to end. If a
24745 directory is used
24746 (OpenSSL only),
24747 each certificate must be in a separate file, with a name (or a symbolic link)
24748 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
24749 certificate. You can compute the relevant hash by running the command
24750 .code
24751 openssl x509 -hash -noout -in /cert/file
24752 .endd
24753 where &_/cert/file_& contains a single certificate.
24754
24755 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
24756 what happens if the client does not supply a certificate, or if the certificate
24757 does not match any of the certificates in the collection named by
24758 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
24759 attempt to set up a TLS session is aborted, and the incoming connection is
24760 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
24761 session continues. ACLs that run for subsequent SMTP commands can detect the
24762 fact that no certificate was verified, and vary their actions accordingly. For
24763 example, you can insist on a certificate before accepting a message for
24764 relaying, but not when the message is destined for local delivery.
24765
24766 .vindex "&$tls_peerdn$&"
24767 When a client supplies a certificate (whether it verifies or not), the value of
24768 the Distinguished Name of the certificate is made available in the variable
24769 &$tls_peerdn$& during subsequent processing of the message.
24770
24771 .cindex "log" "distinguished name"
24772 Because it is often a long text string, it is not included in the log line or
24773 &'Received:'& header by default. You can arrange for it to be logged, keyed by
24774 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
24775 &%received_header_text%& to change the &'Received:'& header. When no
24776 certificate is supplied, &$tls_peerdn$& is empty.
24777
24778
24779 .section "Revoked certificates" "SECID184"
24780 .cindex "TLS" "revoked certificates"
24781 .cindex "revocation list"
24782 .cindex "certificate" "revocation list"
24783 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
24784 certificates are revoked. If you have such a list, you can pass it to an Exim
24785 server using the global option called &%tls_crl%& and to an Exim client using
24786 an identically named option for the &(smtp)& transport. In each case, the value
24787 of the option is expanded and must then be the name of a file that contains a
24788 CRL in PEM format.
24789
24790
24791 .section "Configuring an Exim client to use TLS" "SECID185"
24792 .cindex "cipher" "logging"
24793 .cindex "log" "TLS cipher"
24794 .cindex "log" "distinguished name"
24795 .cindex "TLS" "configuring an Exim client"
24796 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
24797 deliveries as well as to incoming, the latter one causing logging of the
24798 server certificate's DN. The remaining client configuration for TLS is all
24799 within the &(smtp)& transport.
24800
24801 It is not necessary to set any options to have TLS work in the &(smtp)&
24802 transport. If Exim is built with TLS support, and TLS is advertised by a
24803 server, the &(smtp)& transport always tries to start a TLS session. However,
24804 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
24805 transport) to a list of server hosts for which TLS should not be used.
24806
24807 If you do not want Exim to attempt to send messages unencrypted when an attempt
24808 to set up an encrypted connection fails in any way, you can set
24809 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
24810 those hosts, delivery is always deferred if an encrypted connection cannot be
24811 set up. If there are any other hosts for the address, they are tried in the
24812 usual way.
24813
24814 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
24815 the message unencrypted. It always does this if the response to STARTTLS is
24816 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
24817 session after a success response code, what happens is controlled by the
24818 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
24819 delivery to this host is deferred, and other hosts (if available) are tried. If
24820 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
24821 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
24822 negotiation fails, Exim closes the current connection (because it is in an
24823 unknown state), opens a new one to the same host, and then tries the delivery
24824 unencrypted.
24825
24826 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
24827 transport provide the client with a certificate, which is passed to the server
24828 if it requests it. If the server is Exim, it will request a certificate only if
24829 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
24830
24831 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
24832 must name a file or,
24833 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
24834 expected server certificates. The client verifies the server's certificate
24835 against this collection, taking into account any revoked certificates that are
24836 in the list defined by &%tls_crl%&.
24837
24838 If
24839 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
24840 list of permitted cipher suites. If either of these checks fails, delivery to
24841 the current host is abandoned, and the &(smtp)& transport tries to deliver to
24842 alternative hosts, if any.
24843
24844  &*Note*&:
24845 These options must be set in the &(smtp)& transport for Exim to use TLS when it
24846 is operating as a client. Exim does not assume that a server certificate (set
24847 by the global options of the same name) should also be used when operating as a
24848 client.
24849
24850 .vindex "&$host$&"
24851 .vindex "&$host_address$&"
24852 All the TLS options in the &(smtp)& transport are expanded before use, with
24853 &$host$& and &$host_address$& containing the name and address of the server to
24854 which the client is connected. Forced failure of an expansion causes Exim to
24855 behave as if the relevant option were unset.
24856
24857 .vindex &$tls_cipher$&
24858 .vindex &$tls_peerdn$&
24859 Before an SMTP connection is established, the &$tls_cipher$& and &$tls_peerdn$&
24860 variables are emptied. (Until the first connection, they contain the values
24861 that were set when the message was received.) If STARTTLS is subsequently
24862 successfully obeyed, these variables are set to the relevant values for the
24863 outgoing connection.
24864
24865
24866
24867 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
24868          "SECTmulmessam"
24869 .cindex "multiple SMTP deliveries with TLS"
24870 .cindex "TLS" "multiple message deliveries"
24871 Exim sends multiple messages down the same TCP/IP connection by starting up
24872 an entirely new delivery process for each message, passing the socket from
24873 one process to the next. This implementation does not fit well with the use
24874 of TLS, because there is quite a lot of state information associated with a TLS
24875 connection, not just a socket identification. Passing all the state information
24876 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
24877 session before passing the socket to a new process. The new process may then
24878 try to start a new TLS session, and if successful, may try to re-authenticate
24879 if AUTH is in use, before sending the next message.
24880
24881 The RFC is not clear as to whether or not an SMTP session continues in clear
24882 after TLS has been shut down, or whether TLS may be restarted again later, as
24883 just described. However, if the server is Exim, this shutdown and
24884 reinitialization works. It is not known which (if any) other servers operate
24885 successfully if the client closes a TLS session and continues with unencrypted
24886 SMTP, but there are certainly some that do not work. For such servers, Exim
24887 should not pass the socket to another process, because the failure of the
24888 subsequent attempt to use it would cause Exim to record a temporary host error,
24889 and delay other deliveries to that host.
24890
24891 To test for this case, Exim sends an EHLO command to the server after
24892 closing down the TLS session. If this fails in any way, the connection is
24893 closed instead of being passed to a new delivery process, but no retry
24894 information is recorded.
24895
24896 There is also a manual override; you can set &%hosts_nopass_tls%& on the
24897 &(smtp)& transport to match those hosts for which Exim should not pass
24898 connections to new processes if TLS has been used.
24899
24900
24901
24902
24903 .section "Certificates and all that" "SECTcerandall"
24904 .cindex "certificate" "references to discussion"
24905 In order to understand fully how TLS works, you need to know about
24906 certificates, certificate signing, and certificate authorities. This is not the
24907 place to give a tutorial, especially as I do not know very much about it
24908 myself. Some helpful introduction can be found in the FAQ for the SSL addition
24909 to Apache, currently at
24910 .display
24911 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
24912 .endd
24913 Other parts of the &'modssl'& documentation are also helpful, and have
24914 links to further files.
24915 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
24916 0-201-61598-3), contains both introductory and more in-depth descriptions.
24917 Some sample programs taken from the book are available from
24918 .display
24919 &url(http://www.rtfm.com/openssl-examples/)
24920 .endd
24921
24922
24923 .section "Certificate chains" "SECID186"
24924 The file named by &%tls_certificate%& may contain more than one
24925 certificate. This is useful in the case where the certificate that is being
24926 sent is validated by an intermediate certificate which the other end does
24927 not have. Multiple certificates must be in the correct order in the file.
24928 First the host's certificate itself, then the first intermediate
24929 certificate to validate the issuer of the host certificate, then the next
24930 intermediate certificate to validate the issuer of the first intermediate
24931 certificate, and so on, until finally (optionally) the root certificate.
24932 The root certificate must already be trusted by the recipient for
24933 validation to succeed, of course, but if it's not preinstalled, sending the
24934 root certificate along with the rest makes it available for the user to
24935 install if the receiving end is a client MUA that can interact with a user.
24936
24937
24938 .section "Self-signed certificates" "SECID187"
24939 .cindex "certificate" "self-signed"
24940 You can create a self-signed certificate using the &'req'& command provided
24941 with OpenSSL, like this:
24942 .code
24943 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
24944             -days 9999 -nodes
24945 .endd
24946 &_file1_& and &_file2_& can be the same file; the key and the certificate are
24947 delimited and so can be identified independently. The &%-days%& option
24948 specifies a period for which the certificate is valid. The &%-nodes%& option is
24949 important: if you do not set it, the key is encrypted with a passphrase
24950 that you are prompted for, and any use that is made of the key causes more
24951 prompting for the passphrase. This is not helpful if you are going to use
24952 this certificate and key in an MTA, where prompting is not possible.
24953
24954 A self-signed certificate made in this way is sufficient for testing, and
24955 may be adequate for all your requirements if you are mainly interested in
24956 encrypting transfers, and not in secure identification.
24957
24958 However, many clients require that the certificate presented by the server be a
24959 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
24960 certificate. In this situation, the self-signed certificate described above
24961 must be installed on the client host as a trusted root &'certification
24962 authority'& (CA), and the certificate used by Exim must be a user certificate
24963 signed with that self-signed certificate.
24964
24965 For information on creating self-signed CA certificates and using them to sign
24966 user certificates, see the &'General implementation overview'& chapter of the
24967 Open-source PKI book, available online at
24968 &url(http://ospkibook.sourceforge.net/).
24969 .ecindex IIDencsmtp1
24970 .ecindex IIDencsmtp2
24971
24972
24973
24974 . ////////////////////////////////////////////////////////////////////////////
24975 . ////////////////////////////////////////////////////////////////////////////
24976
24977 .chapter "Access control lists" "CHAPACL"
24978 .scindex IIDacl "&ACL;" "description"
24979 .cindex "control of incoming mail"
24980 .cindex "message" "controlling incoming"
24981 .cindex "policy control" "access control lists"
24982 Access Control Lists (ACLs) are defined in a separate section of the run time
24983 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
24984 name, terminated by a colon. Here is a complete ACL section that contains just
24985 one very small ACL:
24986 .code
24987 begin acl
24988 small_acl:
24989   accept   hosts = one.host.only
24990 .endd
24991 You can have as many lists as you like in the ACL section, and the order in
24992 which they appear does not matter. The lists are self-terminating.
24993
24994 The majority of ACLs are used to control Exim's behaviour when it receives
24995 certain SMTP commands. This applies both to incoming TCP/IP connections, and
24996 when a local process submits a message using SMTP by specifying the &%-bs%&
24997 option. The most common use is for controlling which recipients are accepted
24998 in incoming messages. In addition, you can define an ACL that is used to check
24999 local non-SMTP messages. The default configuration file contains an example of
25000 a realistic ACL for checking RCPT commands. This is discussed in chapter
25001 &<<CHAPdefconfil>>&.
25002
25003
25004 .section "Testing ACLs" "SECID188"
25005 The &%-bh%& command line option provides a way of testing your ACL
25006 configuration locally by running a fake SMTP session with which you interact.
25007 The host &'relay-test.mail-abuse.org'& provides a service for checking your
25008 relaying configuration (see section &<<SECTcheralcon>>& for more details).
25009
25010
25011
25012 .section "Specifying when ACLs are used" "SECID189"
25013 .cindex "&ACL;" "options for specifying"
25014 In order to cause an ACL to be used, you have to name it in one of the relevant
25015 options in the main part of the configuration. These options are:
25016 .cindex "AUTH" "ACL for"
25017 .cindex "DATA" "ACLs for"
25018 .cindex "ETRN" "ACL for"
25019 .cindex "EXPN" "ACL for"
25020 .cindex "HELO" "ACL for"
25021 .cindex "EHLO" "ACL for"
25022 .cindex "MAIL" "ACL for"
25023 .cindex "QUIT, ACL for"
25024 .cindex "RCPT" "ACL for"
25025 .cindex "STARTTLS, ACL for"
25026 .cindex "VRFY" "ACL for"
25027 .cindex "SMTP" "connection, ACL for"
25028 .cindex "non-SMTP messages" "ACLs for"
25029 .cindex "MIME content scanning" "ACL for"
25030
25031 .table2 140pt
25032 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
25033 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
25034 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
25035 .irow &%acl_smtp_auth%&        "ACL for AUTH"
25036 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
25037 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
25038 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
25039 .irow &%acl_smtp_expn%&        "ACL for EXPN"
25040 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
25041 .irow &%acl_smtp_mail%&        "ACL for MAIL"
25042 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
25043 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
25044 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
25045 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
25046 .irow &%acl_smtp_quit%&        "ACL for QUIT"
25047 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
25048 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
25049 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
25050 .endtable
25051
25052 For example, if you set
25053 .code
25054 acl_smtp_rcpt = small_acl
25055 .endd
25056 the little ACL defined above is used whenever Exim receives a RCPT command
25057 in an SMTP dialogue. The majority of policy tests on incoming messages can be
25058 done when RCPT commands arrive. A rejection of RCPT should cause the
25059 sending MTA to give up on the recipient address contained in the RCPT
25060 command, whereas rejection at other times may cause the client MTA to keep on
25061 trying to deliver the message. It is therefore recommended that you do as much
25062 testing as possible at RCPT time.
25063
25064
25065 .section "The non-SMTP ACLs" "SECID190"
25066 .cindex "non-SMTP messages" "ACLs for"
25067 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
25068 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
25069 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
25070 the state of the SMTP connection such as encryption and authentication) are not
25071 relevant and are forbidden in these ACLs. However, the sender and recipients
25072 are known, so the &%senders%& and &%sender_domains%& conditions and the
25073 &$sender_address$& and &$recipients$& variables can be used. Variables such as
25074 &$authenticated_sender$& are also available. You can specify added header lines
25075 in any of these ACLs.
25076
25077 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
25078 non-SMTP message, before any of the message has been read. (This is the
25079 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
25080 batched SMTP input, it runs after the DATA command has been reached. The
25081 result of this ACL is ignored; it cannot be used to reject a message. If you
25082 really need to, you could set a value in an ACL variable here and reject based
25083 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
25084 controls, and in particular, it can be used to set
25085 .code
25086 control = suppress_local_fixups
25087 .endd
25088 This cannot be used in the other non-SMTP ACLs because by the time they are
25089 run, it is too late.
25090
25091 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
25092 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25093
25094 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
25095 kind of rejection is treated as permanent, because there is no way of sending a
25096 temporary error for these kinds of message.
25097
25098
25099 .section "The SMTP connect ACL" "SECID191"
25100 .cindex "SMTP" "connection, ACL for"
25101 .oindex &%smtp_banner%&
25102 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
25103 session, after the test specified by &%host_reject_connection%& (which is now
25104 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
25105 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
25106 the message override the banner message that is otherwise specified by the
25107 &%smtp_banner%& option.
25108
25109
25110 .section "The EHLO/HELO ACL" "SECID192"
25111 .cindex "EHLO" "ACL for"
25112 .cindex "HELO" "ACL for"
25113 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
25114 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
25115 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
25116 Note that a client may issue more than one EHLO or HELO command in an SMTP
25117 session, and indeed is required to issue a new EHLO or HELO after successfully
25118 setting up encryption following a STARTTLS command.
25119
25120 If the command is accepted by an &%accept%& verb that has a &%message%&
25121 modifier, the message may not contain more than one line (it will be truncated
25122 at the first newline and a panic logged if it does). Such a message cannot
25123 affect the EHLO options that are listed on the second and subsequent lines of
25124 an EHLO response.
25125
25126
25127 .section "The DATA ACLs" "SECID193"
25128 .cindex "DATA" "ACLs for"
25129 Two ACLs are associated with the DATA command, because it is two-stage
25130 command, with two responses being sent to the client.
25131 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
25132 is obeyed. This gives you control after all the RCPT commands, but before
25133 the message itself is received. It offers the opportunity to give a negative
25134 response to the DATA command before the data is transmitted. Header lines
25135 added by MAIL or RCPT ACLs are not visible at this time, but any that
25136 are defined here are visible when the &%acl_smtp_data%& ACL is run.
25137
25138 You cannot test the contents of the message, for example, to verify addresses
25139 in the headers, at RCPT time or when the DATA command is received. Such
25140 tests have to appear in the ACL that is run after the message itself has been
25141 received, before the final response to the DATA command is sent. This is
25142 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
25143 associated with the DATA command.
25144
25145 For both of these ACLs, it is not possible to reject individual recipients. An
25146 error response rejects the entire message. Unfortunately, it is known that some
25147 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
25148 before or after the data) correctly &-- they keep the message on their queues
25149 and try again later, but that is their problem, though it does waste some of
25150 your resources.
25151
25152
25153 .section "The SMTP DKIM ACL" "SECTDKIMACL"
25154 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
25155 enabled (which is the default).
25156
25157 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
25158 received, and is executed for each DKIM signature found in a message.  If not
25159 otherwise specified, the default action is to accept.
25160
25161 For details on the operation of DKIM, see chapter &<<CHID12>>&.
25162
25163
25164 .section "The SMTP MIME ACL" "SECID194"
25165 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
25166 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25167
25168
25169 .section "The QUIT ACL" "SECTQUITACL"
25170 .cindex "QUIT, ACL for"
25171 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
25172 does not affect the response code to QUIT, which is always 221. Thus, the ACL
25173 does not in fact control any access. For this reason, the only verbs that are
25174 permitted are &%accept%& and &%warn%&.
25175
25176 This ACL can be used for tasks such as custom logging at the end of an SMTP
25177 session. For example, you can use ACL variables in other ACLs to count
25178 messages, recipients, etc., and log the totals at QUIT time using one or
25179 more &%logwrite%& modifiers on a &%warn%& verb.
25180
25181 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
25182 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
25183
25184 You do not need to have a final &%accept%&, but if you do, you can use a
25185 &%message%& modifier to specify custom text that is sent as part of the 221
25186 response to QUIT.
25187
25188 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
25189 failure (for example, failure to open a log file, or when Exim is bombing out
25190 because it has detected an unrecoverable error), all SMTP commands from the
25191 client are given temporary error responses until QUIT is received or the
25192 connection is closed. In these special cases, the QUIT ACL does not run.
25193
25194
25195 .section "The not-QUIT ACL" "SECTNOTQUITACL"
25196 .vindex &$acl_smtp_notquit$&
25197 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
25198 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
25199 trouble, such as being unable to write to its log files, this ACL is not run,
25200 because it might try to do things (such as write to log files) that make the
25201 situation even worse.
25202
25203 Like the QUIT ACL, this ACL is provided to make it possible to do customized
25204 logging or to gather statistics, and its outcome is ignored. The &%delay%&
25205 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
25206 and &%warn%&.
25207
25208 .vindex &$smtp_notquit_reason$&
25209 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
25210 to a string that indicates the reason for the termination of the SMTP
25211 connection. The possible values are:
25212 .table2
25213 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
25214 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
25215 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
25216 .irow &`connection-lost`&          "The SMTP connection has been lost"
25217 .irow &`data-timeout`&             "Timeout while reading message data"
25218 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
25219 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
25220 .irow &`signal-exit`&              "SIGTERM or SIGINT"
25221 .irow &`synchronization-error`&    "SMTP synchronization error"
25222 .irow &`tls-failed`&               "TLS failed to start"
25223 .endtable
25224 In most cases when an SMTP connection is closed without having received QUIT,
25225 Exim sends an SMTP response message before actually closing the connection.
25226 With the exception of the &`acl-drop`& case, the default message can be
25227 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
25228 &%drop%& verb in another ACL, it is the message from the other ACL that is
25229 used.
25230
25231
25232 .section "Finding an ACL to use" "SECID195"
25233 .cindex "&ACL;" "finding which to use"
25234 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
25235 you can use different ACLs in different circumstances. For example,
25236 .code
25237 acl_smtp_rcpt = ${if ={25}{$interface_port} \
25238                      {acl_check_rcpt} {acl_check_rcpt_submit} }
25239 .endd
25240 In the default configuration file there are some example settings for
25241 providing an RFC 4409 message submission service on port 587 and a
25242 non-standard &"smtps"& service on port 465. You can use a string
25243 expansion like this to choose an ACL for MUAs on these ports which is
25244 more appropriate for this purpose than the default ACL on port 25.
25245
25246 The expanded string does not have to be the name of an ACL in the
25247 configuration file; there are other possibilities. Having expanded the
25248 string, Exim searches for an ACL as follows:
25249
25250 .ilist
25251 If the string begins with a slash, Exim uses it as a file name, and reads its
25252 contents as an ACL. The lines are processed in the same way as lines in the
25253 Exim configuration file. In particular, continuation lines are supported, blank
25254 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
25255 If the file does not exist or cannot be read, an error occurs (typically
25256 causing a temporary failure of whatever caused the ACL to be run). For example:
25257 .code
25258 acl_smtp_data = /etc/acls/\
25259   ${lookup{$sender_host_address}lsearch\
25260   {/etc/acllist}{$value}{default}}
25261 .endd
25262 This looks up an ACL file to use on the basis of the host's IP address, falling
25263 back to a default if the lookup fails. If an ACL is successfully read from a
25264 file, it is retained in memory for the duration of the Exim process, so that it
25265 can be re-used without having to re-read the file.
25266 .next
25267 If the string does not start with a slash, and does not contain any spaces,
25268 Exim searches the ACL section of the configuration for an ACL whose name
25269 matches the string.
25270 .next
25271 If no named ACL is found, or if the string contains spaces, Exim parses
25272 the string as an inline ACL. This can save typing in cases where you just
25273 want to have something like
25274 .code
25275 acl_smtp_vrfy = accept
25276 .endd
25277 in order to allow free use of the VRFY command. Such a string may contain
25278 newlines; it is processed in the same way as an ACL that is read from a file.
25279 .endlist
25280
25281
25282
25283
25284 .section "ACL return codes" "SECID196"
25285 .cindex "&ACL;" "return codes"
25286 Except for the QUIT ACL, which does not affect the SMTP return code (see
25287 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25288 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25289 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25290 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25291 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25292 This also causes a 4&'xx'& return code.
25293
25294 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25295 &"deny"&, because there is no mechanism for passing temporary errors to the
25296 submitters of non-SMTP messages.
25297
25298
25299 ACLs that are relevant to message reception may also return &"discard"&. This
25300 has the effect of &"accept"&, but causes either the entire message or an
25301 individual recipient address to be discarded. In other words, it is a
25302 blackholing facility. Use it with care.
25303
25304 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25305 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25306 RCPT ACL is to discard just the one recipient address. If there are no
25307 recipients left when the message's data is received, the DATA ACL is not
25308 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25309 remaining recipients. The &"discard"& return is not permitted for the
25310 &%acl_smtp_predata%& ACL.
25311
25312
25313 .cindex "&[local_scan()]& function" "when all recipients discarded"
25314 The &[local_scan()]& function is always run, even if there are no remaining
25315 recipients; it may create new recipients.
25316
25317
25318
25319 .section "Unset ACL options" "SECID197"
25320 .cindex "&ACL;" "unset options"
25321 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25322 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25323 not defined at all. For any defined ACL, the default action when control
25324 reaches the end of the ACL statements is &"deny"&.
25325
25326 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25327 these two are ACLs that are used only for their side effects. They cannot be
25328 used to accept or reject anything.
25329
25330 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25331 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25332 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25333 when the ACL is not defined is &"accept"&.
25334
25335 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25336 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25337 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25338 messages over an SMTP connection. For an example, see the ACL in the default
25339 configuration file.
25340
25341
25342
25343
25344 .section "Data for message ACLs" "SECID198"
25345 .cindex "&ACL;" "data for message ACL"
25346 .vindex &$domain$&
25347 .vindex &$local_part$&
25348 .vindex &$sender_address$&
25349 .vindex &$sender_host_address$&
25350 .vindex &$smtp_command$&
25351 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
25352 that contain information about the host and the message's sender (for example,
25353 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
25354 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
25355 &$local_part$& are set from the argument address. The entire SMTP command
25356 is available in &$smtp_command$&.
25357
25358 When an ACL for the AUTH parameter of MAIL is running, the variables that
25359 contain information about the host are set, but &$sender_address$& is not yet
25360 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25361 how it is used.
25362
25363 .vindex "&$message_size$&"
25364 The &$message_size$& variable is set to the value of the SIZE parameter on
25365 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25366 that parameter is not given. The value is updated to the true message size by
25367 the time the final DATA ACL is run (after the message data has been
25368 received).
25369
25370 .vindex "&$rcpt_count$&"
25371 .vindex "&$recipients_count$&"
25372 The &$rcpt_count$& variable increases by one for each RCPT command received.
25373 The &$recipients_count$& variable increases by one each time a RCPT command is
25374 accepted, so while an ACL for RCPT is being processed, it contains the number
25375 of previously accepted recipients. At DATA time (for both the DATA ACLs),
25376 &$rcpt_count$& contains the total number of RCPT commands, and
25377 &$recipients_count$& contains the total number of accepted recipients.
25378
25379
25380
25381
25382
25383 .section "Data for non-message ACLs" "SECTdatfornon"
25384 .cindex "&ACL;" "data for non-message ACL"
25385 .vindex &$smtp_command_argument$&
25386 .vindex &$smtp_command$&
25387 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
25388 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
25389 and the entire SMTP command is available in &$smtp_command$&.
25390 These variables can be tested using a &%condition%& condition. For example,
25391 here is an ACL for use with AUTH, which insists that either the session is
25392 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
25393 does not permit authentication methods that use cleartext passwords on
25394 unencrypted connections.
25395 .code
25396 acl_check_auth:
25397   accept encrypted = *
25398   accept condition = ${if eq{${uc:$smtp_command_argument}}\
25399                      {CRAM-MD5}}
25400   deny   message   = TLS encryption or CRAM-MD5 required
25401 .endd
25402 (Another way of applying this restriction is to arrange for the authenticators
25403 that use cleartext passwords not to be advertised when the connection is not
25404 encrypted. You can use the generic &%server_advertise_condition%& authenticator
25405 option to do this.)
25406
25407
25408
25409 .section "Format of an ACL" "SECID199"
25410 .cindex "&ACL;" "format of"
25411 .cindex "&ACL;" "verbs, definition of"
25412 An individual ACL consists of a number of statements. Each statement starts
25413 with a verb, optionally followed by a number of conditions and &"modifiers"&.
25414 Modifiers can change the way the verb operates, define error and log messages,
25415 set variables, insert delays, and vary the processing of accepted messages.
25416
25417 If all the conditions are met, the verb is obeyed. The same condition may be
25418 used (with different arguments) more than once in the same statement. This
25419 provides a means of specifying an &"and"& conjunction between conditions. For
25420 example:
25421 .code
25422 deny  dnslists = list1.example
25423 dnslists = list2.example
25424 .endd
25425 If there are no conditions, the verb is always obeyed. Exim stops evaluating
25426 the conditions and modifiers when it reaches a condition that fails. What
25427 happens then depends on the verb (and in one case, on a special modifier). Not
25428 all the conditions make sense at every testing point. For example, you cannot
25429 test a sender address in the ACL that is run for a VRFY command.
25430
25431
25432 .section "ACL verbs" "SECID200"
25433 The ACL verbs are as follows:
25434
25435 .ilist
25436 .cindex "&%accept%& ACL verb"
25437 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
25438 of the conditions are not met, what happens depends on whether &%endpass%&
25439 appears among the conditions (for syntax see below). If the failing condition
25440 is before &%endpass%&, control is passed to the next ACL statement; if it is
25441 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
25442 check a RCPT command:
25443 .code
25444 accept domains = +local_domains
25445 endpass
25446 verify = recipient
25447 .endd
25448 If the recipient domain does not match the &%domains%& condition, control
25449 passes to the next statement. If it does match, the recipient is verified, and
25450 the command is accepted if verification succeeds. However, if verification
25451 fails, the ACL yields &"deny"&, because the failing condition is after
25452 &%endpass%&.
25453
25454 The &%endpass%& feature has turned out to be confusing to many people, so its
25455 use is not recommended nowadays. It is always possible to rewrite an ACL so
25456 that &%endpass%& is not needed, and it is no longer used in the default
25457 configuration.
25458
25459 .cindex "&%message%& ACL modifier" "with &%accept%&"
25460 If a &%message%& modifier appears on an &%accept%& statement, its action
25461 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
25462 (when an &%accept%& verb either accepts or passes control to the next
25463 statement), &%message%& can be used to vary the message that is sent when an
25464 SMTP command is accepted. For example, in a RCPT ACL you could have:
25465 .display
25466 &`accept  `&<&'some conditions'&>
25467 &`        message = OK, I will allow you through today`&
25468 .endd
25469 You can specify an SMTP response code, optionally followed by an &"extended
25470 response code"& at the start of the message, but the first digit must be the
25471 same as would be sent by default, which is 2 for an &%accept%& verb.
25472
25473 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
25474 an error message that is used when access is denied. This behaviour is retained
25475 for backward compatibility, but current &"best practice"& is to avoid the use
25476 of &%endpass%&.
25477
25478
25479 .next
25480 .cindex "&%defer%& ACL verb"
25481 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
25482 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
25483 &%defer%& is the same as &%deny%&, because there is no way of sending a
25484 temporary error. For a RCPT command, &%defer%& is much the same as using a
25485 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
25486 be used in any ACL, and even for a recipient it might be a simpler approach.
25487
25488
25489 .next
25490 .cindex "&%deny%& ACL verb"
25491 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
25492 the conditions are not met, control is passed to the next ACL statement. For
25493 example,
25494 .code
25495 deny dnslists = blackholes.mail-abuse.org
25496 .endd
25497 rejects commands from hosts that are on a DNS black list.
25498
25499
25500 .next
25501 .cindex "&%discard%& ACL verb"
25502 &%discard%&: This verb behaves like &%accept%&, except that it returns
25503 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
25504 that are concerned with receiving messages. When all the conditions are true,
25505 the sending entity receives a &"success"& response. However, &%discard%& causes
25506 recipients to be discarded. If it is used in an ACL for RCPT, just the one
25507 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
25508 message's recipients are discarded. Recipients that are discarded before DATA
25509 do not appear in the log line when the &%received_recipients%& log selector is set.
25510
25511 If the &%log_message%& modifier is set when &%discard%& operates,
25512 its contents are added to the line that is automatically written to the log.
25513 The &%message%& modifier operates exactly as it does for &%accept%&.
25514
25515
25516 .next
25517 .cindex "&%drop%& ACL verb"
25518 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
25519 forcibly closed after the 5&'xx'& error message has been sent. For example:
25520 .code
25521 drop   message   = I don't take more than 20 RCPTs
25522        condition = ${if > {$rcpt_count}{20}}
25523 .endd
25524 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
25525 The connection is always dropped after sending a 550 response.
25526
25527 .next
25528 .cindex "&%require%& ACL verb"
25529 &%require%&: If all the conditions are met, control is passed to the next ACL
25530 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
25531 example, when checking a RCPT command,
25532 .code
25533 require message = Sender did not verify
25534         verify  = sender
25535 .endd
25536 passes control to subsequent statements only if the message's sender can be
25537 verified. Otherwise, it rejects the command. Note the positioning of the
25538 &%message%& modifier, before the &%verify%& condition. The reason for this is
25539 discussed in section &<<SECTcondmodproc>>&.
25540
25541 .next
25542 .cindex "&%warn%& ACL verb"
25543 &%warn%&: If all the conditions are true, a line specified by the
25544 &%log_message%& modifier is written to Exim's main log. Control always passes
25545 to the next ACL statement. If any condition is false, the log line is not
25546 written. If an identical log line is requested several times in the same
25547 message, only one copy is actually written to the log. If you want to force
25548 duplicates to be written, use the &%logwrite%& modifier instead.
25549
25550 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
25551 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
25552 &%logwrite%&, and &%add_header%&) that appear before the first failing
25553 condition. There is more about adding header lines in section
25554 &<<SECTaddheadacl>>&.
25555
25556 If any condition on a &%warn%& statement cannot be completed (that is, there is
25557 some sort of defer), the log line specified by &%log_message%& is not written.
25558 This does not include the case of a forced failure from a lookup, which
25559 is considered to be a successful completion. After a defer, no further
25560 conditions or modifiers in the &%warn%& statement are processed. The incident
25561 is logged, and the ACL continues to be processed, from the next statement
25562 onwards.
25563
25564
25565 .vindex "&$acl_verify_message$&"
25566 When one of the &%warn%& conditions is an address verification that fails, the
25567 text of the verification failure message is in &$acl_verify_message$&. If you
25568 want this logged, you must set it up explicitly. For example:
25569 .code
25570 warn   !verify = sender
25571        log_message = sender verify failed: $acl_verify_message
25572 .endd
25573 .endlist
25574
25575 At the end of each ACL there is an implicit unconditional &%deny%&.
25576
25577 As you can see from the examples above, the conditions and modifiers are
25578 written one to a line, with the first one on the same line as the verb, and
25579 subsequent ones on following lines. If you have a very long condition, you can
25580 continue it onto several physical lines by the usual backslash continuation
25581 mechanism. It is conventional to align the conditions vertically.
25582
25583
25584
25585 .section "ACL variables" "SECTaclvariables"
25586 .cindex "&ACL;" "variables"
25587 There are some special variables that can be set during ACL processing. They
25588 can be used to pass information between different ACLs, different invocations
25589 of the same ACL in the same SMTP connection, and between ACLs and the routers,
25590 transports, and filters that are used to deliver a message. The names of these
25591 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
25592 an underscore, but the remainder of the name can be any sequence of
25593 alphanumeric characters and underscores that you choose. There is no limit on
25594 the number of ACL variables. The two sets act as follows:
25595 .ilist
25596 The values of those variables whose names begin with &$acl_c$& persist
25597 throughout an SMTP connection. They are never reset. Thus, a value that is set
25598 while receiving one message is still available when receiving the next message
25599 on the same SMTP connection.
25600 .next
25601 The values of those variables whose names begin with &$acl_m$& persist only
25602 while a message is being received. They are reset afterwards. They are also
25603 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
25604 .endlist
25605
25606 When a message is accepted, the current values of all the ACL variables are
25607 preserved with the message and are subsequently made available at delivery
25608 time. The ACL variables are set by a modifier called &%set%&. For example:
25609 .code
25610 accept hosts = whatever
25611        set acl_m4 = some value
25612 accept authenticated = *
25613        set acl_c_auth = yes
25614 .endd
25615 &*Note*&: A leading dollar sign is not used when naming a variable that is to
25616 be set. If you want to set a variable without taking any action, you can use a
25617 &%warn%& verb without any other modifiers or conditions.
25618
25619 .oindex &%strict_acl_vars%&
25620 What happens if a syntactically valid but undefined ACL variable is
25621 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
25622 false (the default), an empty string is substituted; if it is true, an
25623 error is generated.
25624
25625 Versions of Exim before 4.64 have a limited set of numbered variables, but
25626 their names are compatible, so there is no problem with upgrading.
25627
25628
25629 .section "Condition and modifier processing" "SECTcondmodproc"
25630 .cindex "&ACL;" "conditions; processing"
25631 .cindex "&ACL;" "modifiers; processing"
25632 An exclamation mark preceding a condition negates its result. For example:
25633 .code
25634 deny   domains = *.dom.example
25635       !verify  = recipient
25636 .endd
25637 causes the ACL to return &"deny"& if the recipient domain ends in
25638 &'dom.example'& and the recipient address cannot be verified. Sometimes
25639 negation can be used on the right-hand side of a condition. For example, these
25640 two statements are equivalent:
25641 .code
25642 deny  hosts = !192.168.3.4
25643 deny !hosts =  192.168.3.4
25644 .endd
25645 However, for many conditions (&%verify%& being a good example), only left-hand
25646 side negation of the whole condition is possible.
25647
25648 The arguments of conditions and modifiers are expanded. A forced failure
25649 of an expansion causes a condition to be ignored, that is, it behaves as if the
25650 condition is true. Consider these two statements:
25651 .code
25652 accept  senders = ${lookup{$host_name}lsearch\
25653                   {/some/file}{$value}fail}
25654 accept  senders = ${lookup{$host_name}lsearch\
25655                   {/some/file}{$value}{}}
25656 .endd
25657 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
25658 the returned list is searched, but if the lookup fails the behaviour is
25659 different in the two cases. The &%fail%& in the first statement causes the
25660 condition to be ignored, leaving no further conditions. The &%accept%& verb
25661 therefore succeeds. The second statement, however, generates an empty list when
25662 the lookup fails. No sender can match an empty list, so the condition fails,
25663 and therefore the &%accept%& also fails.
25664
25665 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
25666 specify actions that are taken as the conditions for a statement are checked;
25667 others specify text for messages that are used when access is denied or a
25668 warning is generated. The &%control%& modifier affects the way an incoming
25669 message is handled.
25670
25671 The positioning of the modifiers in an ACL statement important, because the
25672 processing of a verb ceases as soon as its outcome is known. Only those
25673 modifiers that have already been encountered will take effect. For example,
25674 consider this use of the &%message%& modifier:
25675 .code
25676 require message = Can't verify sender
25677         verify  = sender
25678         message = Can't verify recipient
25679         verify  = recipient
25680         message = This message cannot be used
25681 .endd
25682 If sender verification fails, Exim knows that the result of the statement is
25683 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
25684 so its text is used as the error message. If sender verification succeeds, but
25685 recipient verification fails, the second message is used. If recipient
25686 verification succeeds, the third message becomes &"current"&, but is never used
25687 because there are no more conditions to cause failure.
25688
25689 For the &%deny%& verb, on the other hand, it is always the last &%message%&
25690 modifier that is used, because all the conditions must be true for rejection to
25691 happen. Specifying more than one &%message%& modifier does not make sense, and
25692 the message can even be specified after all the conditions. For example:
25693 .code
25694 deny   hosts = ...
25695       !senders = *@my.domain.example
25696        message = Invalid sender from client host
25697 .endd
25698 The &"deny"& result does not happen until the end of the statement is reached,
25699 by which time Exim has set up the message.
25700
25701
25702
25703 .section "ACL modifiers" "SECTACLmodi"
25704 .cindex "&ACL;" "modifiers; list of"
25705 The ACL modifiers are as follows:
25706
25707 .vlist
25708 .vitem &*add_header*&&~=&~<&'text'&>
25709 This modifier specifies one or more header lines that are to be added to an
25710 incoming message, assuming, of course, that the message is ultimately
25711 accepted. For details, see section &<<SECTaddheadacl>>&.
25712
25713 .vitem &*continue*&&~=&~<&'text'&>
25714 .cindex "&%continue%& ACL modifier"
25715 .cindex "database" "updating in ACL"
25716 This modifier does nothing of itself, and processing of the ACL always
25717 continues with the next condition or modifier. The value of &%continue%& is in
25718 the side effects of expanding its argument. Typically this could be used to
25719 update a database. It is really just a syntactic tidiness, to avoid having to
25720 write rather ugly lines like this:
25721 .display
25722 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
25723 .endd
25724 Instead, all you need is
25725 .display
25726 &`continue = `&<&'some expansion'&>
25727 .endd
25728
25729 .vitem &*control*&&~=&~<&'text'&>
25730 .cindex "&%control%& ACL modifier"
25731 This modifier affects the subsequent processing of the SMTP connection or of an
25732 incoming message that is accepted. The effect of the first type of control
25733 lasts for the duration of the connection, whereas the effect of the second type
25734 lasts only until the current message has been received. The message-specific
25735 controls always apply to the whole message, not to individual recipients,
25736 even if the &%control%& modifier appears in a RCPT ACL.
25737
25738 As there are now quite a few controls that can be applied, they are described
25739 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
25740 in several different ways. For example:
25741
25742 . ==== As this is a nested list, any displays it contains must be indented
25743 . ==== as otherwise they are too far to the left. That comment applies only
25744 . ==== when xmlto and fop are used; formatting with sdop gets it right either
25745 . ==== way.
25746
25747 .ilist
25748 It can be at the end of an &%accept%& statement:
25749 .code
25750     accept  ...some conditions
25751             control = queue_only
25752 .endd
25753 In this case, the control is applied when this statement yields &"accept"&, in
25754 other words, when the conditions are all true.
25755
25756 .next
25757 It can be in the middle of an &%accept%& statement:
25758 .code
25759     accept  ...some conditions...
25760             control = queue_only
25761             ...some more conditions...
25762 .endd
25763 If the first set of conditions are true, the control is applied, even if the
25764 statement does not accept because one of the second set of conditions is false.
25765 In this case, some subsequent statement must yield &"accept"& for the control
25766 to be relevant.
25767
25768 .next
25769 It can be used with &%warn%& to apply the control, leaving the
25770 decision about accepting or denying to a subsequent verb. For
25771 example:
25772 .code
25773     warn    ...some conditions...
25774             control = freeze
25775     accept  ...
25776 .endd
25777 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
25778 &%logwrite%&, so it does not add anything to the message and does not write a
25779 log entry.
25780
25781 .next
25782 If you want to apply a control unconditionally, you can use it with a
25783 &%require%& verb. For example:
25784 .code
25785     require  control = no_multiline_responses
25786 .endd
25787 .endlist
25788
25789 .vitem &*delay*&&~=&~<&'time'&>
25790 .cindex "&%delay%& ACL modifier"
25791 .oindex "&%-bh%&"
25792 This modifier may appear in any ACL. It causes Exim to wait for the time
25793 interval before proceeding. However, when testing Exim using the &%-bh%&
25794 option, the delay is not actually imposed (an appropriate message is output
25795 instead). The time is given in the usual Exim notation, and the delay happens
25796 as soon as the modifier is processed. In an SMTP session, pending output is
25797 flushed before the delay is imposed.
25798
25799 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
25800 example:
25801 .code
25802 deny    ...some conditions...
25803         delay = 30s
25804 .endd
25805 The delay happens if all the conditions are true, before the statement returns
25806 &"deny"&. Compare this with:
25807 .code
25808 deny    delay = 30s
25809         ...some conditions...
25810 .endd
25811 which waits for 30s before processing the conditions. The &%delay%& modifier
25812 can also be used with &%warn%& and together with &%control%&:
25813 .code
25814 warn    ...some conditions...
25815         delay = 2m
25816         control = freeze
25817 accept  ...
25818 .endd
25819
25820 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
25821 responses to several commands are no longer buffered and sent in one packet (as
25822 they would normally be) because all output is flushed before imposing the
25823 delay. This optimization is disabled so that a number of small delays do not
25824 appear to the client as one large aggregated delay that might provoke an
25825 unwanted timeout. You can, however, disable output flushing for &%delay%& by
25826 using a &%control%& modifier to set &%no_delay_flush%&.
25827
25828
25829 .vitem &*endpass*&
25830 .cindex "&%endpass%& ACL modifier"
25831 This modifier, which has no argument, is recognized only in &%accept%& and
25832 &%discard%& statements. It marks the boundary between the conditions whose
25833 failure causes control to pass to the next statement, and the conditions whose
25834 failure causes the ACL to return &"deny"&. This concept has proved to be
25835 confusing to some people, so the use of &%endpass%& is no longer recommended as
25836 &"best practice"&. See the description of &%accept%& above for more details.
25837
25838
25839 .vitem &*log_message*&&~=&~<&'text'&>
25840 .cindex "&%log_message%& ACL modifier"
25841 This modifier sets up a message that is used as part of the log message if the
25842 ACL denies access or a &%warn%& statement's conditions are true. For example:
25843 .code
25844 require log_message = wrong cipher suite $tls_cipher
25845         encrypted   = DES-CBC3-SHA
25846 .endd
25847 &%log_message%& is also used when recipients are discarded by &%discard%&. For
25848 example:
25849 .display
25850 &`discard `&<&'some conditions'&>
25851 &`        log_message = Discarded $local_part@$domain because...`&
25852 .endd
25853 When access is denied, &%log_message%& adds to any underlying error message
25854 that may exist because of a condition failure. For example, while verifying a
25855 recipient address, a &':fail:'& redirection might have already set up a
25856 message.
25857
25858 The message may be defined before the conditions to which it applies, because
25859 the string expansion does not happen until Exim decides that access is to be
25860 denied. This means that any variables that are set by the condition are
25861 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
25862 variables are set after a DNS black list lookup succeeds. If the expansion of
25863 &%log_message%& fails, or if the result is an empty string, the modifier is
25864 ignored.
25865
25866 .vindex "&$acl_verify_message$&"
25867 If you want to use a &%warn%& statement to log the result of an address
25868 verification, you can use &$acl_verify_message$& to include the verification
25869 error message.
25870
25871 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
25872 the start of the logged message. If the same warning log message is requested
25873 more than once while receiving  a single email message, only one copy is
25874 actually logged. If you want to log multiple copies, use &%logwrite%& instead
25875 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
25876 is logged for a successful &%warn%& statement.
25877
25878 If &%log_message%& is not present and there is no underlying error message (for
25879 example, from the failure of address verification), but &%message%& is present,
25880 the &%message%& text is used for logging rejections. However, if any text for
25881 logging contains newlines, only the first line is logged. In the absence of
25882 both &%log_message%& and &%message%&, a default built-in message is used for
25883 logging rejections.
25884
25885
25886 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
25887 .cindex "&%log_reject_target%& ACL modifier"
25888 .cindex "logging in ACL" "specifying which log"
25889 This modifier makes it possible to specify which logs are used for messages
25890 about ACL rejections. Its argument is a colon-separated list of words that can
25891 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
25892 may be empty, in which case a rejection is not logged at all. For example, this
25893 ACL fragment writes no logging information when access is denied:
25894 .display
25895 &`deny `&<&'some conditions'&>
25896 &`     log_reject_target =`&
25897 .endd
25898 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
25899 permanent and temporary rejections. Its effect lasts for the rest of the
25900 current ACL.
25901
25902
25903 .vitem &*logwrite*&&~=&~<&'text'&>
25904 .cindex "&%logwrite%& ACL modifier"
25905 .cindex "logging in ACL" "immediate"
25906 This modifier writes a message to a log file as soon as it is encountered when
25907 processing an ACL. (Compare &%log_message%&, which, except in the case of
25908 &%warn%& and &%discard%&, is used only if the ACL statement denies
25909 access.) The &%logwrite%& modifier can be used to log special incidents in
25910 ACLs. For example:
25911 .display
25912 &`accept `&<&'some special conditions'&>
25913 &`       control  = freeze`&
25914 &`       logwrite = froze message because ...`&
25915 .endd
25916 By default, the message is written to the main log. However, it may begin
25917 with a colon, followed by a comma-separated list of log names, and then
25918 another colon, to specify exactly which logs are to be written. For
25919 example:
25920 .code
25921 logwrite = :main,reject: text for main and reject logs
25922 logwrite = :panic: text for panic log only
25923 .endd
25924
25925
25926 .vitem &*message*&&~=&~<&'text'&>
25927 .cindex "&%message%& ACL modifier"
25928 This modifier sets up a text string that is expanded and used as a response
25929 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
25930 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
25931 there is some complication if &%endpass%& is involved; see the description of
25932 &%accept%& for details.)
25933
25934 The expansion of the message happens at the time Exim decides that the ACL is
25935 to end, not at the time it processes &%message%&. If the expansion fails, or
25936 generates an empty string, the modifier is ignored. Here is an example where
25937 &%message%& must be specified first, because the ACL ends with a rejection if
25938 the &%hosts%& condition fails:
25939 .code
25940 require  message = Host not recognized
25941          hosts = 10.0.0.0/8
25942 .endd
25943 (Once a condition has failed, no further conditions or modifiers are
25944 processed.)
25945
25946 .cindex "SMTP" "error codes"
25947 .oindex "&%smtp_banner%&
25948 For ACLs that are triggered by SMTP commands, the message is returned as part
25949 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
25950 is meaningful only for SMTP, as no message is returned when a non-SMTP message
25951 is accepted. In the case of the connect ACL, accepting with a message modifier
25952 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
25953 accept message may not contain more than one line (otherwise it will be
25954 truncated at the first newline and a panic logged), and it cannot affect the
25955 EHLO options.
25956
25957 When SMTP is involved, the message may begin with an overriding response code,
25958 consisting of three digits optionally followed by an &"extended response code"&
25959 of the form &'n.n.n'&, each code being followed by a space. For example:
25960 .code
25961 deny  message = 599 1.2.3 Host not welcome
25962       hosts = 192.168.34.0/24
25963 .endd
25964 The first digit of the supplied response code must be the same as would be sent
25965 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
25966 access, but for the predata ACL, note that the default success code is 354, not
25967 2&'xx'&.
25968
25969 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
25970 the message modifier cannot override the 221 response code.
25971
25972 The text in a &%message%& modifier is literal; any quotes are taken as
25973 literals, but because the string is expanded, backslash escapes are processed
25974 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
25975 response.
25976
25977 .vindex "&$acl_verify_message$&"
25978 If &%message%& is used on a statement that verifies an address, the message
25979 specified overrides any message that is generated by the verification process.
25980 However, the original message is available in the variable
25981 &$acl_verify_message$&, so you can incorporate it into your message if you
25982 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
25983 routers to be passed back as part of the SMTP response, you should either not
25984 use a &%message%& modifier, or make use of &$acl_verify_message$&.
25985
25986 For compatibility with previous releases of Exim, a &%message%& modifier that
25987 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
25988 modifier, but this usage is now deprecated. However, &%message%& acts only when
25989 all the conditions are true, wherever it appears in an ACL command, whereas
25990 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
25991 &%warn%& in an ACL that is not concerned with receiving a message, it has no
25992 effect.
25993
25994
25995 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
25996 .cindex "&%set%& ACL modifier"
25997 This modifier puts a value into one of the ACL variables (see section
25998 &<<SECTaclvariables>>&).
25999 .endlist
26000
26001
26002
26003
26004
26005 .section "Use of the control modifier" "SECTcontrols"
26006 .cindex "&%control%& ACL modifier"
26007 The &%control%& modifier supports the following settings:
26008
26009 .vlist
26010 .vitem &*control&~=&~allow_auth_unadvertised*&
26011 This modifier allows a client host to use the SMTP AUTH command even when it
26012 has not been advertised in response to EHLO. Furthermore, because there are
26013 apparently some really broken clients that do this, Exim will accept AUTH after
26014 HELO (rather than EHLO) when this control is set. It should be used only if you
26015 really need it, and you should limit its use to those broken clients that do
26016 not work without it. For example:
26017 .code
26018 warn hosts   = 192.168.34.25
26019      control = allow_auth_unadvertised
26020 .endd
26021 Normally, when an Exim server receives an AUTH command, it checks the name of
26022 the authentication mechanism that is given in the command to ensure that it
26023 matches an advertised mechanism. When this control is set, the check that a
26024 mechanism has been advertised is bypassed. Any configured mechanism can be used
26025 by the client. This control is permitted only in the connection and HELO ACLs.
26026
26027
26028 .vitem &*control&~=&~caseful_local_part*& &&&
26029        &*control&~=&~caselower_local_part*&
26030 .cindex "&ACL;" "case of local part in"
26031 .cindex "case of local parts"
26032 .vindex "&$local_part$&"
26033 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
26034 (that is, during RCPT processing). By default, the contents of &$local_part$&
26035 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
26036 any uppercase letters in the original local part are restored in &$local_part$&
26037 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
26038 is encountered.
26039
26040 These controls affect only the current recipient. Moreover, they apply only to
26041 local part handling that takes place directly in the ACL (for example, as a key
26042 in lookups). If a test to verify the recipient is obeyed, the case-related
26043 handling of the local part during the verification is controlled by the router
26044 configuration (see the &%caseful_local_part%& generic router option).
26045
26046 This facility could be used, for example, to add a spam score to local parts
26047 containing upper case letters. For example, using &$acl_m4$& to accumulate the
26048 spam score:
26049 .code
26050 warn  control = caseful_local_part
26051       set acl_m4 = ${eval:\
26052                      $acl_m4 + \
26053                      ${if match{$local_part}{[A-Z]}{1}{0}}\
26054                     }
26055       control = caselower_local_part
26056 .endd
26057 Notice that we put back the lower cased version afterwards, assuming that
26058 is what is wanted for subsequent tests.
26059
26060
26061 .vitem &*control&~=&~debug/*&<&'options'&>
26062 .cindex "&ACL;" "enabling debug logging"
26063 .cindex "debugging" "enabling from an ACL"
26064 This control turns on debug logging, almost as though Exim had been invoked
26065 with &`-d`&, with the output going to a new logfile, by default called
26066 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
26067 may access any variables already defined.  The logging may be adjusted with
26068 the &'opts'& option, which takes the same values as the &`-d`& command-line
26069 option.  Some examples (which depend on variables that don't exist in all
26070 contexts):
26071 .code
26072       control = debug
26073       control = debug/tag=.$sender_host_address
26074       control = debug/opts=+expand+acl
26075       control = debug/tag=.$message_exim_id/opts=+expand
26076 .endd
26077
26078
26079 .vitem &*control&~=&~enforce_sync*& &&&
26080        &*control&~=&~no_enforce_sync*&
26081 .cindex "SMTP" "synchronization checking"
26082 .cindex "synchronization checking in SMTP"
26083 These controls make it possible to be selective about when SMTP synchronization
26084 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
26085 state of the switch (it is true by default). See the description of this option
26086 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
26087
26088 The effect of these two controls lasts for the remainder of the SMTP
26089 connection. They can appear in any ACL except the one for the non-SMTP
26090 messages. The most straightforward place to put them is in the ACL defined by
26091 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
26092 before the first synchronization check. The expected use is to turn off the
26093 synchronization checks for badly-behaved hosts that you nevertheless need to
26094 work with.
26095
26096
26097 .vitem &*control&~=&~fakedefer/*&<&'message'&>
26098 .cindex "fake defer"
26099 .cindex "defer, fake"
26100 This control works in exactly the same way as &%fakereject%& (described below)
26101 except that it causes an SMTP 450 response after the message data instead of a
26102 550 response. You must take care when using &%fakedefer%& because it causes the
26103 messages to be duplicated when the sender retries. Therefore, you should not
26104 use &%fakedefer%& if the message is to be delivered normally.
26105
26106 .vitem &*control&~=&~fakereject/*&<&'message'&>
26107 .cindex "fake rejection"
26108 .cindex "rejection, fake"
26109 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
26110 words, only when an SMTP message is being received. If Exim accepts the
26111 message, instead the final 250 response, a 550 rejection message is sent.
26112 However, Exim proceeds to deliver the message as normal. The control applies
26113 only to the current message, not to any subsequent ones that may be received in
26114 the same SMTP connection.
26115
26116 The text for the 550 response is taken from the &%control%& modifier. If no
26117 message is supplied, the following is used:
26118 .code
26119 550-Your message has been rejected but is being
26120 550-kept for evaluation.
26121 550-If it was a legitimate message, it may still be
26122 550 delivered to the target recipient(s).
26123 .endd
26124 This facility should be used with extreme caution.
26125
26126 .vitem &*control&~=&~freeze*&
26127 .cindex "frozen messages" "forcing in ACL"
26128 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26129 other words, only when a message is being received. If the message is accepted,
26130 it is placed on Exim's queue and frozen. The control applies only to the
26131 current message, not to any subsequent ones that may be received in the same
26132 SMTP connection.
26133
26134 This modifier can optionally be followed by &`/no_tell`&. If the global option
26135 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
26136 is told about the freezing), provided all the &*control=freeze*& modifiers that
26137 are obeyed for the current message have the &`/no_tell`& option.
26138
26139 .vitem &*control&~=&~no_delay_flush*&
26140 .cindex "SMTP" "output flushing, disabling for delay"
26141 Exim normally flushes SMTP output before implementing a delay in an ACL, to
26142 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26143 use. This control, as long as it is encountered before the &%delay%& modifier,
26144 disables such output flushing.
26145
26146 .vitem &*control&~=&~no_callout_flush*&
26147 .cindex "SMTP" "output flushing, disabling for callout"
26148 Exim normally flushes SMTP output before performing a callout in an ACL, to
26149 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26150 use. This control, as long as it is encountered before the &%verify%& condition
26151 that causes the callout, disables such output flushing.
26152
26153 .vitem &*control&~=&~no_mbox_unspool*&
26154 This control is available when Exim is compiled with the content scanning
26155 extension. Content scanning may require a copy of the current message, or parts
26156 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
26157 or spam scanner. Normally, such copies are deleted when they are no longer
26158 needed. If this control is set, the copies are not deleted. The control applies
26159 only to the current message, not to any subsequent ones that may be received in
26160 the same SMTP connection. It is provided for debugging purposes and is unlikely
26161 to be useful in production.
26162
26163 .vitem &*control&~=&~no_multiline_responses*&
26164 .cindex "multiline responses, suppressing"
26165 This control is permitted for any ACL except the one for non-SMTP messages.
26166 It seems that there are broken clients in use that cannot handle multiline
26167 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
26168
26169 If this control is set, multiline SMTP responses from ACL rejections are
26170 suppressed. One way of doing this would have been to put out these responses as
26171 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
26172 (&"use multiline responses for more"& it says &-- ha!), and some of the
26173 responses might get close to that. So this facility, which is after all only a
26174 sop to broken clients, is implemented by doing two very easy things:
26175
26176 .ilist
26177 Extra information that is normally output as part of a rejection caused by
26178 sender verification failure is omitted. Only the final line (typically &"sender
26179 verification failed"&) is sent.
26180 .next
26181 If a &%message%& modifier supplies a multiline response, only the first
26182 line is output.
26183 .endlist
26184
26185 The setting of the switch can, of course, be made conditional on the
26186 calling host. Its effect lasts until the end of the SMTP connection.
26187
26188 .vitem &*control&~=&~no_pipelining*&
26189 .cindex "PIPELINING" "suppressing advertising"
26190 This control turns off the advertising of the PIPELINING extension to SMTP in
26191 the current session. To be useful, it must be obeyed before Exim sends its
26192 response to an EHLO command. Therefore, it should normally appear in an ACL
26193 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
26194 &%pipelining_advertise_hosts%&.
26195
26196 .vitem &*control&~=&~queue_only*&
26197 .oindex "&%queue_only%&"
26198 .cindex "queueing incoming messages"
26199 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26200 other words, only when a message is being received. If the message is accepted,
26201 it is placed on Exim's queue and left there for delivery by a subsequent queue
26202 runner. No immediate delivery process is started. In other words, it has the
26203 effect as the &%queue_only%& global option. However, the control applies only
26204 to the current message, not to any subsequent ones that may be received in the
26205 same SMTP connection.
26206
26207 .vitem &*control&~=&~submission/*&<&'options'&>
26208 .cindex "message" "submission"
26209 .cindex "submission mode"
26210 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
26211 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
26212 the current message is a submission from a local MUA. In this case, Exim
26213 operates in &"submission mode"&, and applies certain fixups to the message if
26214 necessary. For example, it adds a &'Date:'& header line if one is not present.
26215 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
26216 late (the message has already been created).
26217
26218 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
26219 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
26220 submission mode; the available options for this control are described there.
26221 The control applies only to the current message, not to any subsequent ones
26222 that may be received in the same SMTP connection.
26223
26224 .vitem &*control&~=&~suppress_local_fixups*&
26225 .cindex "submission fixups, suppressing"
26226 This control applies to locally submitted (non TCP/IP) messages, and is the
26227 complement of &`control = submission`&. It disables the fixups that are
26228 normally applied to locally-submitted messages. Specifically:
26229
26230 .ilist
26231 Any &'Sender:'& header line is left alone (in this respect, it is a
26232 dynamic version of &%local_sender_retain%&).
26233 .next
26234 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
26235 .next
26236 There is no check that &'From:'& corresponds to the actual sender.
26237 .endlist ilist
26238
26239 This control may be useful when a remotely-originated message is accepted,
26240 passed to some scanning program, and then re-submitted for delivery. It can be
26241 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
26242 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
26243 data is read.
26244
26245 &*Note:*& This control applies only to the current message, not to any others
26246 that are being submitted at the same time using &%-bs%& or &%-bS%&.
26247 .endlist vlist
26248
26249
26250 .section "Summary of message fixup control" "SECTsummesfix"
26251 All four possibilities for message fixups can be specified:
26252
26253 .ilist
26254 Locally submitted, fixups applied: the default.
26255 .next
26256 Locally submitted, no fixups applied: use
26257 &`control = suppress_local_fixups`&.
26258 .next
26259 Remotely submitted, no fixups applied: the default.
26260 .next
26261 Remotely submitted, fixups applied: use &`control = submission`&.
26262 .endlist
26263
26264
26265
26266 .section "Adding header lines in ACLs" "SECTaddheadacl"
26267 .cindex "header lines" "adding in an ACL"
26268 .cindex "header lines" "position of added lines"
26269 .cindex "&%message%& ACL modifier"
26270 The &%add_header%& modifier can be used to add one or more extra header lines
26271 to an incoming message, as in this example:
26272 .code
26273 warn dnslists = sbl.spamhaus.org : \
26274                 dialup.mail-abuse.org
26275      add_header = X-blacklisted-at: $dnslist_domain
26276 .endd
26277 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
26278 MIME, and non-SMTP ACLs (in other words, those that are concerned with
26279 receiving a message). The message must ultimately be accepted for
26280 &%add_header%& to have any significant effect. You can use &%add_header%& with
26281 any ACL verb, including &%deny%& (though this is potentially useful only in a
26282 RCPT ACL).
26283
26284 If the data for the &%add_header%& modifier contains one or more newlines that
26285 are not followed by a space or a tab, it is assumed to contain multiple header
26286 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26287 front of any line that is not a valid header line.
26288
26289 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26290 They are added to the message before processing the DATA and MIME ACLs.
26291 However, if an identical header line is requested more than once, only one copy
26292 is actually added to the message. Further header lines may be accumulated
26293 during the DATA and MIME ACLs, after which they are added to the message, again
26294 with duplicates suppressed. Thus, it is possible to add two identical header
26295 lines to an SMTP message, but only if one is added before DATA and one after.
26296 In the case of non-SMTP messages, new headers are accumulated during the
26297 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26298 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26299 are included in the entry that is written to the reject log.
26300
26301 .cindex "header lines" "added; visibility of"
26302 Header lines are not visible in string expansions until they are added to the
26303 message. It follows that header lines defined in the MAIL, RCPT, and predata
26304 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26305 header lines that are added by the DATA or MIME ACLs are not visible in those
26306 ACLs. Because of this restriction, you cannot use header lines as a way of
26307 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26308 this, you can use ACL variables, as described in section
26309 &<<SECTaclvariables>>&.
26310
26311 The &%add_header%& modifier acts immediately it is encountered during the
26312 processing of an ACL. Notice the difference between these two cases:
26313 .display
26314 &`accept add_header = ADDED: some text`&
26315 &`       `&<&'some condition'&>
26316
26317 &`accept `&<&'some condition'&>
26318 &`       add_header = ADDED: some text`&
26319 .endd
26320 In the first case, the header line is always added, whether or not the
26321 condition is true. In the second case, the header line is added only if the
26322 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26323 ACL statement. All those that are encountered before a condition fails are
26324 honoured.
26325
26326 .cindex "&%warn%& ACL verb"
26327 For compatibility with previous versions of Exim, a &%message%& modifier for a
26328 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26329 effect only if all the conditions are true, even if it appears before some of
26330 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26331 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26332 are present on a &%warn%& verb, both are processed according to their
26333 specifications.
26334
26335 By default, new header lines are added to a message at the end of the existing
26336 header lines. However, you can specify that any particular header line should
26337 be added right at the start (before all the &'Received:'& lines), immediately
26338 after the first block of &'Received:'& lines, or immediately before any line
26339 that is not a &'Received:'& or &'Resent-something:'& header.
26340
26341 This is done by specifying &":at_start:"&, &":after_received:"&, or
26342 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26343 header line, respectively. (Header text cannot start with a colon, as there has
26344 to be a header name first.) For example:
26345 .code
26346 warn add_header = \
26347        :after_received:X-My-Header: something or other...
26348 .endd
26349 If more than one header line is supplied in a single &%add_header%& modifier,
26350 each one is treated independently and can therefore be placed differently. If
26351 you add more than one line at the start, or after the Received: block, they end
26352 up in reverse order.
26353
26354 &*Warning*&: This facility currently applies only to header lines that are
26355 added in an ACL. It does NOT work for header lines that are added in a
26356 system filter or in a router or transport.
26357
26358
26359
26360
26361 .section "ACL conditions" "SECTaclconditions"
26362 .cindex "&ACL;" "conditions; list of"
26363 Some of conditions listed in this section are available only when Exim is
26364 compiled with the content-scanning extension. They are included here briefly
26365 for completeness. More detailed descriptions can be found in the discussion on
26366 content scanning in chapter &<<CHAPexiscan>>&.
26367
26368 Not all conditions are relevant in all circumstances. For example, testing
26369 senders and recipients does not make sense in an ACL that is being run as the
26370 result of the arrival of an ETRN command, and checks on message headers can be
26371 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
26372 can use the same condition (with different parameters) more than once in the
26373 same ACL statement. This provides a way of specifying an &"and"& conjunction.
26374 The conditions are as follows:
26375
26376
26377 .vlist
26378 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
26379 .cindex "&ACL;" "nested"
26380 .cindex "&ACL;" "indirect"
26381 .cindex "&%acl%& ACL condition"
26382 The possible values of the argument are the same as for the
26383 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
26384 &"accept"& the condition is true; if it returns &"deny"& the condition is
26385 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
26386 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
26387 condition false. This means that further processing of the &%warn%& verb
26388 ceases, but processing of the ACL continues.
26389
26390 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
26391 the connection is dropped. If it returns &"discard"&, the verb must be
26392 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
26393 conditions are tested.
26394
26395 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
26396 loops. This condition allows you to use different ACLs in different
26397 circumstances. For example, different ACLs can be used to handle RCPT commands
26398 for different local users or different local domains.
26399
26400 .vitem &*authenticated&~=&~*&<&'string&~list'&>
26401 .cindex "&%authenticated%& ACL condition"
26402 .cindex "authentication" "ACL checking"
26403 .cindex "&ACL;" "testing for authentication"
26404 If the SMTP connection is not authenticated, the condition is false. Otherwise,
26405 the name of the authenticator is tested against the list. To test for
26406 authentication by any authenticator, you can set
26407 .code
26408 authenticated = *
26409 .endd
26410
26411 .vitem &*condition&~=&~*&<&'string'&>
26412 .cindex "&%condition%& ACL condition"
26413 .cindex "customizing" "ACL condition"
26414 .cindex "&ACL;" "customized test"
26415 .cindex "&ACL;" "testing, customized"
26416 This feature allows you to make up custom conditions. If the result of
26417 expanding the string is an empty string, the number zero, or one of the strings
26418 &"no"& or &"false"&, the condition is false. If the result is any non-zero
26419 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
26420 any other value, some error is assumed to have occurred, and the ACL returns
26421 &"defer"&. However, if the expansion is forced to fail, the condition is
26422 ignored. The effect is to treat it as true, whether it is positive or
26423 negative.
26424
26425 .vitem &*decode&~=&~*&<&'location'&>
26426 .cindex "&%decode%& ACL condition"
26427 This condition is available only when Exim is compiled with the
26428 content-scanning extension, and it is allowed only in the ACL defined by
26429 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
26430 If all goes well, the condition is true. It is false only if there are
26431 problems such as a syntax error or a memory shortage. For more details, see
26432 chapter &<<CHAPexiscan>>&.
26433
26434 .vitem &*demime&~=&~*&<&'extension&~list'&>
26435 .cindex "&%demime%& ACL condition"
26436 This condition is available only when Exim is compiled with the
26437 content-scanning extension. Its use is described in section
26438 &<<SECTdemimecond>>&.
26439
26440 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
26441 .cindex "&%dnslists%& ACL condition"
26442 .cindex "DNS list" "in ACL"
26443 .cindex "black list (DNS)"
26444 .cindex "&ACL;" "testing a DNS list"
26445 This condition checks for entries in DNS black lists. These are also known as
26446 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
26447 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
26448 different variants of this condition to describe briefly here. See sections
26449 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
26450
26451 .vitem &*domains&~=&~*&<&'domain&~list'&>
26452 .cindex "&%domains%& ACL condition"
26453 .cindex "domain" "ACL checking"
26454 .cindex "&ACL;" "testing a recipient domain"
26455 .vindex "&$domain_data$&"
26456 This condition is relevant only after a RCPT command. It checks that the domain
26457 of the recipient address is in the domain list. If percent-hack processing is
26458 enabled, it is done before this test is done. If the check succeeds with a
26459 lookup, the result of the lookup is placed in &$domain_data$& until the next
26460 &%domains%& test.
26461
26462 &*Note carefully*& (because many people seem to fall foul of this): you cannot
26463 use &%domains%& in a DATA ACL.
26464
26465
26466 .vitem &*encrypted&~=&~*&<&'string&~list'&>
26467 .cindex "&%encrypted%& ACL condition"
26468 .cindex "encryption" "checking in an ACL"
26469 .cindex "&ACL;" "testing for encryption"
26470 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
26471 name of the cipher suite in use is tested against the list. To test for
26472 encryption without testing for any specific cipher suite(s), set
26473 .code
26474 encrypted = *
26475 .endd
26476
26477
26478 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
26479 .cindex "&%hosts%& ACL condition"
26480 .cindex "host" "ACL checking"
26481 .cindex "&ACL;" "testing the client host"
26482 This condition tests that the calling host matches the host list. If you have
26483 name lookups or wildcarded host names and IP addresses in the same host list,
26484 you should normally put the IP addresses first. For example, you could have:
26485 .code
26486 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
26487 .endd
26488 The lookup in this example uses the host name for its key. This is implied by
26489 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
26490 and it wouldn't matter which way round you had these two items.)
26491
26492 The reason for the problem with host names lies in the left-to-right way that
26493 Exim processes lists. It can test IP addresses without doing any DNS lookups,
26494 but when it reaches an item that requires a host name, it fails if it cannot
26495 find a host name to compare with the pattern. If the above list is given in the
26496 opposite order, the &%accept%& statement fails for a host whose name cannot be
26497 found, even if its IP address is 10.9.8.7.
26498
26499 If you really do want to do the name check first, and still recognize the IP
26500 address even if the name lookup fails, you can rewrite the ACL like this:
26501 .code
26502 accept hosts = dbm;/etc/friendly/hosts
26503 accept hosts = 10.9.8.7
26504 .endd
26505 The default action on failing to find the host name is to assume that the host
26506 is not in the list, so the first &%accept%& statement fails. The second
26507 statement can then check the IP address.
26508
26509 .vindex "&$host_data$&"
26510 If a &%hosts%& condition is satisfied by means of a lookup, the result
26511 of the lookup is made available in the &$host_data$& variable. This
26512 allows you, for example, to set up a statement like this:
26513 .code
26514 deny  hosts = net-lsearch;/some/file
26515 message = $host_data
26516 .endd
26517 which gives a custom error message for each denied host.
26518
26519 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
26520 .cindex "&%local_parts%& ACL condition"
26521 .cindex "local part" "ACL checking"
26522 .cindex "&ACL;" "testing a local part"
26523 .vindex "&$local_part_data$&"
26524 This condition is relevant only after a RCPT command. It checks that the local
26525 part of the recipient address is in the list. If percent-hack processing is
26526 enabled, it is done before this test. If the check succeeds with a lookup, the
26527 result of the lookup is placed in &$local_part_data$&, which remains set until
26528 the next &%local_parts%& test.
26529
26530 .vitem &*malware&~=&~*&<&'option'&>
26531 .cindex "&%malware%& ACL condition"
26532 .cindex "&ACL;" "virus scanning"
26533 .cindex "&ACL;" "scanning for viruses"
26534 This condition is available only when Exim is compiled with the
26535 content-scanning extension. It causes the incoming message to be scanned for
26536 viruses. For details, see chapter &<<CHAPexiscan>>&.
26537
26538 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26539 .cindex "&%mime_regex%& ACL condition"
26540 .cindex "&ACL;" "testing by regex matching"
26541 This condition is available only when Exim is compiled with the
26542 content-scanning extension, and it is allowed only in the ACL defined by
26543 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
26544 with any of the regular expressions. For details, see chapter
26545 &<<CHAPexiscan>>&.
26546
26547 .vitem &*ratelimit&~=&~*&<&'parameters'&>
26548 .cindex "rate limiting"
26549 This condition can be used to limit the rate at which a user or host submits
26550 messages. Details are given in section &<<SECTratelimiting>>&.
26551
26552 .vitem &*recipients&~=&~*&<&'address&~list'&>
26553 .cindex "&%recipients%& ACL condition"
26554 .cindex "recipient" "ACL checking"
26555 .cindex "&ACL;" "testing a recipient"
26556 This condition is relevant only after a RCPT command. It checks the entire
26557 recipient address against a list of recipients.
26558
26559 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26560 .cindex "&%regex%& ACL condition"
26561 .cindex "&ACL;" "testing by regex matching"
26562 This condition is available only when Exim is compiled with the
26563 content-scanning extension, and is available only in the DATA, MIME, and
26564 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
26565 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
26566
26567 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
26568 .cindex "&%sender_domains%& ACL condition"
26569 .cindex "sender" "ACL checking"
26570 .cindex "&ACL;" "testing a sender domain"
26571 .vindex "&$domain$&"
26572 .vindex "&$sender_address_domain$&"
26573 This condition tests the domain of the sender of the message against the given
26574 domain list. &*Note*&: The domain of the sender address is in
26575 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
26576 of this condition. This is an exception to the general rule for testing domain
26577 lists. It is done this way so that, if this condition is used in an ACL for a
26578 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
26579 influence the sender checking.
26580
26581 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26582 relaying, because sender addresses are easily, and commonly, forged.
26583
26584 .vitem &*senders&~=&~*&<&'address&~list'&>
26585 .cindex "&%senders%& ACL condition"
26586 .cindex "sender" "ACL checking"
26587 .cindex "&ACL;" "testing a sender"
26588 This condition tests the sender of the message against the given list. To test
26589 for a bounce message, which has an empty sender, set
26590 .code
26591 senders = :
26592 .endd
26593 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26594 relaying, because sender addresses are easily, and commonly, forged.
26595
26596 .vitem &*spam&~=&~*&<&'username'&>
26597 .cindex "&%spam%& ACL condition"
26598 .cindex "&ACL;" "scanning for spam"
26599 This condition is available only when Exim is compiled with the
26600 content-scanning extension. It causes the incoming message to be scanned by
26601 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
26602
26603 .vitem &*verify&~=&~certificate*&
26604 .cindex "&%verify%& ACL condition"
26605 .cindex "TLS" "client certificate verification"
26606 .cindex "certificate" "verification of client"
26607 .cindex "&ACL;" "certificate verification"
26608 .cindex "&ACL;" "testing a TLS certificate"
26609 This condition is true in an SMTP session if the session is encrypted, and a
26610 certificate was received from the client, and the certificate was verified. The
26611 server requests a certificate only if the client matches &%tls_verify_hosts%&
26612 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
26613
26614 .vitem &*verify&~=&~csa*&
26615 .cindex "CSA verification"
26616 This condition checks whether the sending host (the client) is authorized to
26617 send email. Details of how this works are given in section
26618 &<<SECTverifyCSA>>&.
26619
26620 .vitem &*verify&~=&~header_sender/*&<&'options'&>
26621 .cindex "&%verify%& ACL condition"
26622 .cindex "&ACL;" "verifying sender in the header"
26623 .cindex "header lines" "verifying the sender in"
26624 .cindex "sender" "verifying in header"
26625 .cindex "verifying" "sender in header"
26626 This condition is relevant only in an ACL that is run after a message has been
26627 received, that is, in an ACL specified by &%acl_smtp_data%& or
26628 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
26629 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
26630 is loosely thought of as a &"sender"& address (hence the name of the test).
26631 However, an address that appears in one of these headers need not be an address
26632 that accepts bounce messages; only sender addresses in envelopes are required
26633 to accept bounces. Therefore, if you use the callout option on this check, you
26634 might want to arrange for a non-empty address in the MAIL command.
26635
26636 Details of address verification and the options are given later, starting at
26637 section &<<SECTaddressverification>>& (callouts are described in section
26638 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
26639 condition to restrict it to bounce messages only:
26640 .code
26641 deny    senders = :
26642         message = A valid sender header is required for bounces
26643        !verify  = header_sender
26644 .endd
26645
26646 .vitem &*verify&~=&~header_syntax*&
26647 .cindex "&%verify%& ACL condition"
26648 .cindex "&ACL;" "verifying header syntax"
26649 .cindex "header lines" "verifying syntax"
26650 .cindex "verifying" "header syntax"
26651 This condition is relevant only in an ACL that is run after a message has been
26652 received, that is, in an ACL specified by &%acl_smtp_data%& or
26653 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
26654 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
26655 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
26656 permitted only in locally generated messages and from hosts that match
26657 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26658 appropriate.
26659
26660 Note that this condition is a syntax check only. However, a common spamming
26661 ploy used to be to send syntactically invalid headers such as
26662 .code
26663 To: @
26664 .endd
26665 and this condition can be used to reject such messages, though they are not as
26666 common as they used to be.
26667
26668 .vitem &*verify&~=&~helo*&
26669 .cindex "&%verify%& ACL condition"
26670 .cindex "&ACL;" "verifying HELO/EHLO"
26671 .cindex "HELO" "verifying"
26672 .cindex "EHLO" "verifying"
26673 .cindex "verifying" "EHLO"
26674 .cindex "verifying" "HELO"
26675 This condition is true if a HELO or EHLO command has been received from the
26676 client host, and its contents have been verified. If there has been no previous
26677 attempt to verify the HELO/EHLO contents, it is carried out when this
26678 condition is encountered. See the description of the &%helo_verify_hosts%& and
26679 &%helo_try_verify_hosts%& options for details of how to request verification
26680 independently of this condition.
26681
26682 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
26683 option), this condition is always true.
26684
26685
26686 .vitem &*verify&~=&~not_blind*&
26687 .cindex "verifying" "not blind"
26688 .cindex "bcc recipients, verifying none"
26689 This condition checks that there are no blind (bcc) recipients in the message.
26690 Every envelope recipient must appear either in a &'To:'& header line or in a
26691 &'Cc:'& header line for this condition to be true. Local parts are checked
26692 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
26693 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
26694 used only in a DATA or non-SMTP ACL.
26695
26696 There are, of course, many legitimate messages that make use of blind (bcc)
26697 recipients. This check should not be used on its own for blocking messages.
26698
26699
26700 .vitem &*verify&~=&~recipient/*&<&'options'&>
26701 .cindex "&%verify%& ACL condition"
26702 .cindex "&ACL;" "verifying recipient"
26703 .cindex "recipient" "verifying"
26704 .cindex "verifying" "recipient"
26705 .vindex "&$address_data$&"
26706 This condition is relevant only after a RCPT command. It verifies the current
26707 recipient. Details of address verification are given later, starting at section
26708 &<<SECTaddressverification>>&. After a recipient has been verified, the value
26709 of &$address_data$& is the last value that was set while routing the address.
26710 This applies even if the verification fails. When an address that is being
26711 verified is redirected to a single address, verification continues with the new
26712 address, and in that case, the subsequent value of &$address_data$& is the
26713 value for the child address.
26714
26715 .vitem &*verify&~=&~reverse_host_lookup*&
26716 .cindex "&%verify%& ACL condition"
26717 .cindex "&ACL;" "verifying host reverse lookup"
26718 .cindex "host" "verifying reverse lookup"
26719 This condition ensures that a verified host name has been looked up from the IP
26720 address of the client host. (This may have happened already if the host name
26721 was needed for checking a host list, or if the host matched &%host_lookup%&.)
26722 Verification ensures that the host name obtained from a reverse DNS lookup, or
26723 one of its aliases, does, when it is itself looked up in the DNS, yield the
26724 original IP address.
26725
26726 If this condition is used for a locally generated message (that is, when there
26727 is no client host involved), it always succeeds.
26728
26729 .vitem &*verify&~=&~sender/*&<&'options'&>
26730 .cindex "&%verify%& ACL condition"
26731 .cindex "&ACL;" "verifying sender"
26732 .cindex "sender" "verifying"
26733 .cindex "verifying" "sender"
26734 This condition is relevant only after a MAIL or RCPT command, or after a
26735 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
26736 the message's sender is empty (that is, this is a bounce message), the
26737 condition is true. Otherwise, the sender address is verified.
26738
26739 .vindex "&$address_data$&"
26740 .vindex "&$sender_address_data$&"
26741 If there is data in the &$address_data$& variable at the end of routing, its
26742 value is placed in &$sender_address_data$& at the end of verification. This
26743 value can be used in subsequent conditions and modifiers in the same ACL
26744 statement. It does not persist after the end of the current statement. If you
26745 want to preserve the value for longer, you can save it in an ACL variable.
26746
26747 Details of verification are given later, starting at section
26748 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
26749 to avoid doing it more than once per message.
26750
26751 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
26752 .cindex "&%verify%& ACL condition"
26753 This is a variation of the previous option, in which a modified address is
26754 verified as a sender.
26755 .endlist
26756
26757
26758
26759 .section "Using DNS lists" "SECTmorednslists"
26760 .cindex "DNS list" "in ACL"
26761 .cindex "black list (DNS)"
26762 .cindex "&ACL;" "testing a DNS list"
26763 In its simplest form, the &%dnslists%& condition tests whether the calling host
26764 is on at least one of a number of DNS lists by looking up the inverted IP
26765 address in one or more DNS domains. (Note that DNS list domains are not mail
26766 domains, so the &`+`& syntax for named lists doesn't work - it is used for
26767 special options instead.) For example, if the calling host's IP
26768 address is 192.168.62.43, and the ACL statement is
26769 .code
26770 deny dnslists = blackholes.mail-abuse.org : \
26771                 dialups.mail-abuse.org
26772 .endd
26773 the following records are looked up:
26774 .code
26775 43.62.168.192.blackholes.mail-abuse.org
26776 43.62.168.192.dialups.mail-abuse.org
26777 .endd
26778 As soon as Exim finds an existing DNS record, processing of the list stops.
26779 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
26780 to test that a host is on more than one list (an &"and"& conjunction), you can
26781 use two separate conditions:
26782 .code
26783 deny dnslists = blackholes.mail-abuse.org
26784      dnslists = dialups.mail-abuse.org
26785 .endd
26786 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
26787 behaves as if the host does not match the list item, that is, as if the DNS
26788 record does not exist. If there are further items in the DNS list, they are
26789 processed.
26790
26791 This is usually the required action when &%dnslists%& is used with &%deny%&
26792 (which is the most common usage), because it prevents a DNS failure from
26793 blocking mail. However, you can change this behaviour by putting one of the
26794 following special items in the list:
26795 .display
26796 &`+include_unknown `&   behave as if the item is on the list
26797 &`+exclude_unknown `&   behave as if the item is not on the list (default)
26798 &`+defer_unknown   `&   give a temporary error
26799 .endd
26800 .cindex "&`+include_unknown`&"
26801 .cindex "&`+exclude_unknown`&"
26802 .cindex "&`+defer_unknown`&"
26803 Each of these applies to any subsequent items on the list. For example:
26804 .code
26805 deny dnslists = +defer_unknown : foo.bar.example
26806 .endd
26807 Testing the list of domains stops as soon as a match is found. If you want to
26808 warn for one list and block for another, you can use two different statements:
26809 .code
26810 deny  dnslists = blackholes.mail-abuse.org
26811 warn  message  = X-Warn: sending host is on dialups list
26812       dnslists = dialups.mail-abuse.org
26813 .endd
26814 DNS list lookups are cached by Exim for the duration of the SMTP session,
26815 so a lookup based on the IP address is done at most once for any incoming
26816 connection. Exim does not share information between multiple incoming
26817 connections (but your local name server cache should be active).
26818
26819
26820
26821 .section "Specifying the IP address for a DNS list lookup" "SECID201"
26822 .cindex "DNS list" "keyed by explicit IP address"
26823 By default, the IP address that is used in a DNS list lookup is the IP address
26824 of the calling host. However, you can specify another IP address by listing it
26825 after the domain name, introduced by a slash. For example:
26826 .code
26827 deny dnslists = black.list.tld/192.168.1.2
26828 .endd
26829 This feature is not very helpful with explicit IP addresses; it is intended for
26830 use with IP addresses that are looked up, for example, the IP addresses of the
26831 MX hosts or nameservers of an email sender address. For an example, see section
26832 &<<SECTmulkeyfor>>& below.
26833
26834
26835
26836
26837 .section "DNS lists keyed on domain names" "SECID202"
26838 .cindex "DNS list" "keyed by domain name"
26839 There are some lists that are keyed on domain names rather than inverted IP
26840 addresses (see for example the &'domain based zones'& link at
26841 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
26842 with these lists. You can change the name that is looked up in a DNS list by
26843 listing it after the domain name, introduced by a slash. For example,
26844 .code
26845 deny  message  = Sender's domain is listed at $dnslist_domain
26846       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
26847 .endd
26848 This particular example is useful only in ACLs that are obeyed after the
26849 RCPT or DATA commands, when a sender address is available. If (for
26850 example) the message's sender is &'user@tld.example'& the name that is looked
26851 up by this example is
26852 .code
26853 tld.example.dsn.rfc-ignorant.org
26854 .endd
26855 A single &%dnslists%& condition can contain entries for both names and IP
26856 addresses. For example:
26857 .code
26858 deny dnslists = sbl.spamhaus.org : \
26859                 dsn.rfc-ignorant.org/$sender_address_domain
26860 .endd
26861 The first item checks the sending host's IP address; the second checks a domain
26862 name. The whole condition is true if either of the DNS lookups succeeds.
26863
26864
26865
26866
26867 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
26868 .cindex "DNS list" "multiple keys for"
26869 The syntax described above for looking up explicitly-defined values (either
26870 names or IP addresses) in a DNS blacklist is a simplification. After the domain
26871 name for the DNS list, what follows the slash can in fact be a list of items.
26872 As with all lists in Exim, the default separator is a colon. However, because
26873 this is a sublist within the list of DNS blacklist domains, it is necessary
26874 either to double the separators like this:
26875 .code
26876 dnslists = black.list.tld/name.1::name.2
26877 .endd
26878 or to change the separator character, like this:
26879 .code
26880 dnslists = black.list.tld/<;name.1;name.2
26881 .endd
26882 If an item in the list is an IP address, it is inverted before the DNS
26883 blacklist domain is appended. If it is not an IP address, no inversion
26884 occurs. Consider this condition:
26885 .code
26886 dnslists = black.list.tld/<;192.168.1.2;a.domain
26887 .endd
26888 The DNS lookups that occur are:
26889 .code
26890 2.1.168.192.black.list.tld
26891 a.domain.black.list.tld
26892 .endd
26893 Once a DNS record has been found (that matches a specific IP return
26894 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
26895 are done. If there is a temporary DNS error, the rest of the sublist of domains
26896 or IP addresses is tried. A temporary error for the whole dnslists item occurs
26897 only if no other DNS lookup in this sublist succeeds. In other words, a
26898 successful lookup for any of the items in the sublist overrides a temporary
26899 error for a previous item.
26900
26901 The ability to supply a list of items after the slash is in some sense just a
26902 syntactic convenience. These two examples have the same effect:
26903 .code
26904 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
26905 dnslists = black.list.tld/a.domain::b.domain
26906 .endd
26907 However, when the data for the list is obtained from a lookup, the second form
26908 is usually much more convenient. Consider this example:
26909 .code
26910 deny message  = The mail servers for the domain \
26911                 $sender_address_domain \
26912                 are listed at $dnslist_domain ($dnslist_value); \
26913                 see $dnslist_text.
26914      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
26915                                    ${lookup dnsdb {>|mxh=\
26916                                    $sender_address_domain} }} }
26917 .endd
26918 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
26919 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
26920 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
26921 of expanding the condition might be something like this:
26922 .code
26923 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
26924 .endd
26925 Thus, this example checks whether or not the IP addresses of the sender
26926 domain's mail servers are on the Spamhaus black list.
26927
26928 The key that was used for a successful DNS list lookup is put into the variable
26929 &$dnslist_matched$& (see section &<<SECID204>>&).
26930
26931
26932
26933
26934 .section "Data returned by DNS lists" "SECID203"
26935 .cindex "DNS list" "data returned from"
26936 DNS lists are constructed using address records in the DNS. The original RBL
26937 just used the address 127.0.0.1 on the right hand side of each record, but the
26938 RBL+ list and some other lists use a number of values with different meanings.
26939 The values used on the RBL+ list are:
26940 .display
26941 127.1.0.1  RBL
26942 127.1.0.2  DUL
26943 127.1.0.3  DUL and RBL
26944 127.1.0.4  RSS
26945 127.1.0.5  RSS and RBL
26946 127.1.0.6  RSS and DUL
26947 127.1.0.7  RSS and DUL and RBL
26948 .endd
26949 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
26950 different values. Some DNS lists may return more than one address record;
26951 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
26952
26953
26954 .section "Variables set from DNS lists" "SECID204"
26955 .cindex "expansion" "variables, set from DNS list"
26956 .cindex "DNS list" "variables set from"
26957 .vindex "&$dnslist_domain$&"
26958 .vindex "&$dnslist_matched$&"
26959 .vindex "&$dnslist_text$&"
26960 .vindex "&$dnslist_value$&"
26961 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
26962 the name of the overall domain that matched (for example,
26963 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
26964 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
26965 the DNS record. When the key is an IP address, it is not reversed in
26966 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
26967 cases, for example:
26968 .code
26969 deny dnslists = spamhaus.example
26970 .endd
26971 the key is also available in another variable (in this case,
26972 &$sender_host_address$&). In more complicated cases, however, this is not true.
26973 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
26974 might generate a dnslists lookup like this:
26975 .code
26976 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
26977 .endd
26978 If this condition succeeds, the value in &$dnslist_matched$& might be
26979 &`192.168.6.7`& (for example).
26980
26981 If more than one address record is returned by the DNS lookup, all the IP
26982 addresses are included in &$dnslist_value$&, separated by commas and spaces.
26983 The variable &$dnslist_text$& contains the contents of any associated TXT
26984 record. For lists such as RBL+ the TXT record for a merged entry is often not
26985 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
26986 information.
26987
26988 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
26989 &-- although these appear before the condition in the ACL, they are not
26990 expanded until after it has failed. For example:
26991 .code
26992 deny    hosts = !+local_networks
26993         message = $sender_host_address is listed \
26994                   at $dnslist_domain
26995         dnslists = rbl-plus.mail-abuse.example
26996 .endd
26997
26998
26999
27000 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
27001 .cindex "DNS list" "matching specific returned data"
27002 You can add an equals sign and an IP address after a &%dnslists%& domain name
27003 in order to restrict its action to DNS records with a matching right hand side.
27004 For example,
27005 .code
27006 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
27007 .endd
27008 rejects only those hosts that yield 127.0.0.2. Without this additional data,
27009 any address record is considered to be a match. For the moment, we assume
27010 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
27011 describes how multiple records are handled.
27012
27013 More than one IP address may be given for checking, using a comma as a
27014 separator. These are alternatives &-- if any one of them matches, the
27015 &%dnslists%& condition is true. For example:
27016 .code
27017 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27018 .endd
27019 If you want to specify a constraining address list and also specify names or IP
27020 addresses to be looked up, the constraining address list must be specified
27021 first. For example:
27022 .code
27023 deny dnslists = dsn.rfc-ignorant.org\
27024                 =127.0.0.2/$sender_address_domain
27025 .endd
27026
27027 If the character &`&&`& is used instead of &`=`&, the comparison for each
27028 listed IP address is done by a bitwise &"and"& instead of by an equality test.
27029 In other words, the listed addresses are used as bit masks. The comparison is
27030 true if all the bits in the mask are present in the address that is being
27031 tested. For example:
27032 .code
27033 dnslists = a.b.c&0.0.0.3
27034 .endd
27035 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
27036 want to test whether one bit or another bit is present (as opposed to both
27037 being present), you must use multiple values. For example:
27038 .code
27039 dnslists = a.b.c&0.0.0.1,0.0.0.2
27040 .endd
27041 matches if the final component of the address is an odd number or two times
27042 an odd number.
27043
27044
27045
27046 .section "Negated DNS matching conditions" "SECID205"
27047 You can supply a negative list of IP addresses as part of a &%dnslists%&
27048 condition. Whereas
27049 .code
27050 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27051 .endd
27052 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27053 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
27054 .code
27055 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
27056 .endd
27057 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27058 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
27059 words, the result of the test is inverted if an exclamation mark appears before
27060 the &`=`& (or the &`&&`&) sign.
27061
27062 &*Note*&: This kind of negation is not the same as negation in a domain,
27063 host, or address list (which is why the syntax is different).
27064
27065 If you are using just one list, the negation syntax does not gain you much. The
27066 previous example is precisely equivalent to
27067 .code
27068 deny  dnslists = a.b.c
27069      !dnslists = a.b.c=127.0.0.2,127.0.0.3
27070 .endd
27071 However, if you are using multiple lists, the negation syntax is clearer.
27072 Consider this example:
27073 .code
27074 deny  dnslists = sbl.spamhaus.org : \
27075                  list.dsbl.org : \
27076                  dnsbl.njabl.org!=127.0.0.3 : \
27077                  relays.ordb.org
27078 .endd
27079 Using only positive lists, this would have to be:
27080 .code
27081 deny  dnslists = sbl.spamhaus.org : \
27082                  list.dsbl.org
27083 deny  dnslists = dnsbl.njabl.org
27084      !dnslists = dnsbl.njabl.org=127.0.0.3
27085 deny  dnslists = relays.ordb.org
27086 .endd
27087 which is less clear, and harder to maintain.
27088
27089
27090
27091
27092 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
27093 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
27094 thereby providing more than one IP address. When an item in a &%dnslists%& list
27095 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
27096 the match to specific results from the DNS lookup, there are two ways in which
27097 the checking can be handled. For example, consider the condition:
27098 .code
27099 dnslists = a.b.c=127.0.0.1
27100 .endd
27101 What happens if the DNS lookup for the incoming IP address yields both
27102 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
27103 condition true because at least one given value was found, or is it false
27104 because at least one of the found values was not listed? And how does this
27105 affect negated conditions? Both possibilities are provided for with the help of
27106 additional separators &`==`& and &`=&&`&.
27107
27108 .ilist
27109 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
27110 IP addresses matches one of the listed addresses. For the example above, the
27111 condition is true because 127.0.0.1 matches.
27112 .next
27113 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
27114 looked up IP addresses matches one of the listed addresses. If the condition is
27115 changed to:
27116 .code
27117 dnslists = a.b.c==127.0.0.1
27118 .endd
27119 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27120 false because 127.0.0.2 is not listed. You would need to have:
27121 .code
27122 dnslists = a.b.c==127.0.0.1,127.0.0.2
27123 .endd
27124 for the condition to be true.
27125 .endlist
27126
27127 When &`!`& is used to negate IP address matching, it inverts the result, giving
27128 the precise opposite of the behaviour above. Thus:
27129 .ilist
27130 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
27131 addresses matches one of the listed addresses. Consider:
27132 .code
27133 dnslists = a.b.c!&0.0.0.1
27134 .endd
27135 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27136 false because 127.0.0.1 matches.
27137 .next
27138 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
27139 looked up IP address that does not match. Consider:
27140 .code
27141 dnslists = a.b.c!=&0.0.0.1
27142 .endd
27143 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27144 true, because 127.0.0.2 does not match. You would need to have:
27145 .code
27146 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
27147 .endd
27148 for the condition to be false.
27149 .endlist
27150 When the DNS lookup yields only a single IP address, there is no difference
27151 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
27152
27153
27154
27155
27156 .section "Detailed information from merged DNS lists" "SECTmordetinf"
27157 .cindex "DNS list" "information from merged"
27158 When the facility for restricting the matching IP values in a DNS list is used,
27159 the text from the TXT record that is set in &$dnslist_text$& may not reflect
27160 the true reason for rejection. This happens when lists are merged and the IP
27161 address in the A record is used to distinguish them; unfortunately there is
27162 only one TXT record. One way round this is not to use merged lists, but that
27163 can be inefficient because it requires multiple DNS lookups where one would do
27164 in the vast majority of cases when the host of interest is not on any of the
27165 lists.
27166
27167 A less inefficient way of solving this problem is available. If
27168 two domain names, comma-separated, are given, the second is used first to
27169 do an initial check, making use of any IP value restrictions that are set.
27170 If there is a match, the first domain is used, without any IP value
27171 restrictions, to get the TXT record. As a byproduct of this, there is also
27172 a check that the IP being tested is indeed on the first list. The first
27173 domain is the one that is put in &$dnslist_domain$&. For example:
27174 .code
27175 reject message  = \
27176          rejected because $sender_host_address is blacklisted \
27177          at $dnslist_domain\n$dnslist_text
27178        dnslists = \
27179          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
27180          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27181 .endd
27182 For the first blacklist item, this starts by doing a lookup in
27183 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
27184 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
27185 value, and as long as something is found, it looks for the corresponding TXT
27186 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
27187 The second blacklist item is processed similarly.
27188
27189 If you are interested in more than one merged list, the same list must be
27190 given several times, but because the results of the DNS lookups are cached,
27191 the DNS calls themselves are not repeated. For example:
27192 .code
27193 reject dnslists = \
27194          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
27195          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
27196          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
27197          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27198 .endd
27199 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
27200 values matches (or if no record is found), this is the only lookup that is
27201 done. Only if there is a match is one of the more specific lists consulted.
27202
27203
27204
27205 .section "DNS lists and IPv6" "SECTmorednslistslast"
27206 .cindex "IPv6" "DNS black lists"
27207 .cindex "DNS list" "IPv6 usage"
27208 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
27209 nibble by nibble. For example, if the calling host's IP address is
27210 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
27211 .code
27212 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
27213   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
27214 .endd
27215 (split over two lines here to fit on the page). Unfortunately, some of the DNS
27216 lists contain wildcard records, intended for IPv4, that interact badly with
27217 IPv6. For example, the DNS entry
27218 .code
27219 *.3.some.list.example.    A    127.0.0.1
27220 .endd
27221 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
27222 Unfortunately, it also matches the entire 3::/4 IPv6 network.
27223
27224 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
27225 &%condition%& condition, as in this example:
27226 .code
27227 deny   condition = ${if isip4{$sender_host_address}}
27228        dnslists  = some.list.example
27229 .endd
27230
27231 .section "Rate limiting incoming messages" "SECTratelimiting"
27232 .cindex "rate limiting" "client sending"
27233 .cindex "limiting client sending rates"
27234 .oindex "&%smtp_ratelimit_*%&"
27235 The &%ratelimit%& ACL condition can be used to measure and control the rate at
27236 which clients can send email. This is more powerful than the
27237 &%smtp_ratelimit_*%& options, because those options control the rate of
27238 commands in a single SMTP session only, whereas the &%ratelimit%& condition
27239 works across all connections (concurrent and sequential) from the same client
27240 host. The syntax of the &%ratelimit%& condition is:
27241 .display
27242 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
27243 .endd
27244 If the average client sending rate is less than &'m'& messages per time
27245 period &'p'& then the condition is false; otherwise it is true.
27246
27247 As a side-effect, the &%ratelimit%& condition sets the expansion variable
27248 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
27249 configured value of &'m'&, and &$sender_rate_period$& to the configured value
27250 of &'p'&.
27251
27252 The parameter &'p'& is the smoothing time constant, in the form of an Exim
27253 time interval, for example, &`8h`& for eight hours. A larger time constant
27254 means that it takes Exim longer to forget a client's past behaviour. The
27255 parameter &'m'& is the maximum number of messages that a client is permitted to
27256 send in each time interval. It also specifies the number of messages permitted
27257 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
27258 constant, you can allow a client to send more messages in a burst without
27259 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
27260 both small, messages must be sent at an even rate.
27261
27262 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
27263 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
27264 when deploying the &%ratelimit%& ACL condition. The script prints usage
27265 instructions when it is run with no arguments.
27266
27267 The key is used to look up the data for calculating the client's average
27268 sending rate. This data is stored in Exim's spool directory, alongside the
27269 retry and other hints databases. The default key is &$sender_host_address$&,
27270 which means Exim computes the sending rate of each client host IP address.
27271 By changing the key you can change how Exim identifies clients for the purpose
27272 of ratelimiting. For example, to limit the sending rate of each authenticated
27273 user, independent of the computer they are sending from, set the key to
27274 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
27275 example, &$authenticated_id$& is only meaningful if the client has
27276 authenticated (which you can check with the &%authenticated%& ACL condition).
27277
27278 The lookup key does not have to identify clients: If you want to limit the
27279 rate at which a recipient receives messages, you can use the key
27280 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27281 ACL.
27282
27283 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
27284 specifies what Exim measures the rate of, for example messages or recipients
27285 or bytes. You can adjust the measurement using the &%unique=%& and/or
27286 &%count=%& options. You can also control when Exim updates the recorded rate
27287 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
27288 separated by a slash, like the other parameters. They may appear in any order.
27289
27290 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
27291 any options that alter the meaning of the stored data. The limit &'m'& is not
27292 stored, so you can alter the configured maximum rate and Exim will still
27293 remember clients' past behaviour. If you change the &%per_*%& mode or add or
27294 remove the &%unique=%& option, the lookup key changes so Exim will forget past
27295 behaviour. The lookup key is not affected by changes to the update mode and
27296 the &%count=%& option.
27297
27298
27299 .section "Ratelimit options for what is being measured" "ratoptmea"
27300 .cindex "rate limiting" "per_* options"
27301 The &%per_conn%& option limits the client's connection rate. It is not
27302 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
27303 &%acl_not_smtp_start%& ACLs.
27304
27305 The &%per_mail%& option limits the client's rate of sending messages. This is
27306 the default if none of the &%per_*%& options is specified. It can be used in
27307 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
27308 &%acl_smtp_data%&, or &%acl_not_smtp%&.
27309
27310 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
27311 the same ACLs as the &%per_mail%& option, though it is best to use this option
27312 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
27313 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
27314 in its MAIL command, which may be inaccurate or completely missing. You can
27315 follow the limit &'m'& in the configuration with K, M, or G to specify limits
27316 in kilobytes, megabytes, or gigabytes, respectively.
27317
27318 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
27319 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27320 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
27321 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
27322 ACLs the rate is updated with the total recipient count in one go. Note that
27323 in either case the rate limiting engine will see a message with many
27324 recipients as a large high-speed burst.
27325
27326 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
27327 number of different recipients that the client has sent messages to in the
27328 last time period. That is, if the client repeatedly sends messages to the same
27329 recipient, its measured rate is not increased. This option can only be used in
27330 &%acl_smtp_rcpt%&.
27331
27332 The &%per_cmd%& option causes Exim to recompute the rate every time the
27333 condition is processed. This can be used to limit the rate of any SMTP
27334 command. If it is used in multiple ACLs it can limit the aggregate rate of
27335 multiple different commands.
27336
27337 The &%count=%& option can be used to alter how much Exim adds to the client's
27338 measured rate. For example, the &%per_byte%& option is equivalent to
27339 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
27340 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
27341 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
27342
27343 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
27344
27345
27346 .section "Ratelimit update modes" "ratoptupd"
27347 .cindex "rate limiting" "reading data without updating"
27348 You can specify one of three options with the &%ratelimit%& condition to
27349 control when its database is updated. This section describes the &%readonly%&
27350 mode, and the next section describes the &%strict%& and &%leaky%& modes.
27351
27352 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
27353 previously-computed rate to check against the limit.
27354
27355 For example, you can test the client's sending rate and deny it access (when
27356 it is too fast) in the connect ACL. If the client passes this check then it
27357 can go on to send a message, in which case its recorded rate will be updated
27358 in the MAIL ACL. Subsequent connections from the same client will check this
27359 new rate.
27360 .code
27361 acl_check_connect:
27362   deny ratelimit = 100 / 5m / readonly
27363        log_message = RATE CHECK: $sender_rate/$sender_rate_period \
27364                      (max $sender_rate_limit)
27365 # ...
27366 acl_check_mail:
27367   warn ratelimit = 100 / 5m / strict
27368        log_message  = RATE UPDATE: $sender_rate/$sender_rate_period \
27369                       (max $sender_rate_limit)
27370 .endd
27371
27372 If Exim encounters multiple &%ratelimit%& conditions with the same key when
27373 processing a message then it may increase the client's measured rate more than
27374 it should. For example, this will happen if you check the &%per_rcpt%& option
27375 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
27376 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
27377 multiple update problems by using the &%readonly%& option on later ratelimit
27378 checks.
27379
27380 The &%per_*%& options described above do not make sense in some ACLs. If you
27381 use a &%per_*%& option in an ACL where it is not normally permitted then the
27382 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
27383 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
27384 next section) so you must specify the &%readonly%& option explicitly.
27385
27386
27387 .section "Ratelimit options for handling fast clients" "ratoptfast"
27388 .cindex "rate limiting" "strict and leaky modes"
27389 If a client's average rate is greater than the maximum, the rate limiting
27390 engine can react in two possible ways, depending on the presence of the
27391 &%strict%& or &%leaky%& update modes. This is independent of the other
27392 counter-measures (such as rejecting the message) that may be specified by the
27393 rest of the ACL.
27394
27395 The &%leaky%& (default) option means that the client's recorded rate is not
27396 updated if it is above the limit. The effect of this is that Exim measures the
27397 client's average rate of successfully sent email, which cannot be greater than
27398 the maximum allowed. If the client is over the limit it may suffer some
27399 counter-measures (as specified in the ACL), but it will still be able to send
27400 email at the configured maximum rate, whatever the rate of its attempts. This
27401 is generally the better choice if you have clients that retry automatically.
27402 For example, it does not prevent a sender with an over-aggressive retry rate
27403 from getting any email through.
27404
27405 The &%strict%& option means that the client's recorded rate is always
27406 updated. The effect of this is that Exim measures the client's average rate
27407 of attempts to send email, which can be much higher than the maximum it is
27408 actually allowed. If the client is over the limit it may be subjected to
27409 counter-measures by the ACL. It must slow down and allow sufficient time to
27410 pass that its computed rate falls below the maximum before it can send email
27411 again. The time (the number of smoothing periods) it must wait and not
27412 attempt to send mail can be calculated with this formula:
27413 .code
27414         ln(peakrate/maxrate)
27415 .endd
27416
27417
27418 .section "Limiting the rate of different events" "ratoptuniq"
27419 .cindex "rate limiting" "counting unique events"
27420 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
27421 rate of different events. For example, the &%per_addr%& option uses this
27422 mechanism to count the number of different recipients that the client has
27423 sent messages to in the last time period; it is equivalent to
27424 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
27425 measure the rate that a client uses different sender addresses with the
27426 options &`per_mail/unique=$sender_address`&.
27427
27428 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
27429 has seen for that key. The whole set is thrown away when it is older than the
27430 rate smoothing period &'p'&, so each different event is counted at most once
27431 per period. In the &%leaky%& update mode, an event that causes the client to
27432 go over the limit is not added to the set, in the same way that the client's
27433 recorded rate is not updated in the same situation.
27434
27435 When you combine the &%unique=%& and &%readonly%& options, the specific
27436 &%unique=%& value is ignored, and Exim just retrieves the client's stored
27437 rate.
27438
27439 The &%unique=%& mechanism needs more space in the ratelimit database than the
27440 other &%ratelimit%& options in order to store the event set. The number of
27441 unique values is potentially as large as the rate limit, so the extra space
27442 required increases with larger limits.
27443
27444 The uniqueification is not perfect: there is a small probability that Exim
27445 will think a new event has happened before. If the sender's rate is less than
27446 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
27447 the measured rate can go above the limit, in which case Exim may under-count
27448 events by a significant margin. Fortunately, if the rate is high enough (2.7
27449 times the limit) that the false positive rate goes above 9%, then Exim will
27450 throw away the over-full event set before the measured rate falls below the
27451 limit. Therefore the only harm should be that exceptionally high sending rates
27452 are logged incorrectly; any countermeasures you configure will be as effective
27453 as intended.
27454
27455
27456 .section "Using rate limiting" "useratlim"
27457 Exim's other ACL facilities are used to define what counter-measures are taken
27458 when the rate limit is exceeded. This might be anything from logging a warning
27459 (for example, while measuring existing sending rates in order to define
27460 policy), through time delays to slow down fast senders, up to rejecting the
27461 message. For example:
27462 .code
27463 # Log all senders' rates
27464 warn ratelimit = 0 / 1h / strict
27465      log_message = Sender rate $sender_rate / $sender_rate_period
27466
27467 # Slow down fast senders; note the need to truncate $sender_rate
27468 # at the decimal point.
27469 warn ratelimit = 100 / 1h / per_rcpt / strict
27470      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
27471                    $sender_rate_limit }s
27472
27473 # Keep authenticated users under control
27474 deny authenticated = *
27475      ratelimit = 100 / 1d / strict / $authenticated_id
27476
27477 # System-wide rate limit
27478 defer message = Sorry, too busy. Try again later.
27479      ratelimit = 10 / 1s / $primary_hostname
27480
27481 # Restrict incoming rate from each host, with a default
27482 # set using a macro and special cases looked up in a table.
27483 defer message = Sender rate exceeds $sender_rate_limit \
27484                messages per $sender_rate_period
27485      ratelimit = ${lookup {$sender_host_address} \
27486                    cdb {DB/ratelimits.cdb} \
27487                    {$value} {RATELIMIT} }
27488 .endd
27489 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
27490 especially with the &%per_rcpt%& option, you may suffer from a performance
27491 bottleneck caused by locking on the ratelimit hints database. Apart from
27492 making your ACLs less complicated, you can reduce the problem by using a
27493 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
27494 this means that Exim will lose its hints data after a reboot (including retry
27495 hints, the callout cache, and ratelimit data).
27496
27497
27498
27499 .section "Address verification" "SECTaddressverification"
27500 .cindex "verifying address" "options for"
27501 .cindex "policy control" "address verification"
27502 Several of the &%verify%& conditions described in section
27503 &<<SECTaclconditions>>& cause addresses to be verified. Section
27504 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
27505 The verification conditions can be followed by options that modify the
27506 verification process. The options are separated from the keyword and from each
27507 other by slashes, and some of them contain parameters. For example:
27508 .code
27509 verify = sender/callout
27510 verify = recipient/defer_ok/callout=10s,defer_ok
27511 .endd
27512 The first stage of address verification, which always happens, is to run the
27513 address through the routers, in &"verify mode"&. Routers can detect the
27514 difference between verification and routing for delivery, and their actions can
27515 be varied by a number of generic options such as &%verify%& and &%verify_only%&
27516 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
27517 The available options are as follows:
27518
27519 .ilist
27520 If the &%callout%& option is specified, successful routing to one or more
27521 remote hosts is followed by a &"callout"& to those hosts as an additional
27522 check. Callouts and their sub-options are discussed in the next section.
27523 .next
27524 If there is a defer error while doing verification routing, the ACL
27525 normally returns &"defer"&. However, if you include &%defer_ok%& in the
27526 options, the condition is forced to be true instead. Note that this is a main
27527 verification option as well as a suboption for callouts.
27528 .next
27529 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
27530 discusses the reporting of sender address verification failures.
27531 .next
27532 The &%success_on_redirect%& option causes verification always to succeed
27533 immediately after a successful redirection. By default, if a redirection
27534 generates just one address, that address is also verified. See further
27535 discussion in section &<<SECTredirwhilveri>>&.
27536 .endlist
27537
27538 .cindex "verifying address" "differentiating failures"
27539 .vindex "&$recipient_verify_failure$&"
27540 .vindex "&$sender_verify_failure$&"
27541 .vindex "&$acl_verify_message$&"
27542 After an address verification failure, &$acl_verify_message$& contains the
27543 error message that is associated with the failure. It can be preserved by
27544 coding like this:
27545 .code
27546 warn  !verify = sender
27547        set acl_m0 = $acl_verify_message
27548 .endd
27549 If you are writing your own custom rejection message or log message when
27550 denying access, you can use this variable to include information about the
27551 verification failure.
27552
27553 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
27554 appropriate) contains one of the following words:
27555
27556 .ilist
27557 &%qualify%&: The address was unqualified (no domain), and the message
27558 was neither local nor came from an exempted host.
27559 .next
27560 &%route%&: Routing failed.
27561 .next
27562 &%mail%&: Routing succeeded, and a callout was attempted; rejection
27563 occurred at or before the MAIL command (that is, on initial
27564 connection, HELO, or MAIL).
27565 .next
27566 &%recipient%&: The RCPT command in a callout was rejected.
27567 .next
27568 &%postmaster%&: The postmaster check in a callout was rejected.
27569 .endlist
27570
27571 The main use of these variables is expected to be to distinguish between
27572 rejections of MAIL and rejections of RCPT in callouts.
27573
27574
27575
27576
27577 .section "Callout verification" "SECTcallver"
27578 .cindex "verifying address" "by callout"
27579 .cindex "callout" "verification"
27580 .cindex "SMTP" "callout verification"
27581 For non-local addresses, routing verifies the domain, but is unable to do any
27582 checking of the local part. There are situations where some means of verifying
27583 the local part is desirable. One way this can be done is to make an SMTP
27584 &'callback'& to a delivery host for the sender address or a &'callforward'& to
27585 a subsequent host for a recipient address, to see if the host accepts the
27586 address. We use the term &'callout'& to cover both cases. Note that for a
27587 sender address, the callback is not to the client host that is trying to
27588 deliver the message, but to one of the hosts that accepts incoming mail for the
27589 sender's domain.
27590
27591 Exim does not do callouts by default. If you want them to happen, you must
27592 request them by setting appropriate options on the &%verify%& condition, as
27593 described below. This facility should be used with care, because it can add a
27594 lot of resource usage to the cost of verifying an address. However, Exim does
27595 cache the results of callouts, which helps to reduce the cost. Details of
27596 caching are in section &<<SECTcallvercache>>&.
27597
27598 Recipient callouts are usually used only between hosts that are controlled by
27599 the same administration. For example, a corporate gateway host could use
27600 callouts to check for valid recipients on an internal mailserver. A successful
27601 callout does not guarantee that a real delivery to the address would succeed;
27602 on the other hand, a failing callout does guarantee that a delivery would fail.
27603
27604 If the &%callout%& option is present on a condition that verifies an address, a
27605 second stage of verification occurs if the address is successfully routed to
27606 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
27607 &(manualroute)& router, where the router specifies the hosts. However, if a
27608 router that does not set up hosts routes to an &(smtp)& transport with a
27609 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
27610 &%hosts_override%& set, its hosts are always used, whether or not the router
27611 supplies a host list.
27612
27613 The port that is used is taken from the transport, if it is specified and is a
27614 remote transport. (For routers that do verification only, no transport need be
27615 specified.) Otherwise, the default SMTP port is used. If a remote transport
27616 specifies an outgoing interface, this is used; otherwise the interface is not
27617 specified. Likewise, the text that is used for the HELO command is taken from
27618 the transport's &%helo_data%& option; if there is no transport, the value of
27619 &$smtp_active_hostname$& is used.
27620
27621 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
27622 test whether a bounce message could be delivered to the sender address. The
27623 following SMTP commands are sent:
27624 .display
27625 &`HELO `&<&'local host name'&>
27626 &`MAIL FROM:<>`&
27627 &`RCPT TO:`&<&'the address to be tested'&>
27628 &`QUIT`&
27629 .endd
27630 LHLO is used instead of HELO if the transport's &%protocol%& option is
27631 set to &"lmtp"&.
27632
27633 A recipient callout check is similar. By default, it also uses an empty address
27634 for the sender. This default is chosen because most hosts do not make use of
27635 the sender address when verifying a recipient. Using the same address means
27636 that a single cache entry can be used for each recipient. Some sites, however,
27637 do make use of the sender address when verifying. These are catered for by the
27638 &%use_sender%& and &%use_postmaster%& options, described in the next section.
27639
27640 If the response to the RCPT command is a 2&'xx'& code, the verification
27641 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
27642 Exim tries the next host, if any. If there is a problem with all the remote
27643 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
27644 &%callout%& option is given, in which case the condition is forced to succeed.
27645
27646 .cindex "SMTP" "output flushing, disabling for callout"
27647 A callout may take a little time. For this reason, Exim normally flushes SMTP
27648 output before performing a callout in an ACL, to avoid unexpected timeouts in
27649 clients when the SMTP PIPELINING extension is in use. The flushing can be
27650 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
27651
27652
27653
27654
27655 .section "Additional parameters for callouts" "CALLaddparcall"
27656 .cindex "callout" "additional parameters for"
27657 The &%callout%& option can be followed by an equals sign and a number of
27658 optional parameters, separated by commas. For example:
27659 .code
27660 verify = recipient/callout=10s,defer_ok
27661 .endd
27662 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
27663 separate verify options, is retained for backwards compatibility, but is now
27664 deprecated. The additional parameters for &%callout%& are as follows:
27665
27666
27667 .vlist
27668 .vitem <&'a&~time&~interval'&>
27669 .cindex "callout" "timeout, specifying"
27670 This specifies the timeout that applies for the callout attempt to each host.
27671 For example:
27672 .code
27673 verify = sender/callout=5s
27674 .endd
27675 The default is 30 seconds. The timeout is used for each response from the
27676 remote host. It is also used for the initial connection, unless overridden by
27677 the &%connect%& parameter.
27678
27679
27680 .vitem &*connect&~=&~*&<&'time&~interval'&>
27681 .cindex "callout" "connection timeout, specifying"
27682 This parameter makes it possible to set a different (usually smaller) timeout
27683 for making the SMTP connection. For example:
27684 .code
27685 verify = sender/callout=5s,connect=1s
27686 .endd
27687 If not specified, this timeout defaults to the general timeout value.
27688
27689 .vitem &*defer_ok*&
27690 .cindex "callout" "defer, action on"
27691 When this parameter is present, failure to contact any host, or any other kind
27692 of temporary error, is treated as success by the ACL. However, the cache is not
27693 updated in this circumstance.
27694
27695 .vitem &*fullpostmaster*&
27696 .cindex "callout" "full postmaster check"
27697 This operates like the &%postmaster%& option (see below), but if the check for
27698 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
27699 accordance with the specification in RFC 2821. The RFC states that the
27700 unqualified address &'postmaster'& should be accepted.
27701
27702
27703 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
27704 .cindex "callout" "sender when verifying header"
27705 When verifying addresses in header lines using the &%header_sender%&
27706 verification option, Exim behaves by default as if the addresses are envelope
27707 sender addresses from a message. Callout verification therefore tests to see
27708 whether a bounce message could be delivered, by using an empty address in the
27709 MAIL command. However, it is arguable that these addresses might never be used
27710 as envelope senders, and could therefore justifiably reject bounce messages
27711 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
27712 address to use in the MAIL command. For example:
27713 .code
27714 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
27715 .endd
27716 This parameter is available only for the &%header_sender%& verification option.
27717
27718
27719 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
27720 .cindex "callout" "overall timeout, specifying"
27721 This parameter sets an overall timeout for performing a callout verification.
27722 For example:
27723 .code
27724 verify = sender/callout=5s,maxwait=30s
27725 .endd
27726 This timeout defaults to four times the callout timeout for individual SMTP
27727 commands. The overall timeout applies when there is more than one host that can
27728 be tried. The timeout is checked before trying the next host. This prevents
27729 very long delays if there are a large number of hosts and all are timing out
27730 (for example, when network connections are timing out).
27731
27732
27733 .vitem &*no_cache*&
27734 .cindex "callout" "cache, suppressing"
27735 .cindex "caching callout, suppressing"
27736 When this parameter is given, the callout cache is neither read nor updated.
27737
27738 .vitem &*postmaster*&
27739 .cindex "callout" "postmaster; checking"
27740 When this parameter is set, a successful callout check is followed by a similar
27741 check for the local part &'postmaster'& at the same domain. If this address is
27742 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
27743 the postmaster check is recorded in a cache record; if it is a failure, this is
27744 used to fail subsequent callouts for the domain without a connection being
27745 made, until the cache record expires.
27746
27747 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
27748 The postmaster check uses an empty sender in the MAIL command by default.
27749 You can use this parameter to do a postmaster check using a different address.
27750 For example:
27751 .code
27752 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
27753 .endd
27754 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
27755 one overrides. The &%postmaster%& parameter is equivalent to this example:
27756 .code
27757 require  verify = sender/callout=postmaster_mailfrom=
27758 .endd
27759 &*Warning*&: The caching arrangements for postmaster checking do not take
27760 account of the sender address. It is assumed that either the empty address or
27761 a fixed non-empty address will be used. All that Exim remembers is that the
27762 postmaster check for the domain succeeded or failed.
27763
27764
27765 .vitem &*random*&
27766 .cindex "callout" "&""random""& check"
27767 When this parameter is set, before doing the normal callout check, Exim does a
27768 check for a &"random"& local part at the same domain. The local part is not
27769 really random &-- it is defined by the expansion of the option
27770 &%callout_random_local_part%&, which defaults to
27771 .code
27772 $primary_host_name-$tod_epoch-testing
27773 .endd
27774 The idea here is to try to determine whether the remote host accepts all local
27775 parts without checking. If it does, there is no point in doing callouts for
27776 specific local parts. If the &"random"& check succeeds, the result is saved in
27777 a cache record, and used to force the current and subsequent callout checks to
27778 succeed without a connection being made, until the cache record expires.
27779
27780 .vitem &*use_postmaster*&
27781 .cindex "callout" "sender for recipient check"
27782 This parameter applies to recipient callouts only. For example:
27783 .code
27784 deny  !verify = recipient/callout=use_postmaster
27785 .endd
27786 .vindex "&$qualify_domain$&"
27787 It causes a non-empty postmaster address to be used in the MAIL command when
27788 performing the callout for the recipient, and also for a &"random"& check if
27789 that is configured. The local part of the address is &`postmaster`& and the
27790 domain is the contents of &$qualify_domain$&.
27791
27792 .vitem &*use_sender*&
27793 This option applies to recipient callouts only. For example:
27794 .code
27795 require  verify = recipient/callout=use_sender
27796 .endd
27797 It causes the message's actual sender address to be used in the MAIL
27798 command when performing the callout, instead of an empty address. There is no
27799 need to use this option unless you know that the called hosts make use of the
27800 sender when checking recipients. If used indiscriminately, it reduces the
27801 usefulness of callout caching.
27802 .endlist
27803
27804 If you use any of the parameters that set a non-empty sender for the MAIL
27805 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
27806 &%use_sender%&), you should think about possible loops. Recipient checking is
27807 usually done between two hosts that are under the same management, and the host
27808 that receives the callouts is not normally configured to do callouts itself.
27809 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
27810 these circumstances.
27811
27812 However, if you use a non-empty sender address for a callout to an arbitrary
27813 host, there is the likelihood that the remote host will itself initiate a
27814 callout check back to your host. As it is checking what appears to be a message
27815 sender, it is likely to use an empty address in MAIL, thus avoiding a
27816 callout loop. However, to be on the safe side it would be best to set up your
27817 own ACLs so that they do not do sender verification checks when the recipient
27818 is the address you use for header sender or postmaster callout checking.
27819
27820 Another issue to think about when using non-empty senders for callouts is
27821 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
27822 by the sender/recipient combination; thus, for any given recipient, many more
27823 actual callouts are performed than when an empty sender or postmaster is used.
27824
27825
27826
27827
27828 .section "Callout caching" "SECTcallvercache"
27829 .cindex "hints database" "callout cache"
27830 .cindex "callout" "cache, description of"
27831 .cindex "caching" "callout"
27832 Exim caches the results of callouts in order to reduce the amount of resources
27833 used, unless you specify the &%no_cache%& parameter with the &%callout%&
27834 option. A hints database called &"callout"& is used for the cache. Two
27835 different record types are used: one records the result of a callout check for
27836 a specific address, and the other records information that applies to the
27837 entire domain (for example, that it accepts the local part &'postmaster'&).
27838
27839 When an original callout fails, a detailed SMTP error message is given about
27840 the failure. However, for subsequent failures use the cache data, this message
27841 is not available.
27842
27843 The expiry times for negative and positive address cache records are
27844 independent, and can be set by the global options &%callout_negative_expire%&
27845 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
27846
27847 If a host gives a negative response to an SMTP connection, or rejects any
27848 commands up to and including
27849 .code
27850 MAIL FROM:<>
27851 .endd
27852 (but not including the MAIL command with a non-empty address),
27853 any callout attempt is bound to fail. Exim remembers such failures in a
27854 domain cache record, which it uses to fail callouts for the domain without
27855 making new connections, until the domain record times out. There are two
27856 separate expiry times for domain cache records:
27857 &%callout_domain_negative_expire%& (default 3h) and
27858 &%callout_domain_positive_expire%& (default 7d).
27859
27860 Domain records expire when the negative expiry time is reached if callouts
27861 cannot be made for the domain, or if the postmaster check failed.
27862 Otherwise, they expire when the positive expiry time is reached. This
27863 ensures that, for example, a host that stops accepting &"random"& local parts
27864 will eventually be noticed.
27865
27866 The callout caching mechanism is based on the domain of the address that is
27867 being tested. If the domain routes to several hosts, it is assumed that their
27868 behaviour will be the same.
27869
27870
27871
27872 .section "Sender address verification reporting" "SECTsenaddver"
27873 .cindex "verifying" "suppressing error details"
27874 See section &<<SECTaddressverification>>& for a general discussion of
27875 verification. When sender verification fails in an ACL, the details of the
27876 failure are given as additional output lines before the 550 response to the
27877 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
27878 you might see:
27879 .code
27880 MAIL FROM:<xyz@abc.example>
27881 250 OK
27882 RCPT TO:<pqr@def.example>
27883 550-Verification failed for <xyz@abc.example>
27884 550-Called:   192.168.34.43
27885 550-Sent:     RCPT TO:<xyz@abc.example>
27886 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
27887 550 Sender verification failed
27888 .endd
27889 If more than one RCPT command fails in the same way, the details are given
27890 only for the first of them. However, some administrators do not want to send
27891 out this much information. You can suppress the details by adding
27892 &`/no_details`& to the ACL statement that requests sender verification. For
27893 example:
27894 .code
27895 verify = sender/no_details
27896 .endd
27897
27898 .section "Redirection while verifying" "SECTredirwhilveri"
27899 .cindex "verifying" "redirection while"
27900 .cindex "address redirection" "while verifying"
27901 A dilemma arises when a local address is redirected by aliasing or forwarding
27902 during verification: should the generated addresses themselves be verified,
27903 or should the successful expansion of the original address be enough to verify
27904 it? By default, Exim takes the following pragmatic approach:
27905
27906 .ilist
27907 When an incoming address is redirected to just one child address, verification
27908 continues with the child address, and if that fails to verify, the original
27909 verification also fails.
27910 .next
27911 When an incoming address is redirected to more than one child address,
27912 verification does not continue. A success result is returned.
27913 .endlist
27914
27915 This seems the most reasonable behaviour for the common use of aliasing as a
27916 way of redirecting different local parts to the same mailbox. It means, for
27917 example, that a pair of alias entries of the form
27918 .code
27919 A.Wol:   aw123
27920 aw123:   :fail: Gone away, no forwarding address
27921 .endd
27922 work as expected, with both local parts causing verification failure. When a
27923 redirection generates more than one address, the behaviour is more like a
27924 mailing list, where the existence of the alias itself is sufficient for
27925 verification to succeed.
27926
27927 It is possible, however, to change the default behaviour so that all successful
27928 redirections count as successful verifications, however many new addresses are
27929 generated. This is specified by the &%success_on_redirect%& verification
27930 option. For example:
27931 .code
27932 require verify = recipient/success_on_redirect/callout=10s
27933 .endd
27934 In this example, verification succeeds if a router generates a new address, and
27935 the callout does not occur, because no address was routed to a remote host.
27936
27937 When verification is being tested via the &%-bv%& option, the treatment of
27938 redirections is as just described, unless the &%-v%& or any debugging option is
27939 also specified. In that case, full verification is done for every generated
27940 address and a report is output for each of them.
27941
27942
27943
27944 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
27945 .cindex "CSA" "verifying"
27946 Client SMTP Authorization is a system that allows a site to advertise
27947 which machines are and are not permitted to send email. This is done by placing
27948 special SRV records in the DNS; these are looked up using the client's HELO
27949 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
27950 Authorization checks in Exim are performed by the ACL condition:
27951 .code
27952 verify = csa
27953 .endd
27954 This fails if the client is not authorized. If there is a DNS problem, or if no
27955 valid CSA SRV record is found, or if the client is authorized, the condition
27956 succeeds. These three cases can be distinguished using the expansion variable
27957 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
27958 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
27959 be likely to cause problems for legitimate email.
27960
27961 The error messages produced by the CSA code include slightly more
27962 detail. If &$csa_status$& is &"defer"&, this may be because of problems
27963 looking up the CSA SRV record, or problems looking up the CSA target
27964 address record. There are four reasons for &$csa_status$& being &"fail"&:
27965
27966 .ilist
27967 The client's host name is explicitly not authorized.
27968 .next
27969 The client's IP address does not match any of the CSA target IP addresses.
27970 .next
27971 The client's host name is authorized but it has no valid target IP addresses
27972 (for example, the target's addresses are IPv6 and the client is using IPv4).
27973 .next
27974 The client's host name has no CSA SRV record but a parent domain has asserted
27975 that all subdomains must be explicitly authorized.
27976 .endlist
27977
27978 The &%csa%& verification condition can take an argument which is the domain to
27979 use for the DNS query. The default is:
27980 .code
27981 verify = csa/$sender_helo_name
27982 .endd
27983 This implementation includes an extension to CSA. If the query domain
27984 is an address literal such as [192.0.2.95], or if it is a bare IP
27985 address, Exim searches for CSA SRV records in the reverse DNS as if
27986 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
27987 meaningful to say:
27988 .code
27989 verify = csa/$sender_host_address
27990 .endd
27991 In fact, this is the check that Exim performs if the client does not say HELO.
27992 This extension can be turned off by setting the main configuration option
27993 &%dns_csa_use_reverse%& to be false.
27994
27995 If a CSA SRV record is not found for the domain itself, a search
27996 is performed through its parent domains for a record which might be
27997 making assertions about subdomains. The maximum depth of this search is limited
27998 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
27999 default. Exim does not look for CSA SRV records in a top level domain, so the
28000 default settings handle HELO domains as long as seven
28001 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
28002 of legitimate HELO domains.
28003
28004 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
28005 direct SRV lookups, this is not sufficient because of the extra parent domain
28006 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
28007 addresses into lookups in the reverse DNS space. The result of a successful
28008 lookup such as:
28009 .code
28010 ${lookup dnsdb {csa=$sender_helo_name}}
28011 .endd
28012 has two space-separated fields: an authorization code and a target host name.
28013 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
28014 authorization required but absent, or &"?"& for unknown.
28015
28016
28017
28018
28019 .section "Bounce address tag validation" "SECTverifyPRVS"
28020 .cindex "BATV, verifying"
28021 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
28022 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
28023 Genuine incoming bounce messages should therefore always be addressed to
28024 recipients that have a valid tag. This scheme is a way of detecting unwanted
28025 bounce messages caused by sender address forgeries (often called &"collateral
28026 spam"&), because the recipients of such messages do not include valid tags.
28027
28028 There are two expansion items to help with the implementation of the BATV
28029 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
28030 the original envelope sender address by using a simple key to add a hash of the
28031 address and some time-based randomizing information. The &%prvs%& expansion
28032 item creates a signed address, and the &%prvscheck%& expansion item checks one.
28033 The syntax of these expansion items is described in section
28034 &<<SECTexpansionitems>>&.
28035
28036 As an example, suppose the secret per-address keys are stored in an MySQL
28037 database. A query to look up the key for an address could be defined as a macro
28038 like this:
28039 .code
28040 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
28041                 WHERE sender='${quote_mysql:$prvscheck_address}'\
28042                 }{$value}}
28043 .endd
28044 Suppose also that the senders who make use of BATV are defined by an address
28045 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
28046 use this:
28047 .code
28048 # Bounces: drop unsigned addresses for BATV senders
28049 deny message = This address does not send an unsigned reverse path
28050      senders = :
28051      recipients = +batv_senders
28052
28053 # Bounces: In case of prvs-signed address, check signature.
28054 deny message = Invalid reverse path signature.
28055      senders = :
28056      condition  = ${prvscheck {$local_part@$domain}\
28057                   {PRVSCHECK_SQL}{1}}
28058      !condition = $prvscheck_result
28059 .endd
28060 The first statement rejects recipients for bounce messages that are addressed
28061 to plain BATV sender addresses, because it is known that BATV senders do not
28062 send out messages with plain sender addresses. The second statement rejects
28063 recipients that are prvs-signed, but with invalid signatures (either because
28064 the key is wrong, or the signature has timed out).
28065
28066 A non-prvs-signed address is not rejected by the second statement, because the
28067 &%prvscheck%& expansion yields an empty string if its first argument is not a
28068 prvs-signed address, thus causing the &%condition%& condition to be false. If
28069 the first argument is a syntactically valid prvs-signed address, the yield is
28070 the third string (in this case &"1"&), whether or not the cryptographic and
28071 timeout checks succeed. The &$prvscheck_result$& variable contains the result
28072 of the checks (empty for failure, &"1"& for success).
28073
28074 There is one more issue you must consider when implementing prvs-signing:
28075 you have to ensure that the routers accept prvs-signed addresses and
28076 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
28077 router to remove the signature with a configuration along these lines:
28078 .code
28079 batv_redirect:
28080   driver = redirect
28081   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
28082 .endd
28083 This works because, if the third argument of &%prvscheck%& is empty, the result
28084 of the expansion of a prvs-signed address is the decoded value of the original
28085 address. This router should probably be the first of your routers that handles
28086 local addresses.
28087
28088 To create BATV-signed addresses in the first place, a transport of this form
28089 can be used:
28090 .code
28091 external_smtp_batv:
28092   driver = smtp
28093   return_path = ${prvs {$return_path} \
28094                        {${lookup mysql{SELECT \
28095                        secret FROM batv_prvs WHERE \
28096                        sender='${quote_mysql:$sender_address}'} \
28097                        {$value}fail}}}
28098 .endd
28099 If no key can be found for the existing return path, no signing takes place.
28100
28101
28102
28103 .section "Using an ACL to control relaying" "SECTrelaycontrol"
28104 .cindex "&ACL;" "relay control"
28105 .cindex "relaying" "control by ACL"
28106 .cindex "policy control" "relay control"
28107 An MTA is said to &'relay'& a message if it receives it from some host and
28108 delivers it directly to another host as a result of a remote address contained
28109 within it. Redirecting a local address via an alias or forward file and then
28110 passing the message on to another host is not relaying,
28111 .cindex "&""percent hack""&"
28112 but a redirection as a result of the &"percent hack"& is.
28113
28114 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
28115 A host which is acting as a gateway or an MX backup is concerned with incoming
28116 relaying from arbitrary hosts to a specific set of domains. On the other hand,
28117 a host which is acting as a smart host for a number of clients is concerned
28118 with outgoing relaying from those clients to the Internet at large. Often the
28119 same host is fulfilling both functions,
28120 . ///
28121 . as illustrated in the diagram below,
28122 . ///
28123 but in principle these two kinds of relaying are entirely independent. What is
28124 not wanted is the transmission of mail from arbitrary remote hosts through your
28125 system to arbitrary domains.
28126
28127
28128 You can implement relay control by means of suitable statements in the ACL that
28129 runs for each RCPT command. For convenience, it is often easiest to use
28130 Exim's named list facility to define the domains and hosts involved. For
28131 example, suppose you want to do the following:
28132
28133 .ilist
28134 Deliver a number of domains to mailboxes on the local host (or process them
28135 locally in some other way). Let's say these are &'my.dom1.example'& and
28136 &'my.dom2.example'&.
28137 .next
28138 Relay mail for a number of other domains for which you are the secondary MX.
28139 These might be &'friend1.example'& and &'friend2.example'&.
28140 .next
28141 Relay mail from the hosts on your local LAN, to whatever domains are involved.
28142 Suppose your LAN is 192.168.45.0/24.
28143 .endlist
28144
28145
28146 In the main part of the configuration, you put the following definitions:
28147 .code
28148 domainlist local_domains = my.dom1.example : my.dom2.example
28149 domainlist relay_domains = friend1.example : friend2.example
28150 hostlist   relay_hosts   = 192.168.45.0/24
28151 .endd
28152 Now you can use these definitions in the ACL that is run for every RCPT
28153 command:
28154 .code
28155 acl_check_rcpt:
28156   accept domains = +local_domains : +relay_domains
28157   accept hosts   = +relay_hosts
28158 .endd
28159 The first statement accepts any RCPT command that contains an address in
28160 the local or relay domains. For any other domain, control passes to the second
28161 statement, which accepts the command only if it comes from one of the relay
28162 hosts. In practice, you will probably want to make your ACL more sophisticated
28163 than this, for example, by including sender and recipient verification. The
28164 default configuration includes a more comprehensive example, which is described
28165 in chapter &<<CHAPdefconfil>>&.
28166
28167
28168
28169 .section "Checking a relay configuration" "SECTcheralcon"
28170 .cindex "relaying" "checking control of"
28171 You can check the relay characteristics of your configuration in the same way
28172 that you can test any ACL behaviour for an incoming SMTP connection, by using
28173 the &%-bh%& option to run a fake SMTP session with which you interact.
28174
28175 For specifically testing for unwanted relaying, the host
28176 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
28177 host from the host on which Exim is running, using the normal telnet port, you
28178 will see a normal telnet connection message and then quite a long delay. Be
28179 patient. The remote host is making an SMTP connection back to your host, and
28180 trying a number of common probes to test for open relay vulnerability. The
28181 results of the tests will eventually appear on your terminal.
28182 .ecindex IIDacl
28183
28184
28185
28186 . ////////////////////////////////////////////////////////////////////////////
28187 . ////////////////////////////////////////////////////////////////////////////
28188
28189 .chapter "Content scanning at ACL time" "CHAPexiscan"
28190 .scindex IIDcosca "content scanning" "at ACL time"
28191 The extension of Exim to include content scanning at ACL time, formerly known
28192 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
28193 was integrated into the main source for Exim release 4.50, and Tom continues to
28194 maintain it. Most of the wording of this chapter is taken from Tom's
28195 specification.
28196
28197 It is also possible to scan the content of messages at other times. The
28198 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
28199 scanning after all the ACLs have run. A transport filter can be used to scan
28200 messages at delivery time (see the &%transport_filter%& option, described in
28201 chapter &<<CHAPtransportgeneric>>&).
28202
28203 If you want to include the ACL-time content-scanning features when you compile
28204 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
28205 &_Local/Makefile_&. When you do that, the Exim binary is built with:
28206
28207 .ilist
28208 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
28209 for all MIME parts for SMTP and non-SMTP messages, respectively.
28210 .next
28211 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
28212 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
28213 run at the end of message reception (the &%acl_smtp_data%& ACL).
28214 .next
28215 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
28216 of messages, or parts of messages, for debugging purposes.
28217 .next
28218 Additional expansion variables that are set in the new ACL and by the new
28219 conditions.
28220 .next
28221 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
28222 .endlist
28223
28224 There is another content-scanning configuration option for &_Local/Makefile_&,
28225 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
28226 condition is compiled, in addition to all the other content-scanning features.
28227
28228 Content-scanning is continually evolving, and new features are still being
28229 added. While such features are still unstable and liable to incompatible
28230 changes, they are made available in Exim by setting options whose names begin
28231 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
28232 this manual. You can find out about them by reading the file called
28233 &_doc/experimental.txt_&.
28234
28235 All the content-scanning facilities work on a MBOX copy of the message that is
28236 temporarily created in a file called:
28237 .display
28238 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
28239 .endd
28240 The &_.eml_& extension is a friendly hint to virus scanners that they can
28241 expect an MBOX-like structure inside that file. The file is created when the
28242 first content scanning facility is called. Subsequent calls to content
28243 scanning conditions open the same file again. The directory is recursively
28244 removed when the &%acl_smtp_data%& ACL has finished running, unless
28245 .code
28246 control = no_mbox_unspool
28247 .endd
28248 has been encountered. When the MIME ACL decodes files, they are put into the
28249 same directory by default.
28250
28251
28252
28253 .section "Scanning for viruses" "SECTscanvirus"
28254 .cindex "virus scanning"
28255 .cindex "content scanning" "for viruses"
28256 .cindex "content scanning" "the &%malware%& condition"
28257 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
28258 It supports a &"generic"& interface to scanners called via the shell, and
28259 specialized interfaces for &"daemon"& type virus scanners, which are resident
28260 in memory and thus are much faster.
28261
28262
28263 .oindex "&%av_scanner%&"
28264 You can set the &%av_scanner%& option in first part of the Exim configuration
28265 file to specify which scanner to use, together with any additional options that
28266 are needed. The basic syntax is as follows:
28267 .display
28268 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
28269 .endd
28270 If you do not set &%av_scanner%&, it defaults to
28271 .code
28272 av_scanner = sophie:/var/run/sophie
28273 .endd
28274 If the value of &%av_scanner%& starts with a dollar character, it is expanded
28275 before use. The following scanner types are supported in this release:
28276
28277 .vlist
28278 .vitem &%aveserver%&
28279 .cindex "virus scanners" "Kaspersky"
28280 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
28281 at &url(http://www.kaspersky.com). This scanner type takes one option,
28282 which is the path to the daemon's UNIX socket. The default is shown in this
28283 example:
28284 .code
28285 av_scanner = aveserver:/var/run/aveserver
28286 .endd
28287
28288
28289 .vitem &%clamd%&
28290 .cindex "virus scanners" "clamd"
28291 This daemon-type scanner is GPL and free. You can get it at
28292 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
28293 unpack MIME containers, so it used to be recommended to unpack MIME attachments
28294 in the MIME ACL. This no longer believed to be necessary. One option is
28295 required: either the path and name of a UNIX socket file, or a hostname or IP
28296 number, and a port, separated by space, as in the second of these examples:
28297 .code
28298 av_scanner = clamd:/opt/clamd/socket
28299 av_scanner = clamd:192.0.2.3 1234
28300 av_scanner = clamd:192.0.2.3 1234:local
28301 .endd
28302 If the value of av_scanner points to a UNIX socket file or contains the local
28303 keyword, then the ClamAV interface will pass a filename containing the data
28304 to be scanned, which will should normally result in less I/O happening and be
28305 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
28306 Exim does not assume that there is a common filesystem with the remote host.
28307 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
28308 you be running a version of ClamAV prior to 0.95.
28309 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
28310 contributing the code for this scanner.
28311
28312 .vitem &%cmdline%&
28313 .cindex "virus scanners" "command line interface"
28314 This is the keyword for the generic command line scanner interface. It can be
28315 used to attach virus scanners that are invoked from the shell. This scanner
28316 type takes 3 mandatory options:
28317
28318 .olist
28319 The full path and name of the scanner binary, with all command line options,
28320 and a placeholder (&`%s`&) for the directory to scan.
28321
28322 .next
28323 A regular expression to match against the STDOUT and STDERR output of the
28324 virus scanner. If the expression matches, a virus was found. You must make
28325 absolutely sure that this expression matches on &"virus found"&. This is called
28326 the &"trigger"& expression.
28327
28328 .next
28329 Another regular expression, containing exactly one pair of parentheses, to
28330 match the name of the virus found in the scanners output. This is called the
28331 &"name"& expression.
28332 .endlist olist
28333
28334 For example, Sophos Sweep reports a virus on a line like this:
28335 .code
28336 Virus 'W32/Magistr-B' found in file ./those.bat
28337 .endd
28338 For the trigger expression, we can match the phrase &"found in file"&. For the
28339 name expression, we want to extract the W32/Magistr-B string, so we can match
28340 for the single quotes left and right of it. Altogether, this makes the
28341 configuration setting:
28342 .code
28343 av_scanner = cmdline:\
28344              /path/to/sweep -ss -all -rec -archive %s:\
28345              found in file:'(.+)'
28346 .endd
28347 .vitem &%drweb%&
28348 .cindex "virus scanners" "DrWeb"
28349 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
28350 argument, either a full path to a UNIX socket, or an IP address and port
28351 separated by white space, as in these examples:
28352 .code
28353 av_scanner = drweb:/var/run/drwebd.sock
28354 av_scanner = drweb:192.168.2.20 31337
28355 .endd
28356 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
28357 is used. Thanks to Alex Miller for contributing the code for this scanner.
28358
28359 .vitem &%fsecure%&
28360 .cindex "virus scanners" "F-Secure"
28361 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
28362 argument which is the path to a UNIX socket. For example:
28363 .code
28364 av_scanner = fsecure:/path/to/.fsav
28365 .endd
28366 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
28367 Thelmen for contributing the code for this scanner.
28368
28369 .vitem &%kavdaemon%&
28370 .cindex "virus scanners" "Kaspersky"
28371 This is the scanner daemon of Kaspersky Version 4. This version of the
28372 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
28373 scanner type takes one option, which is the path to the daemon's UNIX socket.
28374 For example:
28375 .code
28376 av_scanner = kavdaemon:/opt/AVP/AvpCtl
28377 .endd
28378 The default path is &_/var/run/AvpCtl_&.
28379
28380 .vitem &%mksd%&
28381 .cindex "virus scanners" "mksd"
28382 This is a daemon type scanner that is aimed mainly at Polish users, though some
28383 parts of documentation are now available in English. You can get it at
28384 &url(http://linux.mks.com.pl/). The only option for this scanner type is
28385 the maximum number of processes used simultaneously to scan the attachments,
28386 provided that the demime facility is employed and also provided that mksd has
28387 been run with at least the same number of child processes. For example:
28388 .code
28389 av_scanner = mksd:2
28390 .endd
28391 You can safely omit this option (the default value is 1).
28392
28393 .vitem &%sophie%&
28394 .cindex "virus scanners" "Sophos and Sophie"
28395 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
28396 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
28397 for this scanner type is the path to the UNIX socket that Sophie uses for
28398 client communication. For example:
28399 .code
28400 av_scanner = sophie:/tmp/sophie
28401 .endd
28402 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
28403 the option.
28404 .endlist
28405
28406 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
28407 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
28408 ACL.
28409
28410 The &%av_scanner%& option is expanded each time &%malware%& is called. This
28411 makes it possible to use different scanners. See further below for an example.
28412 The &%malware%& condition caches its results, so when you use it multiple times
28413 for the same message, the actual scanning process is only carried out once.
28414 However, using expandable items in &%av_scanner%& disables this caching, in
28415 which case each use of the &%malware%& condition causes a new scan of the
28416 message.
28417
28418 The &%malware%& condition takes a right-hand argument that is expanded before
28419 use. It can then be one of
28420
28421 .ilist
28422 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
28423 The condition succeeds if a virus was found, and fail otherwise. This is the
28424 recommended usage.
28425 .next
28426 &"false"& or &"0"& or an empty string, in which case no scanning is done and
28427 the condition fails immediately.
28428 .next
28429 A regular expression, in which case the message is scanned for viruses. The
28430 condition succeeds if a virus is found and its name matches the regular
28431 expression. This allows you to take special actions on certain types of virus.
28432 .endlist
28433
28434 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
28435 even if there is a problem with the virus scanner. Otherwise, such a problem
28436 causes the ACL to defer.
28437
28438 .vindex "&$malware_name$&"
28439 When a virus is found, the condition sets up an expansion variable called
28440 &$malware_name$& that contains the name of the virus. You can use it in a
28441 &%message%& modifier that specifies the error returned to the sender, and/or in
28442 logging data.
28443
28444 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
28445 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
28446 &%malware%& condition.
28447
28448 Beware the interaction of Exim's &%message_size_limit%& with any size limits
28449 imposed by your anti-virus scanner.
28450
28451 Here is a very simple scanning example:
28452 .code
28453 deny message = This message contains malware ($malware_name)
28454      demime = *
28455      malware = *
28456 .endd
28457 The next example accepts messages when there is a problem with the scanner:
28458 .code
28459 deny message = This message contains malware ($malware_name)
28460      demime = *
28461      malware = */defer_ok
28462 .endd
28463 The next example shows how to use an ACL variable to scan with both sophie and
28464 aveserver. It assumes you have set:
28465 .code
28466 av_scanner = $acl_m0
28467 .endd
28468 in the main Exim configuration.
28469 .code
28470 deny message = This message contains malware ($malware_name)
28471      set acl_m0 = sophie
28472      malware = *
28473
28474 deny message = This message contains malware ($malware_name)
28475      set acl_m0 = aveserver
28476      malware = *
28477 .endd
28478
28479
28480 .section "Scanning with SpamAssassin" "SECTscanspamass"
28481 .cindex "content scanning" "for spam"
28482 .cindex "spam scanning"
28483 .cindex "SpamAssassin"
28484 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
28485 score and a report for the message. You can get SpamAssassin at
28486 &url(http://www.spamassassin.org), or, if you have a working Perl
28487 installation, you can use CPAN by running:
28488 .code
28489 perl -MCPAN -e 'install Mail::SpamAssassin'
28490 .endd
28491 SpamAssassin has its own set of configuration files. Please review its
28492 documentation to see how you can tweak it. The default installation should work
28493 nicely, however.
28494
28495 .oindex "&%spamd_address%&"
28496 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
28497 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
28498 port for &%spamd%&, you must set the &%spamd_address%& option in the global
28499 part of the Exim configuration as follows (example):
28500 .code
28501 spamd_address = 192.168.99.45 387
28502 .endd
28503 You do not need to set this option if you use the default. As of version 2.60,
28504 &%spamd%& also supports communication over UNIX sockets. If you want to use
28505 these, supply &%spamd_address%& with an absolute file name instead of a
28506 address/port pair:
28507 .code
28508 spamd_address = /var/run/spamd_socket
28509 .endd
28510 You can have multiple &%spamd%& servers to improve scalability. These can
28511 reside on other hardware reachable over the network. To specify multiple
28512 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
28513 option, separated with colons:
28514 .code
28515 spamd_address = 192.168.2.10 783 : \
28516                 192.168.2.11 783 : \
28517                 192.168.2.12 783
28518 .endd
28519 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
28520 fashion. When a server fails to respond to the connection attempt, all other
28521 servers are tried until one succeeds. If no server responds, the &%spam%&
28522 condition defers.
28523
28524 &*Warning*&: It is not possible to use the UNIX socket connection method with
28525 multiple &%spamd%& servers.
28526
28527 The &%spamd_address%& variable is expanded before use if it starts with
28528 a dollar sign. In this case, the expansion may return a string that is
28529 used as the list so that multiple spamd servers can be the result of an
28530 expansion.
28531
28532 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
28533 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
28534 .code
28535 deny message = This message was classified as SPAM
28536      spam = joe
28537 .endd
28538 The right-hand side of the &%spam%& condition specifies a name. This is
28539 relevant if you have set up multiple SpamAssassin profiles. If you do not want
28540 to scan using a specific profile, but rather use the SpamAssassin system-wide
28541 default profile, you can scan for an unknown name, or simply use &"nobody"&.
28542 However, you must put something on the right-hand side.
28543
28544 The name allows you to use per-domain or per-user antispam profiles in
28545 principle, but this is not straightforward in practice, because a message may
28546 have multiple recipients, not necessarily all in the same domain. Because the
28547 &%spam%& condition has to be called from a DATA ACL in order to be able to
28548 read the contents of the message, the variables &$local_part$& and &$domain$&
28549 are not set.
28550
28551 The right-hand side of the &%spam%& condition is expanded before being used, so
28552 you can put lookups or conditions there. When the right-hand side evaluates to
28553 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
28554
28555
28556 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
28557 large ones may cause significant performance degradation. As most spam messages
28558 are quite small, it is recommended that you do not scan the big ones. For
28559 example:
28560 .code
28561 deny message = This message was classified as SPAM
28562      condition = ${if < {$message_size}{10K}}
28563      spam = nobody
28564 .endd
28565
28566 The &%spam%& condition returns true if the threshold specified in the user's
28567 SpamAssassin profile has been matched or exceeded. If you want to use the
28568 &%spam%& condition for its side effects (see the variables below), you can make
28569 it always return &"true"& by appending &`:true`& to the username.
28570
28571 .cindex "spam scanning" "returned variables"
28572 When the &%spam%& condition is run, it sets up a number of expansion
28573 variables. These variables are saved with the received message, thus they are
28574 available for use at delivery time.
28575
28576 .vlist
28577 .vitem &$spam_score$&
28578 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
28579 for inclusion in log or reject messages.
28580
28581 .vitem &$spam_score_int$&
28582 The spam score of the message, multiplied by ten, as an integer value. For
28583 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
28584 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
28585 The integer value is useful for numeric comparisons in conditions.
28586
28587 .vitem &$spam_bar$&
28588 A string consisting of a number of &"+"& or &"-"& characters, representing the
28589 integer part of the spam score value. A spam score of 4.4 would have a
28590 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
28591 headers, since MUAs can match on such strings.
28592
28593 .vitem &$spam_report$&
28594 A multiline text table, containing the full SpamAssassin report for the
28595 message. Useful for inclusion in headers or reject messages.
28596 .endlist
28597
28598 The &%spam%& condition caches its results unless expansion in
28599 spamd_address was used. If you call it again with the same user name, it
28600 does not scan again, but rather returns the same values as before.
28601
28602 The &%spam%& condition returns DEFER if there is any error while running
28603 the message through SpamAssassin or if the expansion of spamd_address
28604 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
28605 statement block), append &`/defer_ok`& to the right-hand side of the
28606 spam condition, like this:
28607 .code
28608 deny message = This message was classified as SPAM
28609      spam    = joe/defer_ok
28610 .endd
28611 This causes messages to be accepted even if there is a problem with &%spamd%&.
28612
28613 Here is a longer, commented example of the use of the &%spam%&
28614 condition:
28615 .code
28616 # put headers in all messages (no matter if spam or not)
28617 warn  spam = nobody:true
28618       add_header = X-Spam-Score: $spam_score ($spam_bar)
28619       add_header = X-Spam-Report: $spam_report
28620
28621 # add second subject line with *SPAM* marker when message
28622 # is over threshold
28623 warn  spam = nobody
28624       add_header = Subject: *SPAM* $h_Subject:
28625
28626 # reject spam at high scores (> 12)
28627 deny  message = This message scored $spam_score spam points.
28628       spam = nobody:true
28629       condition = ${if >{$spam_score_int}{120}{1}{0}}
28630 .endd
28631
28632
28633
28634 .section "Scanning MIME parts" "SECTscanmimepart"
28635 .cindex "content scanning" "MIME parts"
28636 .cindex "MIME content scanning"
28637 .oindex "&%acl_smtp_mime%&"
28638 .oindex "&%acl_not_smtp_mime%&"
28639 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
28640 each MIME part of an SMTP message, including multipart types, in the sequence
28641 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
28642 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
28643 options may both refer to the same ACL if you want the same processing in both
28644 cases.
28645
28646 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
28647 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
28648 the case of a non-SMTP message. However, a MIME ACL is called only if the
28649 message contains a &'Content-Type:'& header line. When a call to a MIME
28650 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
28651 result code is sent to the client. In the case of an SMTP message, the
28652 &%acl_smtp_data%& ACL is not called when this happens.
28653
28654 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
28655 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
28656 condition to match against the raw MIME part. You can also use the
28657 &%mime_regex%& condition to match against the decoded MIME part (see section
28658 &<<SECTscanregex>>&).
28659
28660 At the start of a MIME ACL, a number of variables are set from the header
28661 information for the relevant MIME part. These are described below. The contents
28662 of the MIME part are not by default decoded into a disk file except for MIME
28663 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
28664 part into a disk file, you can use the &%decode%& condition. The general
28665 syntax is:
28666 .display
28667 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
28668 .endd
28669 The right hand side is expanded before use. After expansion,
28670 the value can be:
28671
28672 .olist
28673 &"0"& or &"false"&, in which case no decoding is done.
28674 .next
28675 The string &"default"&. In that case, the file is put in the temporary
28676 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
28677 a sequential file name consisting of the message id and a sequence number. The
28678 full path and name is available in &$mime_decoded_filename$& after decoding.
28679 .next
28680 A full path name starting with a slash. If the full name is an existing
28681 directory, it is used as a replacement for the default directory. The filename
28682 is then sequentially assigned. If the path does not exist, it is used as
28683 the full path and file name.
28684 .next
28685 If the string does not start with a slash, it is used as the
28686 filename, and the default path is then used.
28687 .endlist
28688 The &%decode%& condition normally succeeds. It is only false for syntax
28689 errors or unusual circumstances such as memory shortages. You can easily decode
28690 a file with its original, proposed filename using
28691 .code
28692 decode = $mime_filename
28693 .endd
28694 However, you should keep in mind that &$mime_filename$& might contain
28695 anything. If you place files outside of the default path, they are not
28696 automatically unlinked.
28697
28698 For RFC822 attachments (these are messages attached to messages, with a
28699 content-type of &"message/rfc822"&), the ACL is called again in the same manner
28700 as for the primary message, only that the &$mime_is_rfc822$& expansion
28701 variable is set (see below). Attached messages are always decoded to disk
28702 before being checked, and the files are unlinked once the check is done.
28703
28704 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
28705 used to match regular expressions against raw and decoded MIME parts,
28706 respectively. They are described in section &<<SECTscanregex>>&.
28707
28708 .cindex "MIME content scanning" "returned variables"
28709 The following list describes all expansion variables that are
28710 available in the MIME ACL:
28711
28712 .vlist
28713 .vitem &$mime_boundary$&
28714 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
28715 have a boundary string, which is stored in this variable. If the current part
28716 has no boundary parameter in the &'Content-Type:'& header, this variable
28717 contains the empty string.
28718
28719 .vitem &$mime_charset$&
28720 This variable contains the character set identifier, if one was found in the
28721 &'Content-Type:'& header. Examples for charset identifiers are:
28722 .code
28723 us-ascii
28724 gb2312 (Chinese)
28725 iso-8859-1
28726 .endd
28727 Please note that this value is not normalized, so you should do matches
28728 case-insensitively.
28729
28730 .vitem &$mime_content_description$&
28731 This variable contains the normalized content of the &'Content-Description:'&
28732 header. It can contain a human-readable description of the parts content. Some
28733 implementations repeat the filename for attachments here, but they are usually
28734 only used for display purposes.
28735
28736 .vitem &$mime_content_disposition$&
28737 This variable contains the normalized content of the &'Content-Disposition:'&
28738 header. You can expect strings like &"attachment"& or &"inline"& here.
28739
28740 .vitem &$mime_content_id$&
28741 This variable contains the normalized content of the &'Content-ID:'& header.
28742 This is a unique ID that can be used to reference a part from another part.
28743
28744 .vitem &$mime_content_size$&
28745 This variable is set only after the &%decode%& modifier (see above) has been
28746 successfully run. It contains the size of the decoded part in kilobytes. The
28747 size is always rounded up to full kilobytes, so only a completely empty part
28748 has a &$mime_content_size$& of zero.
28749
28750 .vitem &$mime_content_transfer_encoding$&
28751 This variable contains the normalized content of the
28752 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
28753 type. Typical values are &"base64"& and &"quoted-printable"&.
28754
28755 .vitem &$mime_content_type$&
28756 If the MIME part has a &'Content-Type:'& header, this variable contains its
28757 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
28758 are some examples of popular MIME types, as they may appear in this variable:
28759 .code
28760 text/plain
28761 text/html
28762 application/octet-stream
28763 image/jpeg
28764 audio/midi
28765 .endd
28766 If the MIME part has no &'Content-Type:'& header, this variable contains the
28767 empty string.
28768
28769 .vitem &$mime_decoded_filename$&
28770 This variable is set only after the &%decode%& modifier (see above) has been
28771 successfully run. It contains the full path and file name of the file
28772 containing the decoded data.
28773 .endlist
28774
28775 .cindex "RFC 2047"
28776 .vlist
28777 .vitem &$mime_filename$&
28778 This is perhaps the most important of the MIME variables. It contains a
28779 proposed filename for an attachment, if one was found in either the
28780 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
28781 RFC2047 decoded, but no additional sanity checks are done. If no filename was
28782 found, this variable contains the empty string.
28783
28784 .vitem &$mime_is_coverletter$&
28785 This variable attempts to differentiate the &"cover letter"& of an e-mail from
28786 attached data. It can be used to clamp down on flashy or unnecessarily encoded
28787 content in the cover letter, while not restricting attachments at all.
28788
28789 The variable contains 1 (true) for a MIME part believed to be part of the
28790 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
28791 follows:
28792
28793 .olist
28794 The outermost MIME part of a message is always a cover letter.
28795
28796 .next
28797 If a multipart/alternative or multipart/related MIME part is a cover letter,
28798 so are all MIME subparts within that multipart.
28799
28800 .next
28801 If any other multipart is a cover letter, the first subpart is a cover letter,
28802 and the rest are attachments.
28803
28804 .next
28805 All parts contained within an attachment multipart are attachments.
28806 .endlist olist
28807
28808 As an example, the following will ban &"HTML mail"& (including that sent with
28809 alternative plain text), while allowing HTML files to be attached. HTML
28810 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
28811 .code
28812 deny message = HTML mail is not accepted here
28813 !condition = $mime_is_rfc822
28814 condition = $mime_is_coverletter
28815 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
28816 .endd
28817 .vitem &$mime_is_multipart$&
28818 This variable has the value 1 (true) when the current part has the main type
28819 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
28820 Since multipart entities only serve as containers for other parts, you may not
28821 want to carry out specific actions on them.
28822
28823 .vitem &$mime_is_rfc822$&
28824 This variable has the value 1 (true) if the current part is not a part of the
28825 checked message itself, but part of an attached message. Attached message
28826 decoding is fully recursive.
28827
28828 .vitem &$mime_part_count$&
28829 This variable is a counter that is raised for each processed MIME part. It
28830 starts at zero for the very first part (which is usually a multipart). The
28831 counter is per-message, so it is reset when processing RFC822 attachments (see
28832 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
28833 complete, so you can use it in the DATA ACL to determine the number of MIME
28834 parts of a message. For non-MIME messages, this variable contains the value -1.
28835 .endlist
28836
28837
28838
28839 .section "Scanning with regular expressions" "SECTscanregex"
28840 .cindex "content scanning" "with regular expressions"
28841 .cindex "regular expressions" "content scanning with"
28842 You can specify your own custom regular expression matches on the full body of
28843 the message, or on individual MIME parts.
28844
28845 The &%regex%& condition takes one or more regular expressions as arguments and
28846 matches them against the full message (when called in the DATA ACL) or a raw
28847 MIME part (when called in the MIME ACL). The &%regex%& condition matches
28848 linewise, with a maximum line length of 32K characters. That means you cannot
28849 have multiline matches with the &%regex%& condition.
28850
28851 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
28852 to 32K of decoded content (the whole content at once, not linewise). If the
28853 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
28854 is decoded automatically when &%mime_regex%& is executed (using default path
28855 and filename values). If the decoded data is larger than  32K, only the first
28856 32K characters are checked.
28857
28858 The regular expressions are passed as a colon-separated list. To include a
28859 literal colon, you must double it. Since the whole right-hand side string is
28860 expanded before being used, you must also escape dollar signs and backslashes
28861 with more backslashes, or use the &`\N`& facility to disable expansion.
28862 Here is a simple example that contains two regular expressions:
28863 .code
28864 deny message = contains blacklisted regex ($regex_match_string)
28865      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
28866 .endd
28867 The conditions returns true if any one of the regular expressions matches. The
28868 &$regex_match_string$& expansion variable is then set up and contains the
28869 matching regular expression.
28870
28871 &*Warning*&: With large messages, these conditions can be fairly
28872 CPU-intensive.
28873
28874
28875
28876
28877 .section "The demime condition" "SECTdemimecond"
28878 .cindex "content scanning" "MIME checking"
28879 .cindex "MIME content scanning"
28880 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
28881 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
28882 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
28883 ACL functionality, but provides no additional facilities. Please note that this
28884 condition is deprecated and kept only for backward compatibility. You must set
28885 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
28886 use the &%demime%& condition.
28887
28888 The &%demime%& condition unpacks MIME containers in the message. It detects
28889 errors in MIME containers and can match file extensions found in the message
28890 against a list. Using this facility produces files containing the unpacked MIME
28891 parts of the message in the temporary scan directory. If you do antivirus
28892 scanning, it is recommended that you use the &%demime%& condition before the
28893 antivirus (&%malware%&) condition.
28894
28895 On the right-hand side of the &%demime%& condition you can pass a
28896 colon-separated list of file extensions that it should match against. For
28897 example:
28898 .code
28899 deny message = Found blacklisted file attachment
28900      demime  = vbs:com:bat:pif:prf:lnk
28901 .endd
28902 If one of the file extensions is found, the condition is true, otherwise it is
28903 false. If there is a temporary error while demimeing (for example, &"disk
28904 full"&), the condition defers, and the message is temporarily rejected (unless
28905 the condition is on a &%warn%& verb).
28906
28907 The right-hand side is expanded before being treated as a list, so you can have
28908 conditions and lookups there. If it expands to an empty string, &"false"&, or
28909 zero (&"0"&), no demimeing is done and the condition is false.
28910
28911 The &%demime%& condition set the following variables:
28912
28913 .vlist
28914 .vitem &$demime_errorlevel$&
28915 .vindex "&$demime_errorlevel$&"
28916 When an error is detected in a MIME container, this variable contains the
28917 severity of the error, as an integer number. The higher the value, the more
28918 severe the error (the current maximum value is 3). If this variable is unset or
28919 zero, no error occurred.
28920
28921 .vitem &$demime_reason$&
28922 .vindex "&$demime_reason$&"
28923 When &$demime_errorlevel$& is greater than zero, this variable contains a
28924 human-readable text string describing the MIME error that occurred.
28925 .endlist
28926
28927 .vlist
28928 .vitem &$found_extension$&
28929 .vindex "&$found_extension$&"
28930 When the &%demime%& condition is true, this variable contains the file
28931 extension it found.
28932 .endlist
28933
28934 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
28935 the &%demime%& condition, and are not changed on subsequent calls.
28936
28937 If you do not want to check for file extensions, but rather use the &%demime%&
28938 condition for unpacking or error checking purposes, pass &"*"& as the
28939 right-hand side value. Here is a more elaborate example of how to use this
28940 facility:
28941 .code
28942 # Reject messages with serious MIME container errors
28943 deny  message = Found MIME error ($demime_reason).
28944       demime = *
28945       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
28946
28947 # Reject known virus spreading file extensions.
28948 # Accepting these is pretty much braindead.
28949 deny  message = contains $found_extension file (blacklisted).
28950       demime  = com:vbs:bat:pif:scr
28951
28952 # Freeze .exe and .doc files. Postmaster can
28953 # examine them and eventually thaw them.
28954 deny  log_message = Another $found_extension file.
28955       demime = exe:doc
28956       control = freeze
28957 .endd
28958 .ecindex IIDcosca
28959
28960
28961
28962
28963 . ////////////////////////////////////////////////////////////////////////////
28964 . ////////////////////////////////////////////////////////////////////////////
28965
28966 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
28967          "Local scan function"
28968 .scindex IIDlosca "&[local_scan()]& function" "description of"
28969 .cindex "customizing" "input scan using C function"
28970 .cindex "policy control" "by local scan function"
28971 In these days of email worms, viruses, and ever-increasing spam, some sites
28972 want to apply a lot of checking to messages before accepting them.
28973
28974 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
28975 passing messages to external virus and spam scanning software. You can also do
28976 a certain amount in Exim itself through string expansions and the &%condition%&
28977 condition in the ACL that runs after the SMTP DATA command or the ACL for
28978 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
28979
28980 To allow for further customization to a site's own requirements, there is the
28981 possibility of linking Exim with a private message scanning function, written
28982 in C. If you want to run code that is written in something other than C, you
28983 can of course use a little C stub to call it.
28984
28985 The local scan function is run once for every incoming message, at the point
28986 when Exim is just about to accept the message.
28987 It can therefore be used to control non-SMTP messages from local processes as
28988 well as messages arriving via SMTP.
28989
28990 Exim applies a timeout to calls of the local scan function, and there is an
28991 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
28992 Zero means &"no timeout"&.
28993 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
28994 before calling the local scan function, so that the most common types of crash
28995 are caught. If the timeout is exceeded or one of those signals is caught, the
28996 incoming message is rejected with a temporary error if it is an SMTP message.
28997 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
28998 code. The incident is logged on the main and reject logs.
28999
29000
29001
29002 .section "Building Exim to use a local scan function" "SECID207"
29003 .cindex "&[local_scan()]& function" "building Exim to use"
29004 To make use of the local scan function feature, you must tell Exim where your
29005 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
29006 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
29007 directory, so you might set
29008 .code
29009 LOCAL_SCAN_SOURCE=Local/local_scan.c
29010 .endd
29011 for example. The function must be called &[local_scan()]&. It is called by
29012 Exim after it has received a message, when the success return code is about to
29013 be sent. This is after all the ACLs have been run. The return code from your
29014 function controls whether the message is actually accepted or not. There is a
29015 commented template function (that just accepts the message) in the file
29016 _src/local_scan.c_.
29017
29018 If you want to make use of Exim's run time configuration file to set options
29019 for your &[local_scan()]& function, you must also set
29020 .code
29021 LOCAL_SCAN_HAS_OPTIONS=yes
29022 .endd
29023 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
29024
29025
29026
29027
29028 .section "API for local_scan()" "SECTapiforloc"
29029 .cindex "&[local_scan()]& function" "API description"
29030 You must include this line near the start of your code:
29031 .code
29032 #include "local_scan.h"
29033 .endd
29034 This header file defines a number of variables and other values, and the
29035 prototype for the function itself. Exim is coded to use unsigned char values
29036 almost exclusively, and one of the things this header defines is a shorthand
29037 for &`unsigned char`& called &`uschar`&.
29038 It also contains the following macro definitions, to simplify casting character
29039 strings and pointers to character strings:
29040 .code
29041 #define CS   (char *)
29042 #define CCS  (const char *)
29043 #define CSS  (char **)
29044 #define US   (unsigned char *)
29045 #define CUS  (const unsigned char *)
29046 #define USS  (unsigned char **)
29047 .endd
29048 The function prototype for &[local_scan()]& is:
29049 .code
29050 extern int local_scan(int fd, uschar **return_text);
29051 .endd
29052 The arguments are as follows:
29053
29054 .ilist
29055 &%fd%& is a file descriptor for the file that contains the body of the message
29056 (the -D file). The file is open for reading and writing, but updating it is not
29057 recommended. &*Warning*&: You must &'not'& close this file descriptor.
29058
29059 The descriptor is positioned at character 19 of the file, which is the first
29060 character of the body itself, because the first 19 characters are the message
29061 id followed by &`-D`& and a newline. If you rewind the file, you should use the
29062 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
29063 case this changes in some future version.
29064 .next
29065 &%return_text%& is an address which you can use to return a pointer to a text
29066 string at the end of the function. The value it points to on entry is NULL.
29067 .endlist
29068
29069 The function must return an &%int%& value which is one of the following macros:
29070
29071 .vlist
29072 .vitem &`LOCAL_SCAN_ACCEPT`&
29073 .vindex "&$local_scan_data$&"
29074 The message is accepted. If you pass back a string of text, it is saved with
29075 the message, and made available in the variable &$local_scan_data$&. No
29076 newlines are permitted (if there are any, they are turned into spaces) and the
29077 maximum length of text is 1000 characters.
29078
29079 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
29080 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29081 queued without immediate delivery, and is frozen.
29082
29083 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
29084 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29085 queued without immediate delivery.
29086
29087 .vitem &`LOCAL_SCAN_REJECT`&
29088 The message is rejected; the returned text is used as an error message which is
29089 passed back to the sender and which is also logged. Newlines are permitted &--
29090 they cause a multiline response for SMTP rejections, but are converted to
29091 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
29092 used.
29093
29094 .vitem &`LOCAL_SCAN_TEMPREJECT`&
29095 The message is temporarily rejected; the returned text is used as an error
29096 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
29097 problem"& is used.
29098
29099 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
29100 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
29101 message is not written to the reject log. It has the effect of unsetting the
29102 &%rejected_header%& log selector for just this rejection. If
29103 &%rejected_header%& is already unset (see the discussion of the
29104 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
29105 same as LOCAL_SCAN_REJECT.
29106
29107 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
29108 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
29109 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
29110 .endlist
29111
29112 If the message is not being received by interactive SMTP, rejections are
29113 reported by writing to &%stderr%& or by sending an email, as configured by the
29114 &%-oe%& command line options.
29115
29116
29117
29118 .section "Configuration options for local_scan()" "SECTconoptloc"
29119 .cindex "&[local_scan()]& function" "configuration options"
29120 It is possible to have option settings in the main configuration file
29121 that set values in static variables in the &[local_scan()]& module. If you
29122 want to do this, you must have the line
29123 .code
29124 LOCAL_SCAN_HAS_OPTIONS=yes
29125 .endd
29126 in your &_Local/Makefile_& when you build Exim. (This line is in
29127 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
29128 file, you must define static variables to hold the option values, and a table
29129 to define them.
29130
29131 The table must be a vector called &%local_scan_options%&, of type
29132 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
29133 and a pointer to the variable that holds the value. The entries must appear in
29134 alphabetical order. Following &%local_scan_options%& you must also define a
29135 variable called &%local_scan_options_count%& that contains the number of
29136 entries in the table. Here is a short example, showing two kinds of option:
29137 .code
29138 static int my_integer_option = 42;
29139 static uschar *my_string_option = US"a default string";
29140
29141 optionlist local_scan_options[] = {
29142   { "my_integer", opt_int,       &my_integer_option },
29143   { "my_string",  opt_stringptr, &my_string_option }
29144 };
29145
29146 int local_scan_options_count =
29147   sizeof(local_scan_options)/sizeof(optionlist);
29148 .endd
29149 The values of the variables can now be changed from Exim's runtime
29150 configuration file by including a local scan section as in this example:
29151 .code
29152 begin local_scan
29153 my_integer = 99
29154 my_string = some string of text...
29155 .endd
29156 The available types of option data are as follows:
29157
29158 .vlist
29159 .vitem &*opt_bool*&
29160 This specifies a boolean (true/false) option. The address should point to a
29161 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
29162 that are defined as &"1"& and &"0"&, respectively. If you want to detect
29163 whether such a variable has been set at all, you can initialize it to
29164 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
29165 values.)
29166
29167 .vitem &*opt_fixed*&
29168 This specifies a fixed point number, such as is used for load averages.
29169 The address should point to a variable of type &`int`&. The value is stored
29170 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
29171
29172 .vitem &*opt_int*&
29173 This specifies an integer; the address should point to a variable of type
29174 &`int`&. The value may be specified in any of the integer formats accepted by
29175 Exim.
29176
29177 .vitem &*opt_mkint*&
29178 This is the same as &%opt_int%&, except that when such a value is output in a
29179 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
29180 printed with the suffix K or M.
29181
29182 .vitem &*opt_octint*&
29183 This also specifies an integer, but the value is always interpreted as an
29184 octal integer, whether or not it starts with the digit zero, and it is
29185 always output in octal.
29186
29187 .vitem &*opt_stringptr*&
29188 This specifies a string value; the address must be a pointer to a
29189 variable that points to a string (for example, of type &`uschar *`&).
29190
29191 .vitem &*opt_time*&
29192 This specifies a time interval value. The address must point to a variable of
29193 type &`int`&. The value that is placed there is a number of seconds.
29194 .endlist
29195
29196 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
29197 out the values of all the &[local_scan()]& options.
29198
29199
29200
29201 .section "Available Exim variables" "SECID208"
29202 .cindex "&[local_scan()]& function" "available Exim variables"
29203 The header &_local_scan.h_& gives you access to a number of C variables. These
29204 are the only ones that are guaranteed to be maintained from release to release.
29205 Note, however, that you can obtain the value of any Exim expansion variable,
29206 including &$recipients$&, by calling &'expand_string()'&. The exported
29207 C variables are as follows:
29208
29209 .vlist
29210 .vitem &*int&~body_linecount*&
29211 This variable contains the number of lines in the message's body.
29212
29213 .vitem &*int&~body_zerocount*&
29214 This variable contains the number of binary zero bytes in the message's body.
29215
29216 .vitem &*unsigned&~int&~debug_selector*&
29217 This variable is set to zero when no debugging is taking place. Otherwise, it
29218 is a bitmap of debugging selectors. Two bits are identified for use in
29219 &[local_scan()]&; they are defined as macros:
29220
29221 .ilist
29222 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
29223 testing option that is not privileged &-- any caller may set it. All the
29224 other selector bits can be set only by admin users.
29225
29226 .next
29227 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
29228 by the &`+local_scan`& debug selector. It is not included in the default set
29229 of debugging bits.
29230 .endlist ilist
29231
29232 Thus, to write to the debugging output only when &`+local_scan`& has been
29233 selected, you should use code like this:
29234 .code
29235 if ((debug_selector & D_local_scan) != 0)
29236   debug_printf("xxx", ...);
29237 .endd
29238 .vitem &*uschar&~*expand_string_message*&
29239 After a failing call to &'expand_string()'& (returned value NULL), the
29240 variable &%expand_string_message%& contains the error message, zero-terminated.
29241
29242 .vitem &*header_line&~*header_list*&
29243 A pointer to a chain of header lines. The &%header_line%& structure is
29244 discussed below.
29245
29246 .vitem &*header_line&~*header_last*&
29247 A pointer to the last of the header lines.
29248
29249 .vitem &*uschar&~*headers_charset*&
29250 The value of the &%headers_charset%& configuration option.
29251
29252 .vitem &*BOOL&~host_checking*&
29253 This variable is TRUE during a host checking session that is initiated by the
29254 &%-bh%& command line option.
29255
29256 .vitem &*uschar&~*interface_address*&
29257 The IP address of the interface that received the message, as a string. This
29258 is NULL for locally submitted messages.
29259
29260 .vitem &*int&~interface_port*&
29261 The port on which this message was received. When testing with the &%-bh%&
29262 command line option, the value of this variable is -1 unless a port has been
29263 specified via the &%-oMi%& option.
29264
29265 .vitem &*uschar&~*message_id*&
29266 This variable contains Exim's message id for the incoming message (the value of
29267 &$message_exim_id$&) as a zero-terminated string.
29268
29269 .vitem &*uschar&~*received_protocol*&
29270 The name of the protocol by which the message was received.
29271
29272 .vitem &*int&~recipients_count*&
29273 The number of accepted recipients.
29274
29275 .vitem &*recipient_item&~*recipients_list*&
29276 .cindex "recipient" "adding in local scan"
29277 .cindex "recipient" "removing in local scan"
29278 The list of accepted recipients, held in a vector of length
29279 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
29280 can add additional recipients by calling &'receive_add_recipient()'& (see
29281 below). You can delete recipients by removing them from the vector and
29282 adjusting the value in &%recipients_count%&. In particular, by setting
29283 &%recipients_count%& to zero you remove all recipients. If you then return the
29284 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
29285 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
29286 and then call &'receive_add_recipient()'& as often as needed.
29287
29288 .vitem &*uschar&~*sender_address*&
29289 The envelope sender address. For bounce messages this is the empty string.
29290
29291 .vitem &*uschar&~*sender_host_address*&
29292 The IP address of the sending host, as a string. This is NULL for
29293 locally-submitted messages.
29294
29295 .vitem &*uschar&~*sender_host_authenticated*&
29296 The name of the authentication mechanism that was used, or NULL if the message
29297 was not received over an authenticated SMTP connection.
29298
29299 .vitem &*uschar&~*sender_host_name*&
29300 The name of the sending host, if known.
29301
29302 .vitem &*int&~sender_host_port*&
29303 The port on the sending host.
29304
29305 .vitem &*BOOL&~smtp_input*&
29306 This variable is TRUE for all SMTP input, including BSMTP.
29307
29308 .vitem &*BOOL&~smtp_batched_input*&
29309 This variable is TRUE for BSMTP input.
29310
29311 .vitem &*int&~store_pool*&
29312 The contents of this variable control which pool of memory is used for new
29313 requests. See section &<<SECTmemhanloc>>& for details.
29314 .endlist
29315
29316
29317 .section "Structure of header lines" "SECID209"
29318 The &%header_line%& structure contains the members listed below.
29319 You can add additional header lines by calling the &'header_add()'& function
29320 (see below). You can cause header lines to be ignored (deleted) by setting
29321 their type to *.
29322
29323
29324 .vlist
29325 .vitem &*struct&~header_line&~*next*&
29326 A pointer to the next header line, or NULL for the last line.
29327
29328 .vitem &*int&~type*&
29329 A code identifying certain headers that Exim recognizes. The codes are printing
29330 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
29331 Notice in particular that any header line whose type is * is not transmitted
29332 with the message. This flagging is used for header lines that have been
29333 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
29334 lines.) Effectively, * means &"deleted"&.
29335
29336 .vitem &*int&~slen*&
29337 The number of characters in the header line, including the terminating and any
29338 internal newlines.
29339
29340 .vitem &*uschar&~*text*&
29341 A pointer to the text of the header. It always ends with a newline, followed by
29342 a zero byte. Internal newlines are preserved.
29343 .endlist
29344
29345
29346
29347 .section "Structure of recipient items" "SECID210"
29348 The &%recipient_item%& structure contains these members:
29349
29350 .vlist
29351 .vitem &*uschar&~*address*&
29352 This is a pointer to the recipient address as it was received.
29353
29354 .vitem &*int&~pno*&
29355 This is used in later Exim processing when top level addresses are created by
29356 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
29357 and must always contain -1 at this stage.
29358
29359 .vitem &*uschar&~*errors_to*&
29360 If this value is not NULL, bounce messages caused by failing to deliver to the
29361 recipient are sent to the address it contains. In other words, it overrides the
29362 envelope sender for this one recipient. (Compare the &%errors_to%& generic
29363 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
29364 an unqualified address, Exim qualifies it using the domain from
29365 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
29366 is NULL for all recipients.
29367 .endlist
29368
29369
29370
29371 .section "Available Exim functions" "SECID211"
29372 .cindex "&[local_scan()]& function" "available Exim functions"
29373 The header &_local_scan.h_& gives you access to a number of Exim functions.
29374 These are the only ones that are guaranteed to be maintained from release to
29375 release:
29376
29377 .vlist
29378 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
29379        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
29380
29381 This function creates a child process that runs the command specified by
29382 &%argv%&. The environment for the process is specified by &%envp%&, which can
29383 be NULL if no environment variables are to be passed. A new umask is supplied
29384 for the process in &%newumask%&.
29385
29386 Pipes to the standard input and output of the new process are set up
29387 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
29388 standard error is cloned to the standard output. If there are any file
29389 descriptors &"in the way"& in the new process, they are closed. If the final
29390 argument is TRUE, the new process is made into a process group leader.
29391
29392 The function returns the pid of the new process, or -1 if things go wrong.
29393
29394 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
29395 This function waits for a child process to terminate, or for a timeout (in
29396 seconds) to expire. A timeout value of zero means wait as long as it takes. The
29397 return value is as follows:
29398
29399 .ilist
29400 >= 0
29401
29402 The process terminated by a normal exit and the value is the process
29403 ending status.
29404
29405 .next
29406 < 0 and > &--256
29407
29408 The process was terminated by a signal and the value is the negation of the
29409 signal number.
29410
29411 .next
29412 &--256
29413
29414 The process timed out.
29415 .next
29416 &--257
29417
29418 The was some other error in wait(); &%errno%& is still set.
29419 .endlist
29420
29421 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
29422 This function provide you with a means of submitting a new message to
29423 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
29424 want, but this packages it all up for you.) The function creates a pipe,
29425 forks a subprocess that is running
29426 .code
29427 exim -t -oem -oi -f <>
29428 .endd
29429 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
29430 that is connected to the standard input. The yield of the function is the PID
29431 of the subprocess. You can then write a message to the file descriptor, with
29432 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
29433
29434 When you have finished, call &'child_close()'& to wait for the process to
29435 finish and to collect its ending status. A timeout value of zero is usually
29436 fine in this circumstance. Unless you have made a mistake with the recipient
29437 addresses, you should get a return code of zero.
29438
29439
29440 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
29441        *sender_authentication)*&
29442 This function is a more sophisticated version of &'child_open()'&. The command
29443 that it runs is:
29444 .display
29445 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
29446 .endd
29447 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
29448
29449
29450 .vitem &*void&~debug_printf(char&~*,&~...)*&
29451 This is Exim's debugging function, with arguments as for &'(printf()'&. The
29452 output is written to the standard error stream. If no debugging is selected,
29453 calls to &'debug_printf()'& have no effect. Normally, you should make calls
29454 conditional on the &`local_scan`& debug selector by coding like this:
29455 .code
29456 if ((debug_selector & D_local_scan) != 0)
29457   debug_printf("xxx", ...);
29458 .endd
29459
29460 .vitem &*uschar&~*expand_string(uschar&~*string)*&
29461 This is an interface to Exim's string expansion code. The return value is the
29462 expanded string, or NULL if there was an expansion failure.
29463 The C variable &%expand_string_message%& contains an error message after an
29464 expansion failure. If expansion does not change the string, the return value is
29465 the pointer to the input string. Otherwise, the return value points to a new
29466 block of memory that was obtained by a call to &'store_get()'&. See section
29467 &<<SECTmemhanloc>>& below for a discussion of memory handling.
29468
29469 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
29470 This function allows you to an add additional header line at the end of the
29471 existing ones. The first argument is the type, and should normally be a space
29472 character. The second argument is a format string and any number of
29473 substitution arguments as for &[sprintf()]&. You may include internal newlines
29474 if you want, and you must ensure that the string ends with a newline.
29475
29476 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
29477         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
29478 This function adds a new header line at a specified point in the header
29479 chain. The header itself is specified as for &'header_add()'&.
29480
29481 If &%name%& is NULL, the new header is added at the end of the chain if
29482 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
29483 NULL, the header lines are searched for the first non-deleted header that
29484 matches the name. If one is found, the new header is added before it if
29485 &%after%& is false. If &%after%& is true, the new header is added after the
29486 found header and any adjacent subsequent ones with the same name (even if
29487 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
29488 option controls where the header is added. If it is true, addition is at the
29489 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
29490 headers, or at the top if there are no &'Received:'& headers, you could use
29491 .code
29492 header_add_at_position(TRUE, US"Received", TRUE,
29493   ' ', "X-xxx: ...");
29494 .endd
29495 Normally, there is always at least one non-deleted &'Received:'& header, but
29496 there may not be if &%received_header_text%& expands to an empty string.
29497
29498
29499 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
29500 This function removes header lines. If &%occurrence%& is zero or negative, all
29501 occurrences of the header are removed. If occurrence is greater than zero, that
29502 particular instance of the header is removed. If no header(s) can be found that
29503 match the specification, the function does nothing.
29504
29505
29506 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
29507         int&~length,&~BOOL&~notdel)*&"
29508 This function tests whether the given header has the given name. It is not just
29509 a string comparison, because white space is permitted between the name and the
29510 colon. If the &%notdel%& argument is true, a false return is forced for all
29511 &"deleted"& headers; otherwise they are not treated specially. For example:
29512 .code
29513 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
29514 .endd
29515 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
29516 .cindex "base64 encoding" "functions for &[local_scan()]& use"
29517 This function base64-encodes a string, which is passed by address and length.
29518 The text may contain bytes of any value, including zero. The result is passed
29519 back in dynamic memory that is obtained by calling &'store_get()'&. It is
29520 zero-terminated.
29521
29522 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
29523 This function decodes a base64-encoded string. Its arguments are a
29524 zero-terminated base64-encoded string and the address of a variable that is set
29525 to point to the result, which is in dynamic memory. The length of the decoded
29526 string is the yield of the function. If the input is invalid base64 data, the
29527 yield is -1. A zero byte is added to the end of the output string to make it
29528 easy to interpret as a C string (assuming it contains no zeros of its own). The
29529 added zero byte is not included in the returned count.
29530
29531 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
29532 This function checks for a match in a domain list. Domains are always
29533 matched caselessly. The return value is one of the following:
29534 .display
29535 &`OK     `& match succeeded
29536 &`FAIL   `& match failed
29537 &`DEFER  `& match deferred
29538 .endd
29539 DEFER is usually caused by some kind of lookup defer, such as the
29540 inability to contact a database.
29541
29542 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
29543         BOOL&~caseless)*&"
29544 This function checks for a match in a local part list. The third argument
29545 controls case-sensitivity. The return values are as for
29546 &'lss_match_domain()'&.
29547
29548 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
29549         BOOL&~caseless)*&"
29550 This function checks for a match in an address list. The third argument
29551 controls the case-sensitivity of the local part match. The domain is always
29552 matched caselessly. The return values are as for &'lss_match_domain()'&.
29553
29554 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
29555         uschar&~*list)*&"
29556 This function checks for a match in a host list. The most common usage is
29557 expected to be
29558 .code
29559 lss_match_host(sender_host_name, sender_host_address, ...)
29560 .endd
29561 .vindex "&$sender_host_address$&"
29562 An empty address field matches an empty item in the host list. If the host name
29563 is NULL, the name corresponding to &$sender_host_address$& is automatically
29564 looked up if a host name is required to match an item in the list. The return
29565 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
29566 returns ERROR in the case when it had to look up a host name, but the lookup
29567 failed.
29568
29569 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
29570         *format,&~...)*&"
29571 This function writes to Exim's log files. The first argument should be zero (it
29572 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
29573 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
29574 them. It specifies to which log or logs the message is written. The remaining
29575 arguments are a format and relevant insertion arguments. The string should not
29576 contain any newlines, not even at the end.
29577
29578
29579 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
29580 This function adds an additional recipient to the message. The first argument
29581 is the recipient address. If it is unqualified (has no domain), it is qualified
29582 with the &%qualify_recipient%& domain. The second argument must always be -1.
29583
29584 This function does not allow you to specify a private &%errors_to%& address (as
29585 described with the structure of &%recipient_item%& above), because it pre-dates
29586 the addition of that field to the structure. However, it is easy to add such a
29587 value afterwards. For example:
29588 .code
29589  receive_add_recipient(US"monitor@mydom.example", -1);
29590  recipients_list[recipients_count-1].errors_to =
29591    US"postmaster@mydom.example";
29592 .endd
29593
29594 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
29595 This is a convenience function to remove a named recipient from the list of
29596 recipients. It returns true if a recipient was removed, and false if no
29597 matching recipient could be found. The argument must be a complete email
29598 address.
29599 .endlist
29600
29601
29602 .cindex "RFC 2047"
29603 .vlist
29604 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
29605   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
29606 This function decodes strings that are encoded according to RFC 2047. Typically
29607 these are the contents of header lines. First, each &"encoded word"& is decoded
29608 from the Q or B encoding into a byte-string. Then, if provided with the name of
29609 a charset encoding, and if the &[iconv()]& function is available, an attempt is
29610 made  to translate the result to the named character set. If this fails, the
29611 binary string is returned with an error message.
29612
29613 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
29614 maximum MIME word length is enforced. The third argument is the target
29615 encoding, or NULL if no translation is wanted.
29616
29617 .cindex "binary zero" "in RFC 2047 decoding"
29618 .cindex "RFC 2047" "binary zero in"
29619 If a binary zero is encountered in the decoded string, it is replaced by the
29620 contents of the &%zeroval%& argument. For use with Exim headers, the value must
29621 not be 0 because header lines are handled as zero-terminated strings.
29622
29623 The function returns the result of processing the string, zero-terminated; if
29624 &%lenptr%& is not NULL, the length of the result is set in the variable to
29625 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
29626
29627 If an error is encountered, the function returns NULL and uses the &%error%&
29628 argument to return an error message. The variable pointed to by &%error%& is
29629 set to NULL if there is no error; it may be set non-NULL even when the function
29630 returns a non-NULL value if decoding was successful, but there was a problem
29631 with translation.
29632
29633
29634 .vitem &*int&~smtp_fflush(void)*&
29635 This function is used in conjunction with &'smtp_printf()'&, as described
29636 below.
29637
29638 .vitem &*void&~smtp_printf(char&~*,&~...)*&
29639 The arguments of this function are like &[printf()]&; it writes to the SMTP
29640 output stream. You should use this function only when there is an SMTP output
29641 stream, that is, when the incoming message is being received via interactive
29642 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
29643 is FALSE. If you want to test for an incoming message from another host (as
29644 opposed to a local process that used the &%-bs%& command line option), you can
29645 test the value of &%sender_host_address%&, which is non-NULL when a remote host
29646 is involved.
29647
29648 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
29649 output function, so it can be used for all forms of SMTP connection.
29650
29651 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
29652 must start with an appropriate response code: 550 if you are going to return
29653 LOCAL_SCAN_REJECT, 451 if you are going to return
29654 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
29655 initial lines of a multi-line response, the code must be followed by a hyphen
29656 to indicate that the line is not the final response line. You must also ensure
29657 that the lines you write terminate with CRLF. For example:
29658 .code
29659 smtp_printf("550-this is some extra info\r\n");
29660 return LOCAL_SCAN_REJECT;
29661 .endd
29662 Note that you can also create multi-line responses by including newlines in
29663 the data returned via the &%return_text%& argument. The added value of using
29664 &'smtp_printf()'& is that, for instance, you could introduce delays between
29665 multiple output lines.
29666
29667 The &'smtp_printf()'& function does not return any error indication, because it
29668 does not automatically flush pending output, and therefore does not test
29669 the state of the stream. (In the main code of Exim, flushing and error
29670 detection is done when Exim is ready for the next SMTP input command.) If
29671 you want to flush the output and check for an error (for example, the
29672 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
29673 arguments. It flushes the output stream, and returns a non-zero value if there
29674 is an error.
29675
29676 .vitem &*void&~*store_get(int)*&
29677 This function accesses Exim's internal store (memory) manager. It gets a new
29678 chunk of memory whose size is given by the argument. Exim bombs out if it ever
29679 runs out of memory. See the next section for a discussion of memory handling.
29680
29681 .vitem &*void&~*store_get_perm(int)*&
29682 This function is like &'store_get()'&, but it always gets memory from the
29683 permanent pool. See the next section for a discussion of memory handling.
29684
29685 .vitem &*uschar&~*string_copy(uschar&~*string)*&
29686 See below.
29687
29688 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
29689 See below.
29690
29691 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
29692 These three functions create strings using Exim's dynamic memory facilities.
29693 The first makes a copy of an entire string. The second copies up to a maximum
29694 number of characters, indicated by the second argument. The third uses a format
29695 and insertion arguments to create a new string. In each case, the result is a
29696 pointer to a new string in the current memory pool. See the next section for
29697 more discussion.
29698 .endlist
29699
29700
29701
29702 .section "More about Exim's memory handling" "SECTmemhanloc"
29703 .cindex "&[local_scan()]& function" "memory handling"
29704 No function is provided for freeing memory, because that is never needed.
29705 The dynamic memory that Exim uses when receiving a message is automatically
29706 recycled if another message is received by the same process (this applies only
29707 to incoming SMTP connections &-- other input methods can supply only one
29708 message at a time). After receiving the last message, a reception process
29709 terminates.
29710
29711 Because it is recycled, the normal dynamic memory cannot be used for holding
29712 data that must be preserved over a number of incoming messages on the same SMTP
29713 connection. However, Exim in fact uses two pools of dynamic memory; the second
29714 one is not recycled, and can be used for this purpose.
29715
29716 If you want to allocate memory that remains available for subsequent messages
29717 in the same SMTP connection, you should set
29718 .code
29719 store_pool = POOL_PERM
29720 .endd
29721 before calling the function that does the allocation. There is no need to
29722 restore the value if you do not need to; however, if you do want to revert to
29723 the normal pool, you can either restore the previous value of &%store_pool%& or
29724 set it explicitly to POOL_MAIN.
29725
29726 The pool setting applies to all functions that get dynamic memory, including
29727 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
29728 There is also a convenience function called &'store_get_perm()'& that gets a
29729 block of memory from the permanent pool while preserving the value of
29730 &%store_pool%&.
29731 .ecindex IIDlosca
29732
29733
29734
29735
29736 . ////////////////////////////////////////////////////////////////////////////
29737 . ////////////////////////////////////////////////////////////////////////////
29738
29739 .chapter "System-wide message filtering" "CHAPsystemfilter"
29740 .scindex IIDsysfil1 "filter" "system filter"
29741 .scindex IIDsysfil2 "filtering all mail"
29742 .scindex IIDsysfil3 "system filter"
29743 The previous chapters (on ACLs and the local scan function) describe checks
29744 that can be applied to messages before they are accepted by a host. There is
29745 also a mechanism for checking messages once they have been received, but before
29746 they are delivered. This is called the &'system filter'&.
29747
29748 The system filter operates in a similar manner to users' filter files, but it
29749 is run just once per message (however many recipients the message has).
29750 It should not normally be used as a substitute for routing, because &%deliver%&
29751 commands in a system router provide new envelope recipient addresses.
29752 The system filter must be an Exim filter. It cannot be a Sieve filter.
29753
29754 The system filter is run at the start of a delivery attempt, before any routing
29755 is done. If a message fails to be completely delivered at the first attempt,
29756 the system filter is run again at the start of every retry.
29757 If you want your filter to do something only once per message, you can make use
29758 of the &%first_delivery%& condition in an &%if%& command in the filter to
29759 prevent it happening on retries.
29760
29761 .vindex "&$domain$&"
29762 .vindex "&$local_part$&"
29763 &*Warning*&: Because the system filter runs just once, variables that are
29764 specific to individual recipient addresses, such as &$local_part$& and
29765 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
29766 you want to run a centrally-specified filter for each recipient address
29767 independently, you can do so by setting up a suitable &(redirect)& router, as
29768 described in section &<<SECTperaddfil>>& below.
29769
29770
29771 .section "Specifying a system filter" "SECID212"
29772 .cindex "uid (user id)" "system filter"
29773 .cindex "gid (group id)" "system filter"
29774 The name of the file that contains the system filter must be specified by
29775 setting &%system_filter%&. If you want the filter to run under a uid and gid
29776 other than root, you must also set &%system_filter_user%& and
29777 &%system_filter_group%& as appropriate. For example:
29778 .code
29779 system_filter = /etc/mail/exim.filter
29780 system_filter_user = exim
29781 .endd
29782 If a system filter generates any deliveries directly to files or pipes (via the
29783 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
29784 specified by setting &%system_filter_file_transport%& and
29785 &%system_filter_pipe_transport%&, respectively. Similarly,
29786 &%system_filter_reply_transport%& must be set to handle any messages generated
29787 by the &%reply%& command.
29788
29789
29790 .section "Testing a system filter" "SECID213"
29791 You can run simple tests of a system filter in the same way as for a user
29792 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
29793 are permitted only in system filters are recognized.
29794
29795 If you want to test the combined effect of a system filter and a user filter,
29796 you can use both &%-bF%& and &%-bf%& on the same command line.
29797
29798
29799
29800 .section "Contents of a system filter" "SECID214"
29801 The language used to specify system filters is the same as for users' filter
29802 files. It is described in the separate end-user document &'Exim's interface to
29803 mail filtering'&. However, there are some additional features that are
29804 available only in system filters; these are described in subsequent sections.
29805 If they are encountered in a user's filter file or when testing with &%-bf%&,
29806 they cause errors.
29807
29808 .cindex "frozen messages" "manual thaw; testing in filter"
29809 There are two special conditions which, though available in users' filter
29810 files, are designed for use in system filters. The condition &%first_delivery%&
29811 is true only for the first attempt at delivering a message, and
29812 &%manually_thawed%& is true only if the message has been frozen, and
29813 subsequently thawed by an admin user. An explicit forced delivery counts as a
29814 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
29815
29816 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
29817 specify an &"unseen"& (non-significant) delivery, and that delivery does not
29818 succeed, it will not be tried again.
29819 If you want Exim to retry an unseen delivery until it succeeds, you should
29820 arrange to set it up every time the filter runs.
29821
29822 When a system filter finishes running, the values of the variables &$n0$& &--
29823 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
29824 users' filter files. Thus a system filter can, for example, set up &"scores"&
29825 to which users' filter files can refer.
29826
29827
29828
29829 .section "Additional variable for system filters" "SECID215"
29830 .vindex "&$recipients$&"
29831 The expansion variable &$recipients$&, containing a list of all the recipients
29832 of the message (separated by commas and white space), is available in system
29833 filters. It is not available in users' filters for privacy reasons.
29834
29835
29836
29837 .section "Defer, freeze, and fail commands for system filters" "SECID216"
29838 .cindex "freezing messages"
29839 .cindex "message" "freezing"
29840 .cindex "message" "forced failure"
29841 .cindex "&%fail%&" "in system filter"
29842 .cindex "&%freeze%& in system filter"
29843 .cindex "&%defer%& in system filter"
29844 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
29845 always available in system filters, but are not normally enabled in users'
29846 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
29847 for the &(redirect)& router.) These commands can optionally be followed by the
29848 word &%text%& and a string containing an error message, for example:
29849 .code
29850 fail text "this message looks like spam to me"
29851 .endd
29852 The keyword &%text%& is optional if the next character is a double quote.
29853
29854 The &%defer%& command defers delivery of the original recipients of the
29855 message. The &%fail%& command causes all the original recipients to be failed,
29856 and a bounce message to be created. The &%freeze%& command suspends all
29857 delivery attempts for the original recipients. In all cases, any new deliveries
29858 that are specified by the filter are attempted as normal after the filter has
29859 run.
29860
29861 The &%freeze%& command is ignored if the message has been manually unfrozen and
29862 not manually frozen since. This means that automatic freezing by a system
29863 filter can be used as a way of checking out suspicious messages. If a message
29864 is found to be all right, manually unfreezing it allows it to be delivered.
29865
29866 .cindex "log" "&%fail%& command log line"
29867 .cindex "&%fail%&" "log line; reducing"
29868 The text given with a fail command is used as part of the bounce message as
29869 well as being written to the log. If the message is quite long, this can fill
29870 up a lot of log space when such failures are common. To reduce the size of the
29871 log message, Exim interprets the text in a special way if it starts with the
29872 two characters &`<<`& and contains &`>>`& later. The text between these two
29873 strings is written to the log, and the rest of the text is used in the bounce
29874 message. For example:
29875 .code
29876 fail "<<filter test 1>>Your message is rejected \
29877      because it contains attachments that we are \
29878      not prepared to receive."
29879 .endd
29880
29881 .cindex "loop" "caused by &%fail%&"
29882 Take great care with the &%fail%& command when basing the decision to fail on
29883 the contents of the message, because the bounce message will of course include
29884 the contents of the original message and will therefore trigger the &%fail%&
29885 command again (causing a mail loop) unless steps are taken to prevent this.
29886 Testing the &%error_message%& condition is one way to prevent this. You could
29887 use, for example
29888 .code
29889 if $message_body contains "this is spam" and not error_message
29890 then fail text "spam is not wanted here" endif
29891 .endd
29892 though of course that might let through unwanted bounce messages. The
29893 alternative is clever checking of the body and/or headers to detect bounces
29894 generated by the filter.
29895
29896 The interpretation of a system filter file ceases after a
29897 &%defer%&,
29898 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
29899 set up earlier in the filter file are honoured, so you can use a sequence such
29900 as
29901 .code
29902 mail ...
29903 freeze
29904 .endd
29905 to send a specified message when the system filter is freezing (or deferring or
29906 failing) a message. The normal deliveries for the message do not, of course,
29907 take place.
29908
29909
29910
29911 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
29912 .cindex "header lines" "adding; in system filter"
29913 .cindex "header lines" "removing; in system filter"
29914 .cindex "filter" "header lines; adding/removing"
29915 Two filter commands that are available only in system filters are:
29916 .code
29917 headers add <string>
29918 headers remove <string>
29919 .endd
29920 The argument for the &%headers add%& is a string that is expanded and then
29921 added to the end of the message's headers. It is the responsibility of the
29922 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
29923 space is ignored, and if the string is otherwise empty, or if the expansion is
29924 forced to fail, the command has no effect.
29925
29926 You can use &"\n"& within the string, followed by white space, to specify
29927 continued header lines. More than one header may be added in one command by
29928 including &"\n"& within the string without any following white space. For
29929 example:
29930 .code
29931 headers add "X-header-1: ....\n  \
29932              continuation of X-header-1 ...\n\
29933              X-header-2: ...."
29934 .endd
29935 Note that the header line continuation white space after the first newline must
29936 be placed before the backslash that continues the input string, because white
29937 space after input continuations is ignored.
29938
29939 The argument for &%headers remove%& is a colon-separated list of header names.
29940 This command applies only to those headers that are stored with the message;
29941 those that are added at delivery time (such as &'Envelope-To:'& and
29942 &'Return-Path:'&) cannot be removed by this means. If there is more than one
29943 header with the same name, they are all removed.
29944
29945 The &%headers%& command in a system filter makes an immediate change to the set
29946 of header lines that was received with the message (with possible additions
29947 from ACL processing). Subsequent commands in the system filter operate on the
29948 modified set, which also forms the basis for subsequent message delivery.
29949 Unless further modified during routing or transporting, this set of headers is
29950 used for all recipients of the message.
29951
29952 During routing and transporting, the variables that refer to the contents of
29953 header lines refer only to those lines that are in this set. Thus, header lines
29954 that are added by a system filter are visible to users' filter files and to all
29955 routers and transports. This contrasts with the manipulation of header lines by
29956 routers and transports, which is not immediate, but which instead is saved up
29957 until the message is actually being written (see section
29958 &<<SECTheadersaddrem>>&).
29959
29960 If the message is not delivered at the first attempt, header lines that were
29961 added by the system filter are stored with the message, and so are still
29962 present at the next delivery attempt. Header lines that were removed are still
29963 present, but marked &"deleted"& so that they are not transported with the
29964 message. For this reason, it is usual to make the &%headers%& command
29965 conditional on &%first_delivery%& so that the set of header lines is not
29966 modified more than once.
29967
29968 Because header modification in a system filter acts immediately, you have to
29969 use an indirect approach if you want to modify the contents of a header line.
29970 For example:
29971 .code
29972 headers add "Old-Subject: $h_subject:"
29973 headers remove "Subject"
29974 headers add "Subject: new subject (was: $h_old-subject:)"
29975 headers remove "Old-Subject"
29976 .endd
29977
29978
29979
29980 .section "Setting an errors address in a system filter" "SECID217"
29981 .cindex "envelope sender"
29982 In a system filter, if a &%deliver%& command is followed by
29983 .code
29984 errors_to <some address>
29985 .endd
29986 in order to change the envelope sender (and hence the error reporting) for that
29987 delivery, any address may be specified. (In a user filter, only the current
29988 user's address can be set.) For example, if some mail is being monitored, you
29989 might use
29990 .code
29991 unseen deliver monitor@spying.example errors_to root@local.example
29992 .endd
29993 to take a copy which would not be sent back to the normal error reporting
29994 address if its delivery failed.
29995
29996
29997
29998 .section "Per-address filtering" "SECTperaddfil"
29999 .vindex "&$domain$&"
30000 .vindex "&$local_part$&"
30001 In contrast to the system filter, which is run just once per message for each
30002 delivery attempt, it is also possible to set up a system-wide filtering
30003 operation that runs once for each recipient address. In this case, variables
30004 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
30005 filter file could be made dependent on them. This is an example of a router
30006 which implements such a filter:
30007 .code
30008 central_filter:
30009   check_local_user
30010   driver = redirect
30011   domains = +local_domains
30012   file = /central/filters/$local_part
30013   no_verify
30014   allow_filter
30015   allow_freeze
30016 .endd
30017 The filter is run in a separate process under its own uid. Therefore, either
30018 &%check_local_user%& must be set (as above), in which case the filter is run as
30019 the local user, or the &%user%& option must be used to specify which user to
30020 use. If both are set, &%user%& overrides.
30021
30022 Care should be taken to ensure that none of the commands in the filter file
30023 specify a significant delivery if the message is to go on to be delivered to
30024 its intended recipient. The router will not then claim to have dealt with the
30025 address, so it will be passed on to subsequent routers to be delivered in the
30026 normal way.
30027 .ecindex IIDsysfil1
30028 .ecindex IIDsysfil2
30029 .ecindex IIDsysfil3
30030
30031
30032
30033
30034
30035
30036 . ////////////////////////////////////////////////////////////////////////////
30037 . ////////////////////////////////////////////////////////////////////////////
30038
30039 .chapter "Message processing" "CHAPmsgproc"
30040 .scindex IIDmesproc "message" "general processing"
30041 Exim performs various transformations on the sender and recipient addresses of
30042 all messages that it handles, and also on the messages' header lines. Some of
30043 these are optional and configurable, while others always take place. All of
30044 this processing, except rewriting as a result of routing, and the addition or
30045 removal of header lines while delivering, happens when a message is received,
30046 before it is placed on Exim's queue.
30047
30048 Some of the automatic processing takes place by default only for
30049 &"locally-originated"& messages. This adjective is used to describe messages
30050 that are not received over TCP/IP, but instead are passed to an Exim process on
30051 its standard input. This includes the interactive &"local SMTP"& case that is
30052 set up by the &%-bs%& command line option.
30053
30054 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
30055 or ::1) are not considered to be locally-originated. Exim does not treat the
30056 loopback interface specially in any way.
30057
30058 If you want the loopback interface to be treated specially, you must ensure
30059 that there are appropriate entries in your ACLs.
30060
30061
30062
30063
30064 .section "Submission mode for non-local messages" "SECTsubmodnon"
30065 .cindex "message" "submission"
30066 .cindex "submission mode"
30067 Processing that happens automatically for locally-originated messages (unless
30068 &%suppress_local_fixups%& is set) can also be requested for messages that are
30069 received over TCP/IP. The term &"submission mode"& is used to describe this
30070 state. Submission mode is set by the modifier
30071 .code
30072 control = submission
30073 .endd
30074 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
30075 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
30076 a local submission, and is normally used when the source of the message is
30077 known to be an MUA running on a client host (as opposed to an MTA). For
30078 example, to set submission mode for messages originating on the IPv4 loopback
30079 interface, you could include the following in the MAIL ACL:
30080 .code
30081 warn  hosts = 127.0.0.1
30082       control = submission
30083 .endd
30084 .cindex "&%sender_retain%& submission option"
30085 There are some options that can be used when setting submission mode. A slash
30086 is used to separate options. For example:
30087 .code
30088 control = submission/sender_retain
30089 .endd
30090 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
30091 true and &%local_from_check%& false for the current incoming message. The first
30092 of these allows an existing &'Sender:'& header in the message to remain, and
30093 the second suppresses the check to ensure that &'From:'& matches the
30094 authenticated sender. With this setting, Exim still fixes up messages by adding
30095 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
30096 attempt to check sender authenticity in header lines.
30097
30098 When &%sender_retain%& is not set, a submission mode setting may specify a
30099 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
30100 example:
30101 .code
30102 control = submission/domain=some.domain
30103 .endd
30104 The domain may be empty. How this value is used is described in sections
30105 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
30106 that allows you to specify the user's full name for inclusion in a created
30107 &'Sender:'& or &'From:'& header line. For example:
30108 .code
30109 accept authenticated = *
30110        control = submission/domain=wonderland.example/\
30111                             name=${lookup {$authenticated_id} \
30112                                    lsearch {/etc/exim/namelist}}
30113 .endd
30114 Because the name may contain any characters, including slashes, the &%name%&
30115 option must be given last. The remainder of the string is used as the name. For
30116 the example above, if &_/etc/exim/namelist_& contains:
30117 .code
30118 bigegg:  Humpty Dumpty
30119 .endd
30120 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
30121 line would be:
30122 .code
30123 Sender: Humpty Dumpty <bigegg@wonderland.example>
30124 .endd
30125 .cindex "return path" "in submission mode"
30126 By default, submission mode forces the return path to the same address as is
30127 used to create the &'Sender:'& header. However, if &%sender_retain%& is
30128 specified, the return path is also left unchanged.
30129
30130 &*Note*&: The changes caused by submission mode take effect after the predata
30131 ACL. This means that any sender checks performed before the fix-ups use the
30132 untrusted sender address specified by the user, not the trusted sender address
30133 specified by submission mode. Although this might be slightly unexpected, it
30134 does mean that you can configure ACL checks to spot that a user is trying to
30135 spoof another's address.
30136
30137 .section "Line endings" "SECTlineendings"
30138 .cindex "line endings"
30139 .cindex "carriage return"
30140 .cindex "linefeed"
30141 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
30142 linefeed) is the line ending for messages transmitted over the Internet using
30143 SMTP over TCP/IP. However, within individual operating systems, different
30144 conventions are used. For example, Unix-like systems use just LF, but others
30145 use CRLF or just CR.
30146
30147 Exim was designed for Unix-like systems, and internally, it stores messages
30148 using the system's convention of a single LF as a line terminator. When
30149 receiving a message, all line endings are translated to this standard format.
30150 Originally, it was thought that programs that passed messages directly to an
30151 MTA within an operating system would use that system's convention. Experience
30152 has shown that this is not the case; for example, there are Unix applications
30153 that use CRLF in this circumstance. For this reason, and for compatibility with
30154 other MTAs, the way Exim handles line endings for all messages is now as
30155 follows:
30156
30157 .ilist
30158 LF not preceded by CR is treated as a line ending.
30159 .next
30160 CR is treated as a line ending; if it is immediately followed by LF, the LF
30161 is ignored.
30162 .next
30163 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
30164 nor a local message in the state where a line containing only a dot is a
30165 terminator.
30166 .next
30167 If a bare CR is encountered within a header line, an extra space is added after
30168 the line terminator so as not to end the header line. The reasoning behind this
30169 is that bare CRs in header lines are most likely either to be mistakes, or
30170 people trying to play silly games.
30171 .next
30172 If the first header line received in a message ends with CRLF, a subsequent
30173 bare LF in a header line is treated in the same way as a bare CR in a header
30174 line.
30175 .endlist
30176
30177
30178
30179
30180
30181 .section "Unqualified addresses" "SECID218"
30182 .cindex "unqualified addresses"
30183 .cindex "address" "qualification"
30184 By default, Exim expects every envelope address it receives from an external
30185 host to be fully qualified. Unqualified addresses cause negative responses to
30186 SMTP commands. However, because SMTP is used as a means of transporting
30187 messages from MUAs running on personal workstations, there is sometimes a
30188 requirement to accept unqualified addresses from specific hosts or IP networks.
30189
30190 Exim has two options that separately control which hosts may send unqualified
30191 sender or recipient addresses in SMTP commands, namely
30192 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
30193 cases, if an unqualified address is accepted, it is qualified by adding the
30194 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
30195
30196 .oindex "&%qualify_domain%&"
30197 .oindex "&%qualify_recipient%&"
30198 Unqualified addresses in header lines are automatically qualified for messages
30199 that are locally originated, unless the &%-bnq%& option is given on the command
30200 line. For messages received over SMTP, unqualified addresses in header lines
30201 are qualified only if unqualified addresses are permitted in SMTP commands. In
30202 other words, such qualification is also controlled by
30203 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
30204
30205
30206
30207
30208 .section "The UUCP From line" "SECID219"
30209 .cindex "&""From""& line"
30210 .cindex "UUCP" "&""From""& line"
30211 .cindex "sender" "address"
30212 .oindex "&%uucp_from_pattern%&"
30213 .oindex "&%uucp_from_sender%&"
30214 .cindex "envelope sender"
30215 .cindex "Sendmail compatibility" "&""From""& line"
30216 Messages that have come from UUCP (and some other applications) often begin
30217 with a line containing the envelope sender and a timestamp, following the word
30218 &"From"&. Examples of two common formats are:
30219 .code
30220 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
30221 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
30222 .endd
30223 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
30224 Exim recognizes such lines at the start of messages that are submitted to it
30225 via the command line (that is, on the standard input). It does not recognize
30226 such lines in incoming SMTP messages, unless the sending host matches
30227 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
30228 and &%ignore_fromline_local%& is set. The recognition is controlled by a
30229 regular expression that is defined by the &%uucp_from_pattern%& option, whose
30230 default value matches the two common cases shown above and puts the address
30231 that follows &"From"& into &$1$&.
30232
30233 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
30234 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
30235 a trusted user, the message's sender address is constructed by expanding the
30236 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
30237 then parsed as an RFC 2822 address. If there is no domain, the local part is
30238 qualified with &%qualify_domain%& unless it is the empty string. However, if
30239 the command line &%-f%& option is used, it overrides the &"From"& line.
30240
30241 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
30242 sender address is not changed. This is also the case for incoming SMTP messages
30243 that are permitted to contain &"From"& lines.
30244
30245 Only one &"From"& line is recognized. If there is more than one, the second is
30246 treated as a data line that starts the body of the message, as it is not valid
30247 as a header line. This also happens if a &"From"& line is present in an
30248 incoming SMTP message from a source that is not permitted to send them.
30249
30250
30251
30252 .section "Resent- header lines" "SECID220"
30253 .cindex "&%Resent-%& header lines"
30254 RFC 2822 makes provision for sets of header lines starting with the string
30255 &`Resent-`& to be added to a message when it is resent by the original
30256 recipient to somebody else. These headers are &'Resent-Date:'&,
30257 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
30258 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
30259
30260 .blockquote
30261 &'Resent fields are strictly informational. They MUST NOT be used in the normal
30262 processing of replies or other such automatic actions on messages.'&
30263 .endblockquote
30264
30265 This leaves things a bit vague as far as other processing actions such as
30266 address rewriting are concerned. Exim treats &%Resent-%& header lines as
30267 follows:
30268
30269 .ilist
30270 A &'Resent-From:'& line that just contains the login id of the submitting user
30271 is automatically rewritten in the same way as &'From:'& (see below).
30272 .next
30273 If there's a rewriting rule for a particular header line, it is also applied to
30274 &%Resent-%& header lines of the same type. For example, a rule that rewrites
30275 &'From:'& also rewrites &'Resent-From:'&.
30276 .next
30277 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
30278 also removed.
30279 .next
30280 For a locally-submitted message,
30281 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
30282 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
30283 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
30284 included in log lines in this case.
30285 .next
30286 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
30287 &%Resent-%& header lines are present.
30288 .endlist
30289
30290
30291
30292
30293 .section "The Auto-Submitted: header line" "SECID221"
30294 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
30295 includes the header line:
30296 .code
30297 Auto-Submitted: auto-replied
30298 .endd
30299
30300 .section "The Bcc: header line" "SECID222"
30301 .cindex "&'Bcc:'& header line"
30302 If Exim is called with the &%-t%& option, to take recipient addresses from a
30303 message's header, it removes any &'Bcc:'& header line that may exist (after
30304 extracting its addresses). If &%-t%& is not present on the command line, any
30305 existing &'Bcc:'& is not removed.
30306
30307
30308 .section "The Date: header line" "SECID223"
30309 .cindex "&'Date:'& header line"
30310 If a locally-generated or submission-mode message has no &'Date:'& header line,
30311 Exim adds one, using the current date and time, unless the
30312 &%suppress_local_fixups%& control has been specified.
30313
30314 .section "The Delivery-date: header line" "SECID224"
30315 .cindex "&'Delivery-date:'& header line"
30316 .oindex "&%delivery_date_remove%&"
30317 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
30318 set. Exim can be configured to add them to the final delivery of messages. (See
30319 the generic &%delivery_date_add%& transport option.) They should not be present
30320 in messages in transit. If the &%delivery_date_remove%& configuration option is
30321 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
30322 messages.
30323
30324
30325 .section "The Envelope-to: header line" "SECID225"
30326 .cindex "&'Envelope-to:'& header line"
30327 .oindex "&%envelope_to_remove%&"
30328 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
30329 Exim can be configured to add them to the final delivery of messages. (See the
30330 generic &%envelope_to_add%& transport option.) They should not be present in
30331 messages in transit. If the &%envelope_to_remove%& configuration option is set
30332 (the default), Exim removes &'Envelope-to:'& header lines from incoming
30333 messages.
30334
30335
30336 .section "The From: header line" "SECTthefrohea"
30337 .cindex "&'From:'& header line"
30338 .cindex "Sendmail compatibility" "&""From""& line"
30339 .cindex "message" "submission"
30340 .cindex "submission mode"
30341 If a submission-mode message does not contain a &'From:'& header line, Exim
30342 adds one if either of the following conditions is true:
30343
30344 .ilist
30345 The envelope sender address is not empty (that is, this is not a bounce
30346 message). The added header line copies the envelope sender address.
30347 .next
30348 .vindex "&$authenticated_id$&"
30349 The SMTP session is authenticated and &$authenticated_id$& is not empty.
30350 .olist
30351 .vindex "&$qualify_domain$&"
30352 If no domain is specified by the submission control, the local part is
30353 &$authenticated_id$& and the domain is &$qualify_domain$&.
30354 .next
30355 If a non-empty domain is specified by the submission control, the local
30356 part is &$authenticated_id$&, and the domain is the specified domain.
30357 .next
30358 If an empty domain is specified by the submission control,
30359 &$authenticated_id$& is assumed to be the complete address.
30360 .endlist
30361 .endlist
30362
30363 A non-empty envelope sender takes precedence.
30364
30365 If a locally-generated incoming message does not contain a &'From:'& header
30366 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
30367 containing the sender's address. The calling user's login name and full name
30368 are used to construct the address, as described in section &<<SECTconstr>>&.
30369 They are obtained from the password data by calling &[getpwuid()]& (but see the
30370 &%unknown_login%& configuration option). The address is qualified with
30371 &%qualify_domain%&.
30372
30373 For compatibility with Sendmail, if an incoming, non-SMTP message has a
30374 &'From:'& header line containing just the unqualified login name of the calling
30375 user, this is replaced by an address containing the user's login name and full
30376 name as described in section &<<SECTconstr>>&.
30377
30378
30379 .section "The Message-ID: header line" "SECID226"
30380 .cindex "&'Message-ID:'& header line"
30381 .cindex "message" "submission"
30382 .oindex "&%message_id_header_text%&"
30383 If a locally-generated or submission-mode incoming message does not contain a
30384 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
30385 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
30386 to the message. If there are any &'Resent-:'& headers in the message, it
30387 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
30388 message id, preceded by the letter E to ensure it starts with a letter, and
30389 followed by @ and the primary host name. Additional information can be included
30390 in this header line by setting the &%message_id_header_text%& and/or
30391 &%message_id_header_domain%& options.
30392
30393
30394 .section "The Received: header line" "SECID227"
30395 .cindex "&'Received:'& header line"
30396 A &'Received:'& header line is added at the start of every message. The
30397 contents are defined by the &%received_header_text%& configuration option, and
30398 Exim automatically adds a semicolon and a timestamp to the configured string.
30399
30400 The &'Received:'& header is generated as soon as the message's header lines
30401 have been received. At this stage, the timestamp in the &'Received:'& header
30402 line is the time that the message started to be received. This is the value
30403 that is seen by the DATA ACL and by the &[local_scan()]& function.
30404
30405 Once a message is accepted, the timestamp in the &'Received:'& header line is
30406 changed to the time of acceptance, which is (apart from a small delay while the
30407 -H spool file is written) the earliest time at which delivery could start.
30408
30409
30410 .section "The References: header line" "SECID228"
30411 .cindex "&'References:'& header line"
30412 Messages created by the &(autoreply)& transport include a &'References:'&
30413 header line. This is constructed according to the rules that are described in
30414 section 3.64 of RFC 2822 (which states that replies should contain such a
30415 header line), and section 3.14 of RFC 3834 (which states that automatic
30416 responses are not different in this respect). However, because some mail
30417 processing software does not cope well with very long header lines, no more
30418 than 12 message IDs are copied from the &'References:'& header line in the
30419 incoming message. If there are more than 12, the first one and then the final
30420 11 are copied, before adding the message ID of the incoming message.
30421
30422
30423
30424 .section "The Return-path: header line" "SECID229"
30425 .cindex "&'Return-path:'& header line"
30426 .oindex "&%return_path_remove%&"
30427 &'Return-path:'& header lines are defined as something an MTA may insert when
30428 it does the final delivery of messages. (See the generic &%return_path_add%&
30429 transport option.) Therefore, they should not be present in messages in
30430 transit. If the &%return_path_remove%& configuration option is set (the
30431 default), Exim removes &'Return-path:'& header lines from incoming messages.
30432
30433
30434
30435 .section "The Sender: header line" "SECTthesenhea"
30436 .cindex "&'Sender:'& header line"
30437 .cindex "message" "submission"
30438 For a locally-originated message from an untrusted user, Exim may remove an
30439 existing &'Sender:'& header line, and it may add a new one. You can modify
30440 these actions by setting the &%local_sender_retain%& option true, the
30441 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
30442 control setting.
30443
30444 When a local message is received from an untrusted user and
30445 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
30446 control has not been set, a check is made to see if the address given in the
30447 &'From:'& header line is the correct (local) sender of the message. The address
30448 that is expected has the login name as the local part and the value of
30449 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
30450 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
30451 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
30452 line is added to the message.
30453
30454 If you set &%local_from_check%& false, this checking does not occur. However,
30455 the removal of an existing &'Sender:'& line still happens, unless you also set
30456 &%local_sender_retain%& to be true. It is not possible to set both of these
30457 options true at the same time.
30458
30459 .cindex "submission mode"
30460 By default, no processing of &'Sender:'& header lines is done for messages
30461 received over TCP/IP or for messages submitted by trusted users. However, when
30462 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
30463 not specified on the submission control, the following processing takes place:
30464
30465 .vindex "&$authenticated_id$&"
30466 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
30467 authenticated, and &$authenticated_id$& is not empty, a sender address is
30468 created as follows:
30469
30470 .ilist
30471 .vindex "&$qualify_domain$&"
30472 If no domain is specified by the submission control, the local part is
30473 &$authenticated_id$& and the domain is &$qualify_domain$&.
30474 .next
30475 If a non-empty domain is specified by the submission control, the local part
30476 is &$authenticated_id$&, and the domain is the specified domain.
30477 .next
30478 If an empty domain is specified by the submission control,
30479 &$authenticated_id$& is assumed to be the complete address.
30480 .endlist
30481
30482 This address is compared with the address in the &'From:'& header line. If they
30483 are different, a &'Sender:'& header line containing the created address is
30484 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
30485 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
30486
30487 .cindex "return path" "created from &'Sender:'&"
30488 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
30489 the message (the envelope sender address) is changed to be the same address,
30490 except in the case of submission mode when &%sender_retain%& is specified.
30491
30492
30493
30494 .section "Adding and removing header lines in routers and transports" &&&
30495          "SECTheadersaddrem"
30496 .cindex "header lines" "adding; in router or transport"
30497 .cindex "header lines" "removing; in router or transport"
30498 When a message is delivered, the addition and removal of header lines can be
30499 specified in a system filter, or on any of the routers and transports that
30500 process the message. Section &<<SECTaddremheasys>>& contains details about
30501 modifying headers in a system filter. Header lines can also be added in an ACL
30502 as a message is received (see section &<<SECTaddheadacl>>&).
30503
30504 In contrast to what happens in a system filter, header modifications that are
30505 specified on routers and transports apply only to the particular recipient
30506 addresses that are being processed by those routers and transports. These
30507 changes do not actually take place until a copy of the message is being
30508 transported. Therefore, they do not affect the basic set of header lines, and
30509 they do not affect the values of the variables that refer to header lines.
30510
30511 &*Note*&: In particular, this means that any expansions in the configuration of
30512 the transport cannot refer to the modified header lines, because such
30513 expansions all occur before the message is actually transported.
30514
30515 For both routers and transports, the result of expanding a &%headers_add%&
30516 option must be in the form of one or more RFC 2822 header lines, separated by
30517 newlines (coded as &"\n"&). For example:
30518 .code
30519 headers_add = X-added-header: added by $primary_hostname\n\
30520               X-added-second: another added header line
30521 .endd
30522 Exim does not check the syntax of these added header lines.
30523
30524 The result of expanding &%headers_remove%& must consist of a colon-separated
30525 list of header names. This is confusing, because header names themselves are
30526 often terminated by colons. In this case, the colons are the list separators,
30527 not part of the names. For example:
30528 .code
30529 headers_remove = return-receipt-to:acknowledge-to
30530 .endd
30531 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
30532 is expanded at routing time, and then associated with all addresses that are
30533 accepted by that router, and also with any new addresses that it generates. If
30534 an address passes through several routers as a result of aliasing or
30535 forwarding, the changes are cumulative.
30536
30537 .oindex "&%unseen%&"
30538 However, this does not apply to multiple routers that result from the use of
30539 the &%unseen%& option. Any header modifications that were specified by the
30540 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
30541
30542 Addresses that end up with different &%headers_add%& or &%headers_remove%&
30543 settings cannot be delivered together in a batch, so a transport is always
30544 dealing with a set of addresses that have the same header-processing
30545 requirements.
30546
30547 The transport starts by writing the original set of header lines that arrived
30548 with the message, possibly modified by the system filter. As it writes out
30549 these lines, it consults the list of header names that were attached to the
30550 recipient address(es) by &%headers_remove%& options in routers, and it also
30551 consults the transport's own &%headers_remove%& option. Header lines whose
30552 names are on either of these lists are not written out. If there are multiple
30553 instances of any listed header, they are all skipped.
30554
30555 After the remaining original header lines have been written, new header
30556 lines that were specified by routers' &%headers_add%& options are written, in
30557 the order in which they were attached to the address. These are followed by any
30558 header lines specified by the transport's &%headers_add%& option.
30559
30560 This way of handling header line modifications in routers and transports has
30561 the following consequences:
30562
30563 .ilist
30564 The original set of header lines, possibly modified by the system filter,
30565 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
30566 to it, at all times.
30567 .next
30568 Header lines that are added by a router's
30569 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
30570 expansion syntax in subsequent routers or the transport.
30571 .next
30572 Conversely, header lines that are specified for removal by &%headers_remove%&
30573 in a router remain visible to subsequent routers and the transport.
30574 .next
30575 Headers added to an address by &%headers_add%& in a router cannot be removed by
30576 a later router or by a transport.
30577 .next
30578 An added header can refer to the contents of an original header that is to be
30579 removed, even it has the same name as the added header. For example:
30580 .code
30581 headers_remove = subject
30582 headers_add = Subject: new subject (was: $h_subject:)
30583 .endd
30584 .endlist
30585
30586 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
30587 for a &(redirect)& router that has the &%one_time%& option set.
30588
30589
30590
30591
30592
30593 .section "Constructed addresses" "SECTconstr"
30594 .cindex "address" "constructed"
30595 .cindex "constructed address"
30596 When Exim constructs a sender address for a locally-generated message, it uses
30597 the form
30598 .display
30599 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
30600 .endd
30601 For example:
30602 .code
30603 Zaphod Beeblebrox <zaphod@end.univ.example>
30604 .endd
30605 The user name is obtained from the &%-F%& command line option if set, or
30606 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
30607 &"gecos"& field from the password entry. If the &"gecos"& field contains an
30608 ampersand character, this is replaced by the login name with the first letter
30609 upper cased, as is conventional in a number of operating systems. See the
30610 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
30611 The &%unknown_username%& option can be used to specify user names in cases when
30612 there is no password file entry.
30613
30614 .cindex "RFC 2047"
30615 In all cases, the user name is made to conform to RFC 2822 by quoting all or
30616 parts of it if necessary. In addition, if it contains any non-printing
30617 characters, it is encoded as described in RFC 2047, which defines a way of
30618 including non-ASCII characters in header lines. The value of the
30619 &%headers_charset%& option specifies the name of the encoding that is used (the
30620 characters are assumed to be in this encoding). The setting of
30621 &%print_topbitchars%& controls whether characters with the top bit set (that
30622 is, with codes greater than 127) count as printing characters or not.
30623
30624
30625
30626 .section "Case of local parts" "SECID230"
30627 .cindex "case of local parts"
30628 .cindex "local part" "case of"
30629 RFC 2822 states that the case of letters in the local parts of addresses cannot
30630 be assumed to be non-significant. Exim preserves the case of local parts of
30631 addresses, but by default it uses a lower-cased form when it is routing,
30632 because on most Unix systems, usernames are in lower case and case-insensitive
30633 routing is required. However, any particular router can be made to use the
30634 original case for local parts by setting the &%caseful_local_part%& generic
30635 router option.
30636
30637 .cindex "mixed-case login names"
30638 If you must have mixed-case user names on your system, the best way to proceed,
30639 assuming you want case-independent handling of incoming email, is to set up
30640 your first router to convert incoming local parts in your domains to the
30641 correct case by means of a file lookup. For example:
30642 .code
30643 correct_case:
30644   driver = redirect
30645   domains = +local_domains
30646   data = ${lookup{$local_part}cdb\
30647               {/etc/usercased.cdb}{$value}fail}\
30648               @$domain
30649 .endd
30650 For this router, the local part is forced to lower case by the default action
30651 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
30652 up a new local part in the correct case. If you then set &%caseful_local_part%&
30653 on any subsequent routers which process your domains, they will operate on
30654 local parts with the correct case in a case-sensitive manner.
30655
30656
30657
30658 .section "Dots in local parts" "SECID231"
30659 .cindex "dot" "in local part"
30660 .cindex "local part" "dots in"
30661 RFC 2822 forbids empty components in local parts. That is, an unquoted local
30662 part may not begin or end with a dot, nor have two consecutive dots in the
30663 middle. However, it seems that many MTAs do not enforce this, so Exim permits
30664 empty components for compatibility.
30665
30666
30667
30668 .section "Rewriting addresses" "SECID232"
30669 .cindex "rewriting" "addresses"
30670 Rewriting of sender and recipient addresses, and addresses in headers, can
30671 happen automatically, or as the result of configuration options, as described
30672 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
30673 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
30674
30675 Automatic rewriting includes qualification, as mentioned above. The other case
30676 in which it can happen is when an incomplete non-local domain is given. The
30677 routing process may cause this to be expanded into the full domain name. For
30678 example, a header such as
30679 .code
30680 To: hare@teaparty
30681 .endd
30682 might get rewritten as
30683 .code
30684 To: hare@teaparty.wonderland.fict.example
30685 .endd
30686 Rewriting as a result of routing is the one kind of message processing that
30687 does not happen at input time, as it cannot be done until the address has
30688 been routed.
30689
30690 Strictly, one should not do &'any'& deliveries of a message until all its
30691 addresses have been routed, in case any of the headers get changed as a
30692 result of routing. However, doing this in practice would hold up many
30693 deliveries for unreasonable amounts of time, just because one address could not
30694 immediately be routed. Exim therefore does not delay other deliveries when
30695 routing of one or more addresses is deferred.
30696 .ecindex IIDmesproc
30697
30698
30699
30700 . ////////////////////////////////////////////////////////////////////////////
30701 . ////////////////////////////////////////////////////////////////////////////
30702
30703 .chapter "SMTP processing" "CHAPSMTP"
30704 .scindex IIDsmtpproc1 "SMTP" "processing details"
30705 .scindex IIDsmtpproc2 "LMTP" "processing details"
30706 Exim supports a number of different ways of using the SMTP protocol, and its
30707 LMTP variant, which is an interactive protocol for transferring messages into a
30708 closed mail store application. This chapter contains details of how SMTP is
30709 processed. For incoming mail, the following are available:
30710
30711 .ilist
30712 SMTP over TCP/IP (Exim daemon or &'inetd'&);
30713 .next
30714 SMTP over the standard input and output (the &%-bs%& option);
30715 .next
30716 Batched SMTP on the standard input (the &%-bS%& option).
30717 .endlist
30718
30719 For mail delivery, the following are available:
30720
30721 .ilist
30722 SMTP over TCP/IP (the &(smtp)& transport);
30723 .next
30724 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
30725 &"lmtp"&);
30726 .next
30727 LMTP over a pipe to a process running in the local host (the &(lmtp)&
30728 transport);
30729 .next
30730 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
30731 the &%use_bsmtp%& option set).
30732 .endlist
30733
30734 &'Batched SMTP'& is the name for a process in which batches of messages are
30735 stored in or read from files (or pipes), in a format in which SMTP commands are
30736 used to contain the envelope information.
30737
30738
30739
30740 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
30741 .cindex "SMTP" "outgoing over TCP/IP"
30742 .cindex "outgoing SMTP over TCP/IP"
30743 .cindex "LMTP" "over TCP/IP"
30744 .cindex "outgoing LMTP over TCP/IP"
30745 .cindex "EHLO"
30746 .cindex "HELO"
30747 .cindex "SIZE option on MAIL command"
30748 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
30749 The &%protocol%& option selects which protocol is to be used, but the actual
30750 processing is the same in both cases.
30751
30752 If, in response to its EHLO command, Exim is told that the SIZE
30753 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
30754 command. The value of <&'n'&> is the message size plus the value of the
30755 &%size_addition%& option (default 1024) to allow for additions to the message
30756 such as per-transport header lines, or changes made in a
30757 .cindex "transport" "filter"
30758 .cindex "filter" "transport filter"
30759 transport filter. If &%size_addition%& is set negative, the use of SIZE is
30760 suppressed.
30761
30762 If the remote server advertises support for PIPELINING, Exim uses the
30763 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
30764 required for the transaction.
30765
30766 If the remote server advertises support for the STARTTLS command, and Exim
30767 was built to support TLS encryption, it tries to start a TLS session unless the
30768 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
30769
30770 If the remote server advertises support for the AUTH command, Exim scans
30771 the authenticators configuration for any suitable client settings, as described
30772 in chapter &<<CHAPSMTPAUTH>>&.
30773
30774 .cindex "carriage return"
30775 .cindex "linefeed"
30776 Responses from the remote host are supposed to be terminated by CR followed by
30777 LF. However, there are known to be hosts that do not send CR characters, so in
30778 order to be able to interwork with such hosts, Exim treats LF on its own as a
30779 line terminator.
30780
30781 If a message contains a number of different addresses, all those with the same
30782 characteristics (for example, the same envelope sender) that resolve to the
30783 same set of hosts, in the same order, are sent in a single SMTP transaction,
30784 even if they are for different domains, unless there are more than the setting
30785 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
30786 they are split into groups containing no more than &%max_rcpt%&s addresses
30787 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
30788 in parallel sessions. The order of hosts with identical MX values is not
30789 significant when checking whether addresses can be batched in this way.
30790
30791 When the &(smtp)& transport suffers a temporary failure that is not
30792 message-related, Exim updates its transport-specific database, which contains
30793 records indexed by host name that remember which messages are waiting for each
30794 particular host. It also updates the retry database with new retry times.
30795
30796 .cindex "hints database" "retry keys"
30797 Exim's retry hints are based on host name plus IP address, so if one address of
30798 a multi-homed host is broken, it will soon be skipped most of the time.
30799 See the next section for more detail about error handling.
30800
30801 .cindex "SMTP" "passed connection"
30802 .cindex "SMTP" "batching over TCP/IP"
30803 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
30804 looks in the hints database for the transport to see if there are any queued
30805 messages waiting for the host to which it is connected. If it finds one, it
30806 creates a new Exim process using the &%-MC%& option (which can only be used by
30807 a process running as root or the Exim user) and passes the TCP/IP socket to it
30808 so that it can deliver another message using the same socket. The new process
30809 does only those deliveries that are routed to the connected host, and may in
30810 turn pass the socket on to a third process, and so on.
30811
30812 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
30813 limit the number of messages sent down a single TCP/IP connection.
30814
30815 .cindex "asterisk" "after IP address"
30816 The second and subsequent messages delivered down an existing connection are
30817 identified in the main log by the addition of an asterisk after the closing
30818 square bracket of the IP address.
30819
30820
30821
30822
30823 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
30824 .cindex "error" "in outgoing SMTP"
30825 .cindex "SMTP" "errors in outgoing"
30826 .cindex "host" "error"
30827 Three different kinds of error are recognized for outgoing SMTP: host errors,
30828 message errors, and recipient errors.
30829
30830 .vlist
30831 .vitem "&*Host errors*&"
30832 A host error is not associated with a particular message or with a
30833 particular recipient of a message. The host errors are:
30834
30835 .ilist
30836 Connection refused or timed out,
30837 .next
30838 Any error response code on connection,
30839 .next
30840 Any error response code to EHLO or HELO,
30841 .next
30842 Loss of connection at any time, except after &"."&,
30843 .next
30844 I/O errors at any time,
30845 .next
30846 Timeouts during the session, other than in response to MAIL, RCPT or
30847 the &"."& at the end of the data.
30848 .endlist ilist
30849
30850 For a host error, a permanent error response on connection, or in response to
30851 EHLO, causes all addresses routed to the host to be failed. Any other host
30852 error causes all addresses to be deferred, and retry data to be created for the
30853 host. It is not tried again, for any message, until its retry time arrives. If
30854 the current set of addresses are not all delivered in this run (to some
30855 alternative host), the message is added to the list of those waiting for this
30856 host, so if it is still undelivered when a subsequent successful delivery is
30857 made to the host, it will be sent down the same SMTP connection.
30858
30859 .vitem "&*Message errors*&"
30860 .cindex "message" "error"
30861 A message error is associated with a particular message when sent to a
30862 particular host, but not with a particular recipient of the message. The
30863 message errors are:
30864
30865 .ilist
30866 Any error response code to MAIL, DATA, or the &"."& that terminates
30867 the data,
30868 .next
30869 Timeout after MAIL,
30870 .next
30871 Timeout or loss of connection after the &"."& that terminates the data. A
30872 timeout after the DATA command itself is treated as a host error, as is loss of
30873 connection at any other time.
30874 .endlist ilist
30875
30876 For a message error, a permanent error response (5&'xx'&) causes all addresses
30877 to be failed, and a delivery error report to be returned to the sender. A
30878 temporary error response (4&'xx'&), or one of the timeouts, causes all
30879 addresses to be deferred. Retry data is not created for the host, but instead,
30880 a retry record for the combination of host plus message id is created. The
30881 message is not added to the list of those waiting for this host. This ensures
30882 that the failing message will not be sent to this host again until the retry
30883 time arrives. However, other messages that are routed to the host are not
30884 affected, so if it is some property of the message that is causing the error,
30885 it will not stop the delivery of other mail.
30886
30887 If the remote host specified support for the SIZE parameter in its response
30888 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
30889 over-large message will cause a message error because the error arrives as a
30890 response to MAIL.
30891
30892 .vitem "&*Recipient errors*&"
30893 .cindex "recipient" "error"
30894 A recipient error is associated with a particular recipient of a message. The
30895 recipient errors are:
30896
30897 .ilist
30898 Any error response to RCPT,
30899 .next
30900 Timeout after RCPT.
30901 .endlist
30902
30903 For a recipient error, a permanent error response (5&'xx'&) causes the
30904 recipient address to be failed, and a bounce message to be returned to the
30905 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
30906 address to be deferred, and routing retry data to be created for it. This is
30907 used to delay processing of the address in subsequent queue runs, until its
30908 routing retry time arrives. This applies to all messages, but because it
30909 operates only in queue runs, one attempt will be made to deliver a new message
30910 to the failing address before the delay starts to operate. This ensures that,
30911 if the failure is really related to the message rather than the recipient
30912 (&"message too big for this recipient"& is a possible example), other messages
30913 have a chance of getting delivered. If a delivery to the address does succeed,
30914 the retry information gets cleared, so all stuck messages get tried again, and
30915 the retry clock is reset.
30916
30917 The message is not added to the list of those waiting for this host. Use of the
30918 host for other messages is unaffected, and except in the case of a timeout,
30919 other recipients are processed independently, and may be successfully delivered
30920 in the current SMTP session. After a timeout it is of course impossible to
30921 proceed with the session, so all addresses get deferred. However, those other
30922 than the one that failed do not suffer any subsequent retry delays. Therefore,
30923 if one recipient is causing trouble, the others have a chance of getting
30924 through when a subsequent delivery attempt occurs before the failing
30925 recipient's retry time.
30926 .endlist
30927
30928 In all cases, if there are other hosts (or IP addresses) available for the
30929 current set of addresses (for example, from multiple MX records), they are
30930 tried in this run for any undelivered addresses, subject of course to their
30931 own retry data. In other words, recipient error retry data does not take effect
30932 until the next delivery attempt.
30933
30934 Some hosts have been observed to give temporary error responses to every
30935 MAIL command at certain times (&"insufficient space"& has been seen). It
30936 would be nice if such circumstances could be recognized, and defer data for the
30937 host itself created, but this is not possible within the current Exim design.
30938 What actually happens is that retry data for every (host, message) combination
30939 is created.
30940
30941 The reason that timeouts after MAIL and RCPT are treated specially is that
30942 these can sometimes arise as a result of the remote host's verification
30943 procedures. Exim makes this assumption, and treats them as if a temporary error
30944 response had been received. A timeout after &"."& is treated specially because
30945 it is known that some broken implementations fail to recognize the end of the
30946 message if the last character of the last line is a binary zero. Thus, it is
30947 helpful to treat this case as a message error.
30948
30949 Timeouts at other times are treated as host errors, assuming a problem with the
30950 host, or the connection to it. If a timeout after MAIL, RCPT,
30951 or &"."& is really a connection problem, the assumption is that at the next try
30952 the timeout is likely to occur at some other point in the dialogue, causing it
30953 then to be treated as a host error.
30954
30955 There is experimental evidence that some MTAs drop the connection after the
30956 terminating &"."& if they do not like the contents of the message for some
30957 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
30958 should be given. That is why Exim treats this case as a message rather than a
30959 host error, in order not to delay other messages to the same host.
30960
30961
30962
30963
30964 .section "Incoming SMTP messages over TCP/IP" "SECID233"
30965 .cindex "SMTP" "incoming over TCP/IP"
30966 .cindex "incoming SMTP over TCP/IP"
30967 .cindex "inetd"
30968 .cindex "daemon"
30969 Incoming SMTP messages can be accepted in one of two ways: by running a
30970 listening daemon, or by using &'inetd'&. In the latter case, the entry in
30971 &_/etc/inetd.conf_& should be like this:
30972 .code
30973 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
30974 .endd
30975 Exim distinguishes between this case and the case of a locally running user
30976 agent using the &%-bs%& option by checking whether or not the standard input is
30977 a socket. When it is, either the port must be privileged (less than 1024), or
30978 the caller must be root or the Exim user. If any other user passes a socket
30979 with an unprivileged port number, Exim prints a message on the standard error
30980 stream and exits with an error code.
30981
30982 By default, Exim does not make a log entry when a remote host connects or
30983 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
30984 unexpected. It can be made to write such log entries by setting the
30985 &%smtp_connection%& log selector.
30986
30987 .cindex "carriage return"
30988 .cindex "linefeed"
30989 Commands from the remote host are supposed to be terminated by CR followed by
30990 LF. However, there are known to be hosts that do not send CR characters. In
30991 order to be able to interwork with such hosts, Exim treats LF on its own as a
30992 line terminator.
30993 Furthermore, because common code is used for receiving messages from all
30994 sources, a CR on its own is also interpreted as a line terminator. However, the
30995 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
30996
30997 .cindex "EHLO" "invalid data"
30998 .cindex "HELO" "invalid data"
30999 One area that sometimes gives rise to problems concerns the EHLO or
31000 HELO commands. Some clients send syntactically invalid versions of these
31001 commands, which Exim rejects by default. (This is nothing to do with verifying
31002 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
31003 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
31004 match the broken hosts that send invalid commands.
31005
31006 .cindex "SIZE option on MAIL command"
31007 .cindex "MAIL" "SIZE option"
31008 The amount of disk space available is checked whenever SIZE is received on
31009 a MAIL command, independently of whether &%message_size_limit%& or
31010 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
31011 false. A temporary error is given if there is not enough space. If
31012 &%check_spool_space%& is set, the check is for that amount of space plus the
31013 value given with SIZE, that is, it checks that the addition of the incoming
31014 message will not reduce the space below the threshold.
31015
31016 When a message is successfully received, Exim includes the local message id in
31017 its response to the final &"."& that terminates the data. If the remote host
31018 logs this text it can help with tracing what has happened to a message.
31019
31020 The Exim daemon can limit the number of simultaneous incoming connections it is
31021 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
31022 number of simultaneous incoming connections from a single remote host (see the
31023 &%smtp_accept_max_per_host%& option). Additional connection attempts are
31024 rejected using the SMTP temporary error code 421.
31025
31026 The Exim daemon does not rely on the SIGCHLD signal to detect when a
31027 subprocess has finished, as this can get lost at busy times. Instead, it looks
31028 for completed subprocesses every time it wakes up. Provided there are other
31029 things happening (new incoming calls, starts of queue runs), completed
31030 processes will be noticed and tidied away. On very quiet systems you may
31031 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
31032 it will be noticed when the daemon next wakes up.
31033
31034 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
31035 and can also be set up to reject SMTP calls from non-reserved hosts at times of
31036 high system load &-- for details see the &%smtp_accept_reserve%&,
31037 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
31038 applies in both the daemon and &'inetd'& cases.
31039
31040 Exim normally starts a delivery process for each message received, though this
31041 can be varied by means of the &%-odq%& command line option and the
31042 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
31043 number of simultaneously running delivery processes started in this way from
31044 SMTP input can be limited by the &%smtp_accept_queue%& and
31045 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
31046 subsequently received messages are just put on the input queue without starting
31047 a delivery process.
31048
31049 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
31050 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
31051 started up from the &'inetd'& daemon, because in that case each connection is
31052 handled by an entirely independent Exim process. Control by load average is,
31053 however, available with &'inetd'&.
31054
31055 Exim can be configured to verify addresses in incoming SMTP commands as they
31056 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
31057 to rewrite addresses at this time &-- before any syntax checking is done. See
31058 section &<<SECTrewriteS>>&.
31059
31060 Exim can also be configured to limit the rate at which a client host submits
31061 MAIL and RCPT commands in a single SMTP session. See the
31062 &%smtp_ratelimit_hosts%& option.
31063
31064
31065
31066 .section "Unrecognized SMTP commands" "SECID234"
31067 .cindex "SMTP" "unrecognized commands"
31068 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
31069 commands during a single SMTP connection, it drops the connection after sending
31070 the error response to the last command. The default value for
31071 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
31072 abuse that subvert web servers into making connections to SMTP ports; in these
31073 circumstances, a number of non-SMTP lines are sent first.
31074
31075
31076 .section "Syntax and protocol errors in SMTP commands" "SECID235"
31077 .cindex "SMTP" "syntax errors"
31078 .cindex "SMTP" "protocol errors"
31079 A syntax error is detected if an SMTP command is recognized, but there is
31080 something syntactically wrong with its data, for example, a malformed email
31081 address in a RCPT command. Protocol errors include invalid command
31082 sequencing such as RCPT before MAIL. If Exim receives more than
31083 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
31084 drops the connection after sending the error response to the last command. The
31085 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
31086 broken clients that loop sending bad commands (yes, it has been seen).
31087
31088
31089
31090 .section "Use of non-mail SMTP commands" "SECID236"
31091 .cindex "SMTP" "non-mail commands"
31092 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
31093 DATA. Exim counts such commands, and drops the connection if there are too
31094 many of them in a single SMTP session. This action catches some
31095 denial-of-service attempts and things like repeated failing AUTHs, or a mad
31096 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
31097 defines what &"too many"& means. Its default value is 10.
31098
31099 When a new message is expected, one occurrence of RSET is not counted. This
31100 allows a client to send one RSET between messages (this is not necessary,
31101 but some clients do it). Exim also allows one uncounted occurrence of HELO
31102 or EHLO, and one occurrence of STARTTLS between messages. After
31103 starting up a TLS session, another EHLO is expected, and so it too is not
31104 counted.
31105
31106 The first occurrence of AUTH in a connection, or immediately following
31107 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
31108 RCPT, DATA, and QUIT are counted.
31109
31110 You can control which hosts are subject to the limit set by
31111 &%smtp_accept_max_nonmail%& by setting
31112 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
31113 the limit apply to all hosts. This option means that you can exclude any
31114 specific badly-behaved hosts that you have to live with.
31115
31116
31117
31118
31119 .section "The VRFY and EXPN commands" "SECID237"
31120 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
31121 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
31122 appropriate) in order to decide whether the command should be accepted or not.
31123 If no ACL is defined, the command is rejected.
31124
31125 .cindex "VRFY" "processing"
31126 When VRFY is accepted, it runs exactly the same code as when Exim is
31127 called with the &%-bv%& option.
31128
31129 .cindex "EXPN" "processing"
31130 When EXPN is accepted, a single-level expansion of the address is done.
31131 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
31132 than a verification (the &%-bv%& option). If an unqualified local part is given
31133 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
31134 of VRFY and EXPN commands are logged on the main and reject logs, and
31135 VRFY verification failures are logged on the main log for consistency with
31136 RCPT failures.
31137
31138
31139
31140 .section "The ETRN command" "SECTETRN"
31141 .cindex "ETRN" "processing"
31142 RFC 1985 describes an SMTP command called ETRN that is designed to
31143 overcome the security problems of the TURN command (which has fallen into
31144 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
31145 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
31146 should be accepted or not. If no ACL is defined, the command is rejected.
31147
31148 The ETRN command is concerned with &"releasing"& messages that are awaiting
31149 delivery to certain hosts. As Exim does not organize its message queue by host,
31150 the only form of ETRN that is supported by default is the one where the
31151 text starts with the &"#"& prefix, in which case the remainder of the text is
31152 specific to the SMTP server. A valid ETRN command causes a run of Exim with
31153 the &%-R%& option to happen, with the remainder of the ETRN text as its
31154 argument. For example,
31155 .code
31156 ETRN #brigadoon
31157 .endd
31158 runs the command
31159 .code
31160 exim -R brigadoon
31161 .endd
31162 which causes a delivery attempt on all messages with undelivered addresses
31163 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
31164 default), Exim prevents the simultaneous execution of more than one queue run
31165 for the same argument string as a result of an ETRN command. This stops
31166 a misbehaving client from starting more than one queue runner at once.
31167
31168 .cindex "hints database" "ETRN serialization"
31169 Exim implements the serialization by means of a hints database in which a
31170 record is written whenever a process is started by ETRN, and deleted when
31171 the process completes. However, Exim does not keep the SMTP session waiting for
31172 the ETRN process to complete. Once ETRN is accepted, the client is sent
31173 a &"success"& return code. Obviously there is scope for hints records to get
31174 left lying around if there is a system or program crash. To guard against this,
31175 Exim ignores any records that are more than six hours old.
31176
31177 .oindex "&%smtp_etrn_command%&"
31178 For more control over what ETRN does, the &%smtp_etrn_command%& option can
31179 used. This specifies a command that is run whenever ETRN is received,
31180 whatever the form of its argument. For
31181 example:
31182 .code
31183 smtp_etrn_command = /etc/etrn_command $domain \
31184                     $sender_host_address
31185 .endd
31186 .vindex "&$domain$&"
31187 The string is split up into arguments which are independently expanded. The
31188 expansion variable &$domain$& is set to the argument of the ETRN command,
31189 and no syntax checking is done on the contents of this argument. Exim does not
31190 wait for the command to complete, so its status code is not checked. Exim runs
31191 under its own uid and gid when receiving incoming SMTP, so it is not possible
31192 for it to change them before running the command.
31193
31194
31195
31196 .section "Incoming local SMTP" "SECID238"
31197 .cindex "SMTP" "local incoming"
31198 Some user agents use SMTP to pass messages to their local MTA using the
31199 standard input and output, as opposed to passing the envelope on the command
31200 line and writing the message to the standard input. This is supported by the
31201 &%-bs%& option. This form of SMTP is handled in the same way as incoming
31202 messages over TCP/IP (including the use of ACLs), except that the envelope
31203 sender given in a MAIL command is ignored unless the caller is trusted. In
31204 an ACL you can detect this form of SMTP input by testing for an empty host
31205 identification. It is common to have this as the first line in the ACL that
31206 runs for RCPT commands:
31207 .code
31208 accept hosts = :
31209 .endd
31210 This accepts SMTP messages from local processes without doing any other tests.
31211
31212
31213
31214 .section "Outgoing batched SMTP" "SECTbatchSMTP"
31215 .cindex "SMTP" "batched outgoing"
31216 .cindex "batched SMTP output"
31217 Both the &(appendfile)& and &(pipe)& transports can be used for handling
31218 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
31219 be output in BSMTP format. No SMTP responses are possible for this form of
31220 delivery. All it is doing is using SMTP commands as a way of transmitting the
31221 envelope along with the message.
31222
31223 The message is written to the file or pipe preceded by the SMTP commands
31224 MAIL and RCPT, and followed by a line containing a single dot. Lines in
31225 the message that start with a dot have an extra dot added. The SMTP command
31226 HELO is not normally used. If it is required, the &%message_prefix%& option
31227 can be used to specify it.
31228
31229 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
31230 one recipient address at a time by default. However, you can arrange for them
31231 to handle several addresses at once by setting the &%batch_max%& option. When
31232 this is done for BSMTP, messages may contain multiple RCPT commands. See
31233 chapter &<<CHAPbatching>>& for more details.
31234
31235 .vindex "&$host$&"
31236 When one or more addresses are routed to a BSMTP transport by a router that
31237 sets up a host list, the name of the first host on the list is available to the
31238 transport in the variable &$host$&. Here is an example of such a transport and
31239 router:
31240 .code
31241 begin routers
31242 route_append:
31243   driver = manualroute
31244   transport = smtp_appendfile
31245   route_list = domain.example  batch.host.example
31246
31247 begin transports
31248 smtp_appendfile:
31249   driver = appendfile
31250   directory = /var/bsmtp/$host
31251   batch_max = 1000
31252   use_bsmtp
31253   user = exim
31254 .endd
31255 This causes messages addressed to &'domain.example'& to be written in BSMTP
31256 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
31257 message (unless there are more than 1000 recipients).
31258
31259
31260
31261 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
31262 .cindex "SMTP" "batched incoming"
31263 .cindex "batched SMTP input"
31264 The &%-bS%& command line option causes Exim to accept one or more messages by
31265 reading SMTP on the standard input, but to generate no responses. If the caller
31266 is trusted, the senders in the MAIL commands are believed; otherwise the
31267 sender is always the caller of Exim. Unqualified senders and receivers are not
31268 rejected (there seems little point) but instead just get qualified. HELO
31269 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
31270 as NOOP; QUIT quits.
31271
31272 Minimal policy checking is done for BSMTP input. Only the non-SMTP
31273 ACL is run in the same way as for non-SMTP local input.
31274
31275 If an error is detected while reading a message, including a missing &"."& at
31276 the end, Exim gives up immediately. It writes details of the error to the
31277 standard output in a stylized way that the calling program should be able to
31278 make some use of automatically, for example:
31279 .code
31280 554 Unexpected end of file
31281 Transaction started in line 10
31282 Error detected in line 14
31283 .endd
31284 It writes a more verbose version, for human consumption, to the standard error
31285 file, for example:
31286 .code
31287 An error was detected while processing a file of BSMTP input.
31288 The error message was:
31289
31290 501 '>' missing at end of address
31291
31292 The SMTP transaction started in line 10.
31293 The error was detected in line 12.
31294 The SMTP command at fault was:
31295
31296 rcpt to:<malformed@in.com.plete
31297
31298 1 previous message was successfully processed.
31299 The rest of the batch was abandoned.
31300 .endd
31301 The return code from Exim is zero only if there were no errors. It is 1 if some
31302 messages were accepted before an error was detected, and 2 if no messages were
31303 accepted.
31304 .ecindex IIDsmtpproc1
31305 .ecindex IIDsmtpproc2
31306
31307
31308
31309 . ////////////////////////////////////////////////////////////////////////////
31310 . ////////////////////////////////////////////////////////////////////////////
31311
31312 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
31313          "Customizing messages"
31314 When a message fails to be delivered, or remains on the queue for more than a
31315 configured amount of time, Exim sends a message to the original sender, or
31316 to an alternative configured address. The text of these messages is built into
31317 the code of Exim, but it is possible to change it, either by adding a single
31318 string, or by replacing each of the paragraphs by text supplied in a file.
31319
31320 The &'From:'& and &'To:'& header lines are automatically generated; you can
31321 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
31322 option. Exim also adds the line
31323 .code
31324 Auto-Submitted: auto-generated
31325 .endd
31326 to all warning and bounce messages,
31327
31328
31329 .section "Customizing bounce messages" "SECID239"
31330 .cindex "customizing" "bounce message"
31331 .cindex "bounce message" "customizing"
31332 If &%bounce_message_text%& is set, its contents are included in the default
31333 message immediately after &"This message was created automatically by mail
31334 delivery software."& The string is not expanded. It is not used if
31335 &%bounce_message_file%& is set.
31336
31337 When &%bounce_message_file%& is set, it must point to a template file for
31338 constructing error messages. The file consists of a series of text items,
31339 separated by lines consisting of exactly four asterisks. If the file cannot be
31340 opened, default text is used and a message is written to the main and panic
31341 logs. If any text item in the file is empty, default text is used for that
31342 item.
31343
31344 .vindex "&$bounce_recipient$&"
31345 .vindex "&$bounce_return_size_limit$&"
31346 Each item of text that is read from the file is expanded, and there are two
31347 expansion variables which can be of use here: &$bounce_recipient$& is set to
31348 the recipient of an error message while it is being created, and
31349 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
31350 option, rounded to a whole number.
31351
31352 The items must appear in the file in the following order:
31353
31354 .ilist
31355 The first item is included in the headers, and should include at least a
31356 &'Subject:'& header. Exim does not check the syntax of these headers.
31357 .next
31358 The second item forms the start of the error message. After it, Exim lists the
31359 failing addresses with their error messages.
31360 .next
31361 The third item is used to introduce any text from pipe transports that is to be
31362 returned to the sender. It is omitted if there is no such text.
31363 .next
31364 The fourth item is used to introduce the copy of the message that is returned
31365 as part of the error report.
31366 .next
31367 The fifth item is added after the fourth one if the returned message is
31368 truncated because it is bigger than &%return_size_limit%&.
31369 .next
31370 The sixth item is added after the copy of the original message.
31371 .endlist
31372
31373 The default state (&%bounce_message_file%& unset) is equivalent to the
31374 following file, in which the sixth item is empty. The &'Subject:'& and some
31375 other lines have been split in order to fit them on the page:
31376 .code
31377 Subject: Mail delivery failed
31378   ${if eq{$sender_address}{$bounce_recipient}
31379   {: returning message to sender}}
31380 ****
31381 This message was created automatically by mail delivery software.
31382
31383 A message ${if eq{$sender_address}{$bounce_recipient}
31384   {that you sent }{sent by
31385
31386 <$sender_address>
31387
31388 }}could not be delivered to all of its recipients.
31389 This is a permanent error. The following address(es) failed:
31390 ****
31391 The following text was generated during the delivery attempt(s):
31392 ****
31393 ------ This is a copy of the message, including all the headers.
31394   ------
31395 ****
31396 ------ The body of the message is $message_size characters long;
31397   only the first
31398 ------ $bounce_return_size_limit or so are included here.
31399 ****
31400 .endd
31401 .section "Customizing warning messages" "SECTcustwarn"
31402 .cindex "customizing" "warning message"
31403 .cindex "warning of delay" "customizing the message"
31404 The option &%warn_message_file%& can be pointed at a template file for use when
31405 warnings about message delays are created. In this case there are only three
31406 text sections:
31407
31408 .ilist
31409 The first item is included in the headers, and should include at least a
31410 &'Subject:'& header. Exim does not check the syntax of these headers.
31411 .next
31412 The second item forms the start of the warning message. After it, Exim lists
31413 the delayed addresses.
31414 .next
31415 The third item then ends the message.
31416 .endlist
31417
31418 The default state is equivalent to the following file, except that some lines
31419 have been split here, in order to fit them on the page:
31420 .code
31421 Subject: Warning: message $message_exim_id delayed
31422   $warn_message_delay
31423 ****
31424 This message was created automatically by mail delivery software.
31425
31426 A message ${if eq{$sender_address}{$warn_message_recipients}
31427 {that you sent }{sent by
31428
31429 <$sender_address>
31430
31431 }}has not been delivered to all of its recipients after
31432 more than $warn_message_delay on the queue on $primary_hostname.
31433
31434 The message identifier is:     $message_exim_id
31435 The subject of the message is: $h_subject
31436 The date of the message is:    $h_date
31437
31438 The following address(es) have not yet been delivered:
31439 ****
31440 No action is required on your part. Delivery attempts will
31441 continue for some time, and this warning may be repeated at
31442 intervals if the message remains undelivered. Eventually the
31443 mail delivery software will give up, and when that happens,
31444 the message will be returned to you.
31445 .endd
31446 .vindex "&$warn_message_delay$&"
31447 .vindex "&$warn_message_recipients$&"
31448 However, in the default state the subject and date lines are omitted if no
31449 appropriate headers exist. During the expansion of this file,
31450 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
31451 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
31452 of recipients for the warning message. There may be more than one if there are
31453 multiple addresses with different &%errors_to%& settings on the routers that
31454 handled them.
31455
31456
31457
31458
31459 . ////////////////////////////////////////////////////////////////////////////
31460 . ////////////////////////////////////////////////////////////////////////////
31461
31462 .chapter "Some common configuration settings" "CHAPcomconreq"
31463 This chapter discusses some configuration settings that seem to be fairly
31464 common. More examples and discussion can be found in the Exim book.
31465
31466
31467
31468 .section "Sending mail to a smart host" "SECID240"
31469 .cindex "smart host" "example router"
31470 If you want to send all mail for non-local domains to a &"smart host"&, you
31471 should replace the default &(dnslookup)& router with a router which does the
31472 routing explicitly:
31473 .code
31474 send_to_smart_host:
31475   driver = manualroute
31476   route_list = !+local_domains smart.host.name
31477   transport = remote_smtp
31478 .endd
31479 You can use the smart host's IP address instead of the name if you wish.
31480 If you are using Exim only to submit messages to a smart host, and not for
31481 receiving incoming messages, you can arrange for it to do the submission
31482 synchronously by setting the &%mua_wrapper%& option (see chapter
31483 &<<CHAPnonqueueing>>&).
31484
31485
31486
31487
31488 .section "Using Exim to handle mailing lists" "SECTmailinglists"
31489 .cindex "mailing lists"
31490 Exim can be used to run simple mailing lists, but for large and/or complicated
31491 requirements, the use of additional specialized mailing list software such as
31492 Majordomo or Mailman is recommended.
31493
31494 The &(redirect)& router can be used to handle mailing lists where each list
31495 is maintained in a separate file, which can therefore be managed by an
31496 independent manager. The &%domains%& router option can be used to run these
31497 lists in a separate domain from normal mail. For example:
31498 .code
31499 lists:
31500   driver = redirect
31501   domains = lists.example
31502   file = /usr/lists/$local_part
31503   forbid_pipe
31504   forbid_file
31505   errors_to = $local_part-request@lists.example
31506   no_more
31507 .endd
31508 This router is skipped for domains other than &'lists.example'&. For addresses
31509 in that domain, it looks for a file that matches the local part. If there is no
31510 such file, the router declines, but because &%no_more%& is set, no subsequent
31511 routers are tried, and so the whole delivery fails.
31512
31513 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
31514 expanded into a file name or a pipe delivery, which is usually inappropriate in
31515 a mailing list.
31516
31517 .oindex "&%errors_to%&"
31518 The &%errors_to%& option specifies that any delivery errors caused by addresses
31519 taken from a mailing list are to be sent to the given address rather than the
31520 original sender of the message. However, before acting on this, Exim verifies
31521 the error address, and ignores it if verification fails.
31522
31523 For example, using the configuration above, mail sent to
31524 &'dicts@lists.example'& is passed on to those addresses contained in
31525 &_/usr/lists/dicts_&, with error reports directed to
31526 &'dicts-request@lists.example'&, provided that this address can be verified.
31527 There could be a file called &_/usr/lists/dicts-request_& containing
31528 the address(es) of this particular list's manager(s), but other approaches,
31529 such as setting up an earlier router (possibly using the &%local_part_prefix%&
31530 or &%local_part_suffix%& options) to handle addresses of the form
31531 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
31532
31533
31534
31535 .section "Syntax errors in mailing lists" "SECID241"
31536 .cindex "mailing lists" "syntax errors in"
31537 If an entry in redirection data contains a syntax error, Exim normally defers
31538 delivery of the original address. That means that a syntax error in a mailing
31539 list holds up all deliveries to the list. This may not be appropriate when a
31540 list is being maintained automatically from data supplied by users, and the
31541 addresses are not rigorously checked.
31542
31543 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
31544 entries that fail to parse, noting the incident in the log. If in addition
31545 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
31546 whenever a broken address is skipped. It is usually appropriate to set
31547 &%syntax_errors_to%& to the same address as &%errors_to%&.
31548
31549
31550
31551 .section "Re-expansion of mailing lists" "SECID242"
31552 .cindex "mailing lists" "re-expansion of"
31553 Exim remembers every individual address to which a message has been delivered,
31554 in order to avoid duplication, but it normally stores only the original
31555 recipient addresses with a message. If all the deliveries to a mailing list
31556 cannot be done at the first attempt, the mailing list is re-expanded when the
31557 delivery is next tried. This means that alterations to the list are taken into
31558 account at each delivery attempt, so addresses that have been added to
31559 the list since the message arrived will therefore receive a copy of the
31560 message, even though it pre-dates their subscription.
31561
31562 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
31563 on the &(redirect)& router. If this is done, any addresses generated by the
31564 router that fail to deliver at the first attempt are added to the message as
31565 &"top level"& addresses, and the parent address that generated them is marked
31566 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
31567 subsequent delivery attempts. The disadvantage of this is that if any of the
31568 failing addresses are incorrect, correcting them in the file has no effect on
31569 pre-existing messages.
31570
31571 The original top-level address is remembered with each of the generated
31572 addresses, and is output in any log messages. However, any intermediate parent
31573 addresses are not recorded. This makes a difference to the log only if the
31574 &%all_parents%& selector is set, but for mailing lists there is normally only
31575 one level of expansion anyway.
31576
31577
31578
31579 .section "Closed mailing lists" "SECID243"
31580 .cindex "mailing lists" "closed"
31581 The examples so far have assumed open mailing lists, to which anybody may
31582 send mail. It is also possible to set up closed lists, where mail is accepted
31583 from specified senders only. This is done by making use of the generic
31584 &%senders%& option to restrict the router that handles the list.
31585
31586 The following example uses the same file as a list of recipients and as a list
31587 of permitted senders. It requires three routers:
31588 .code
31589 lists_request:
31590   driver = redirect
31591   domains = lists.example
31592   local_part_suffix = -request
31593   file = /usr/lists/$local_part$local_part_suffix
31594   no_more
31595
31596 lists_post:
31597   driver = redirect
31598   domains = lists.example
31599   senders = ${if exists {/usr/lists/$local_part}\
31600              {lsearch;/usr/lists/$local_part}{*}}
31601   file = /usr/lists/$local_part
31602   forbid_pipe
31603   forbid_file
31604   errors_to = $local_part-request@lists.example
31605   no_more
31606
31607 lists_closed:
31608   driver = redirect
31609   domains = lists.example
31610   allow_fail
31611   data = :fail: $local_part@lists.example is a closed mailing list
31612 .endd
31613 All three routers have the same &%domains%& setting, so for any other domains,
31614 they are all skipped. The first router runs only if the local part ends in
31615 &%-request%&. It handles messages to the list manager(s) by means of an open
31616 mailing list.
31617
31618 The second router runs only if the &%senders%& precondition is satisfied. It
31619 checks for the existence of a list that corresponds to the local part, and then
31620 checks that the sender is on the list by means of a linear search. It is
31621 necessary to check for the existence of the file before trying to search it,
31622 because otherwise Exim thinks there is a configuration error. If the file does
31623 not exist, the expansion of &%senders%& is *, which matches all senders. This
31624 means that the router runs, but because there is no list, declines, and
31625 &%no_more%& ensures that no further routers are run. The address fails with an
31626 &"unrouteable address"& error.
31627
31628 The third router runs only if the second router is skipped, which happens when
31629 a mailing list exists, but the sender is not on it. This router forcibly fails
31630 the address, giving a suitable error message.
31631
31632
31633
31634
31635 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
31636 .cindex "VERP"
31637 .cindex "Variable Envelope Return Paths"
31638 .cindex "envelope sender"
31639 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
31640 are a way of helping mailing list administrators discover which subscription
31641 address is the cause of a particular delivery failure. The idea is to encode
31642 the original recipient address in the outgoing envelope sender address, so that
31643 if the message is forwarded by another host and then subsequently bounces, the
31644 original recipient can be extracted from the recipient address of the bounce.
31645
31646 .oindex &%errors_to%&
31647 .oindex &%return_path%&
31648 Envelope sender addresses can be modified by Exim using two different
31649 facilities: the &%errors_to%& option on a router (as shown in previous mailing
31650 list examples), or the &%return_path%& option on a transport. The second of
31651 these is effective only if the message is successfully delivered to another
31652 host; it is not used for errors detected on the local host (see the description
31653 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
31654 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
31655 .code
31656 verp_smtp:
31657   driver = smtp
31658   max_rcpt = 1
31659   return_path = \
31660     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31661       {$1-request+$local_part=$domain@your.dom.example}fail}
31662 .endd
31663 This has the effect of rewriting the return path (envelope sender) on outgoing
31664 SMTP messages, if the local part of the original return path ends in
31665 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
31666 local part and domain of the recipient into the return path. Suppose, for
31667 example, that a message whose return path has been set to
31668 &'somelist-request@your.dom.example'& is sent to
31669 &'subscriber@other.dom.example'&. In the transport, the return path is
31670 rewritten as
31671 .code
31672 somelist-request+subscriber=other.dom.example@your.dom.example
31673 .endd
31674 .vindex "&$local_part$&"
31675 For this to work, you must tell Exim to send multiple copies of messages that
31676 have more than one recipient, so that each copy has just one recipient. This is
31677 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
31678 might be sent to several different recipients in the same domain, in which case
31679 &$local_part$& is not available in the transport, because it is not unique.
31680
31681 Unless your host is doing nothing but mailing list deliveries, you should
31682 probably use a separate transport for the VERP deliveries, so as not to use
31683 extra resources in making one-per-recipient copies for other deliveries. This
31684 can easily be done by expanding the &%transport%& option in the router:
31685 .code
31686 dnslookup:
31687   driver = dnslookup
31688   domains = ! +local_domains
31689   transport = \
31690     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31691       {verp_smtp}{remote_smtp}}
31692   no_more
31693 .endd
31694 If you want to change the return path using &%errors_to%& in a router instead
31695 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
31696 routers that handle mailing list addresses. This will ensure that all delivery
31697 errors, including those detected on the local host, are sent to the VERP
31698 address.
31699
31700 On a host that does no local deliveries and has no manual routing, only the
31701 &(dnslookup)& router needs to be changed. A special transport is not needed for
31702 SMTP deliveries. Every mailing list recipient has its own return path value,
31703 and so Exim must hand them to the transport one at a time. Here is an example
31704 of a &(dnslookup)& router that implements VERP:
31705 .code
31706 verp_dnslookup:
31707   driver = dnslookup
31708   domains = ! +local_domains
31709   transport = remote_smtp
31710   errors_to = \
31711     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
31712      {$1-request+$local_part=$domain@your.dom.example}fail}
31713   no_more
31714 .endd
31715 Before you start sending out messages with VERPed return paths, you must also
31716 configure Exim to accept the bounce messages that come back to those paths.
31717 Typically this is done by setting a &%local_part_suffix%& option for a
31718 router, and using this to route the messages to wherever you want to handle
31719 them.
31720
31721 The overhead incurred in using VERP depends very much on the size of the
31722 message, the number of recipient addresses that resolve to the same remote
31723 host, and the speed of the connection over which the message is being sent. If
31724 a lot of addresses resolve to the same host and the connection is slow, sending
31725 a separate copy of the message for each address may take substantially longer
31726 than sending a single copy with many recipients (for which VERP cannot be
31727 used).
31728
31729
31730
31731
31732
31733
31734 .section "Virtual domains" "SECTvirtualdomains"
31735 .cindex "virtual domains"
31736 .cindex "domain" "virtual"
31737 The phrase &'virtual domain'& is unfortunately used with two rather different
31738 meanings:
31739
31740 .ilist
31741 A domain for which there are no real mailboxes; all valid local parts are
31742 aliases for other email addresses. Common examples are organizational
31743 top-level domains and &"vanity"& domains.
31744 .next
31745 One of a number of independent domains that are all handled by the same host,
31746 with mailboxes on that host, but where the mailbox owners do not necessarily
31747 have login accounts on that host.
31748 .endlist
31749
31750 The first usage is probably more common, and does seem more &"virtual"& than
31751 the second. This kind of domain can be handled in Exim with a straightforward
31752 aliasing router. One approach is to create a separate alias file for each
31753 virtual domain. Exim can test for the existence of the alias file to determine
31754 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
31755 to a router of this form:
31756 .code
31757 virtual:
31758   driver = redirect
31759   domains = dsearch;/etc/mail/virtual
31760   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
31761   no_more
31762 .endd
31763 The &%domains%& option specifies that the router is to be skipped, unless there
31764 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
31765 domain that is being processed. When the router runs, it looks up the local
31766 part in the file to find a new address (or list of addresses). The &%no_more%&
31767 setting ensures that if the lookup fails (leading to &%data%& being an empty
31768 string), Exim gives up on the address without trying any subsequent routers.
31769
31770 This one router can handle all the virtual domains because the alias file names
31771 follow a fixed pattern. Permissions can be arranged so that appropriate people
31772 can edit the different alias files. A successful aliasing operation results in
31773 a new envelope recipient address, which is then routed from scratch.
31774
31775 The other kind of &"virtual"& domain can also be handled in a straightforward
31776 way. One approach is to create a file for each domain containing a list of
31777 valid local parts, and use it in a router like this:
31778 .code
31779 my_domains:
31780   driver = accept
31781   domains = dsearch;/etc/mail/domains
31782   local_parts = lsearch;/etc/mail/domains/$domain
31783   transport = my_mailboxes
31784 .endd
31785 The address is accepted if there is a file for the domain, and the local part
31786 can be found in the file. The &%domains%& option is used to check for the
31787 file's existence because &%domains%& is tested before the &%local_parts%&
31788 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
31789 because that option is tested after &%local_parts%&. The transport is as
31790 follows:
31791 .code
31792 my_mailboxes:
31793   driver = appendfile
31794   file = /var/mail/$domain/$local_part
31795   user = mail
31796 .endd
31797 This uses a directory of mailboxes for each domain. The &%user%& setting is
31798 required, to specify which uid is to be used for writing to the mailboxes.
31799
31800 The configuration shown here is just one example of how you might support this
31801 requirement. There are many other ways this kind of configuration can be set
31802 up, for example, by using a database instead of separate files to hold all the
31803 information about the domains.
31804
31805
31806
31807 .section "Multiple user mailboxes" "SECTmulbox"
31808 .cindex "multiple mailboxes"
31809 .cindex "mailbox" "multiple"
31810 .cindex "local part" "prefix"
31811 .cindex "local part" "suffix"
31812 Heavy email users often want to operate with multiple mailboxes, into which
31813 incoming mail is automatically sorted. A popular way of handling this is to
31814 allow users to use multiple sender addresses, so that replies can easily be
31815 identified. Users are permitted to add prefixes or suffixes to their local
31816 parts for this purpose. The wildcard facility of the generic router options
31817 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
31818 example, consider this router:
31819 .code
31820 userforward:
31821   driver = redirect
31822   check_local_user
31823   file = $home/.forward
31824   local_part_suffix = -*
31825   local_part_suffix_optional
31826   allow_filter
31827 .endd
31828 .vindex "&$local_part_suffix$&"
31829 It runs a user's &_.forward_& file for all local parts of the form
31830 &'username-*'&. Within the filter file the user can distinguish different
31831 cases by testing the variable &$local_part_suffix$&. For example:
31832 .code
31833 if $local_part_suffix contains -special then
31834 save /home/$local_part/Mail/special
31835 endif
31836 .endd
31837 If the filter file does not exist, or does not deal with such addresses, they
31838 fall through to subsequent routers, and, assuming no subsequent use of the
31839 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
31840 control over which suffixes are valid.
31841
31842 Alternatively, a suffix can be used to trigger the use of a different
31843 &_.forward_& file &-- which is the way a similar facility is implemented in
31844 another MTA:
31845 .code
31846 userforward:
31847   driver = redirect
31848   check_local_user
31849   file = $home/.forward$local_part_suffix
31850   local_part_suffix = -*
31851   local_part_suffix_optional
31852   allow_filter
31853 .endd
31854 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
31855 example, &_.forward-special_& is used. Once again, if the appropriate file
31856 does not exist, or does not deal with the address, it is passed on to
31857 subsequent routers, which could, if required, look for an unqualified
31858 &_.forward_& file to use as a default.
31859
31860
31861
31862 .section "Simplified vacation processing" "SECID244"
31863 .cindex "vacation processing"
31864 The traditional way of running the &'vacation'& program is for a user to set up
31865 a pipe command in a &_.forward_& file
31866 (see section &<<SECTspecitredli>>& for syntax details).
31867 This is prone to error by inexperienced users. There are two features of Exim
31868 that can be used to make this process simpler for users:
31869
31870 .ilist
31871 A local part prefix such as &"vacation-"& can be specified on a router which
31872 can cause the message to be delivered directly to the &'vacation'& program, or
31873 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
31874 &_.forward_& file are then much simpler. For example:
31875 .code
31876 spqr, vacation-spqr
31877 .endd
31878 .next
31879 The &%require_files%& generic router option can be used to trigger a
31880 vacation delivery by checking for the existence of a certain file in the
31881 user's home directory. The &%unseen%& generic option should also be used, to
31882 ensure that the original delivery also proceeds. In this case, all the user has
31883 to do is to create a file called, say, &_.vacation_&, containing a vacation
31884 message.
31885 .endlist
31886
31887 Another advantage of both these methods is that they both work even when the
31888 use of arbitrary pipes by users is locked out.
31889
31890
31891
31892 .section "Taking copies of mail" "SECID245"
31893 .cindex "message" "copying every"
31894 Some installations have policies that require archive copies of all messages to
31895 be made. A single copy of each message can easily be taken by an appropriate
31896 command in a system filter, which could, for example, use a different file for
31897 each day's messages.
31898
31899 There is also a shadow transport mechanism that can be used to take copies of
31900 messages that are successfully delivered by local transports, one copy per
31901 delivery. This could be used, &'inter alia'&, to implement automatic
31902 notification of delivery by sites that insist on doing such things.
31903
31904
31905
31906 .section "Intermittently connected hosts" "SECID246"
31907 .cindex "intermittently connected hosts"
31908 It has become quite common (because it is cheaper) for hosts to connect to the
31909 Internet periodically rather than remain connected all the time. The normal
31910 arrangement is that mail for such hosts accumulates on a system that is
31911 permanently connected.
31912
31913 Exim was designed for use on permanently connected hosts, and so it is not
31914 particularly well-suited to use in an intermittently connected environment.
31915 Nevertheless there are some features that can be used.
31916
31917
31918 .section "Exim on the upstream server host" "SECID247"
31919 It is tempting to arrange for incoming mail for the intermittently connected
31920 host to remain on Exim's queue until the client connects. However, this
31921 approach does not scale very well. Two different kinds of waiting message are
31922 being mixed up in the same queue &-- those that cannot be delivered because of
31923 some temporary problem, and those that are waiting for their destination host
31924 to connect. This makes it hard to manage the queue, as well as wasting
31925 resources, because each queue runner scans the entire queue.
31926
31927 A better approach is to separate off those messages that are waiting for an
31928 intermittently connected host. This can be done by delivering these messages
31929 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
31930 format, from where they are transmitted by other software when their
31931 destination connects. This makes it easy to collect all the mail for one host
31932 in a single directory, and to apply local timeout rules on a per-message basis
31933 if required.
31934
31935 On a very small scale, leaving the mail on Exim's queue can be made to work. If
31936 you are doing this, you should configure Exim with a long retry period for the
31937 intermittent host. For example:
31938 .code
31939 cheshire.wonderland.fict.example    *   F,5d,24h
31940 .endd
31941 This stops a lot of failed delivery attempts from occurring, but Exim remembers
31942 which messages it has queued up for that host. Once the intermittent host comes
31943 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
31944 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
31945 causes all the queued up messages to be delivered, often down a single SMTP
31946 connection. While the host remains connected, any new messages get delivered
31947 immediately.
31948
31949 If the connecting hosts do not have fixed IP addresses, that is, if a host is
31950 issued with a different IP address each time it connects, Exim's retry
31951 mechanisms on the holding host get confused, because the IP address is normally
31952 used as part of the key string for holding retry information. This can be
31953 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
31954 Since this has disadvantages for permanently connected hosts, it is best to
31955 arrange a separate transport for the intermittently connected ones.
31956
31957
31958
31959 .section "Exim on the intermittently connected client host" "SECID248"
31960 The value of &%smtp_accept_queue_per_connection%& should probably be
31961 increased, or even set to zero (that is, disabled) on the intermittently
31962 connected host, so that all incoming messages down a single connection get
31963 delivered immediately.
31964
31965 .cindex "SMTP" "passed connection"
31966 .cindex "SMTP" "multiple deliveries"
31967 .cindex "multiple SMTP deliveries"
31968 Mail waiting to be sent from an intermittently connected host will probably
31969 not have been routed, because without a connection DNS lookups are not
31970 possible. This means that if a normal queue run is done at connection time,
31971 each message is likely to be sent in a separate SMTP session. This can be
31972 avoided by starting the queue run with a command line option beginning with
31973 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
31974 first pass, routing is done but no deliveries take place. The second pass is a
31975 normal queue run; since all the messages have been previously routed, those
31976 destined for the same host are likely to get sent as multiple deliveries in a
31977 single SMTP connection.
31978
31979
31980
31981 . ////////////////////////////////////////////////////////////////////////////
31982 . ////////////////////////////////////////////////////////////////////////////
31983
31984 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
31985          "Exim as a non-queueing client"
31986 .cindex "client, non-queueing"
31987 .cindex "smart host" "suppressing queueing"
31988 On a personal computer, it is a common requirement for all
31989 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
31990 configured to operate that way, for all the popular operating systems.
31991 However, there are some MUAs for Unix-like systems that cannot be so
31992 configured: they submit messages using the command line interface of
31993 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
31994 messages this way.
31995
31996 If the personal computer runs continuously, there is no problem, because it can
31997 run a conventional MTA that handles delivery to the smart host, and deal with
31998 any delays via its queueing mechanism. However, if the computer does not run
31999 continuously or runs different operating systems at different times, queueing
32000 email is not desirable.
32001
32002 There is therefore a requirement for something that can provide the
32003 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
32004 any queueing or retrying facilities. Furthermore, the delivery to the smart
32005 host should be synchronous, so that if it fails, the sending MUA is immediately
32006 informed. In other words, we want something that extends an MUA that submits
32007 to a local MTA via the command line so that it behaves like one that submits
32008 to a remote smart host using TCP/SMTP.
32009
32010 There are a number of applications (for example, there is one called &'ssmtp'&)
32011 that do this job. However, people have found them to be lacking in various
32012 ways. For instance, you might want to allow aliasing and forwarding to be done
32013 before sending a message to the smart host.
32014
32015 Exim already had the necessary infrastructure for doing this job. Just a few
32016 tweaks were needed to make it behave as required, though it is somewhat of an
32017 overkill to use a fully-featured MTA for this purpose.
32018
32019 .oindex "&%mua_wrapper%&"
32020 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
32021 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
32022 assumes that it is being used to &"wrap"& a command-line MUA in the manner
32023 just described. As well as setting &%mua_wrapper%&, you also need to provide a
32024 compatible router and transport configuration. Typically there will be just one
32025 router and one transport, sending everything to a smart host.
32026
32027 When run in MUA wrapping mode, the behaviour of Exim changes in the
32028 following ways:
32029
32030 .ilist
32031 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
32032 In other words, the only way to submit messages is via the command line.
32033 .next
32034 Each message is synchronously delivered as soon as it is received (&%-odi%& is
32035 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
32036 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
32037 does not finish until the delivery attempt is complete. If the delivery is
32038 successful, a zero return code is given.
32039 .next
32040 Address redirection is permitted, but the final routing for all addresses must
32041 be to the same remote transport, and to the same list of hosts. Furthermore,
32042 the return address (envelope sender) must be the same for all recipients, as
32043 must any added or deleted header lines. In other words, it must be possible to
32044 deliver the message in a single SMTP transaction, however many recipients there
32045 are.
32046 .next
32047 If these conditions are not met, or if routing any address results in a
32048 failure or defer status, or if Exim is unable to deliver all the recipients
32049 successfully to one of the smart hosts, delivery of the entire message fails.
32050 .next
32051 Because no queueing is allowed, all failures are treated as permanent; there
32052 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
32053 smart host. Furthermore, because only a single yes/no response can be given to
32054 the caller, it is not possible to deliver to some recipients and not others. If
32055 there is an error (temporary or permanent) for any recipient, all are failed.
32056 .next
32057 If more than one smart host is listed, Exim will try another host after a
32058 connection failure or a timeout, in the normal way. However, if this kind of
32059 failure happens for all the hosts, the delivery fails.
32060 .next
32061 When delivery fails, an error message is written to the standard error stream
32062 (as well as to Exim's log), and Exim exits to the caller with a return code
32063 value 1. The message is expunged from Exim's spool files. No bounce messages
32064 are ever generated.
32065 .next
32066 No retry data is maintained, and any retry rules are ignored.
32067 .next
32068 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
32069 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
32070 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
32071 .endlist
32072
32073 The overall effect is that Exim makes a single synchronous attempt to deliver
32074 the message, failing if there is any kind of problem. Because no local
32075 deliveries are done and no daemon can be run, Exim does not need root
32076 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
32077 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
32078 the advantages and disadvantages of running without root privilege.
32079
32080
32081
32082
32083 . ////////////////////////////////////////////////////////////////////////////
32084 . ////////////////////////////////////////////////////////////////////////////
32085
32086 .chapter "Log files" "CHAPlog"
32087 .scindex IIDloggen "log" "general description"
32088 .cindex "log" "types of"
32089 Exim writes three different logs, referred to as the main log, the reject log,
32090 and the panic log:
32091
32092 .ilist
32093 .cindex "main log"
32094 The main log records the arrival of each message and each delivery in a single
32095 line in each case. The format is as compact as possible, in an attempt to keep
32096 down the size of log files. Two-character flag sequences make it easy to pick
32097 out these lines. A number of other events are recorded in the main log. Some of
32098 them are optional, in which case the &%log_selector%& option controls whether
32099 they are included or not. A Perl script called &'eximstats'&, which does simple
32100 analysis of main log files, is provided in the Exim distribution (see section
32101 &<<SECTmailstat>>&).
32102 .next
32103 .cindex "reject log"
32104 The reject log records information from messages that are rejected as a result
32105 of a configuration option (that is, for policy reasons).
32106 The first line of each rejection is a copy of the line that is also written to
32107 the main log. Then, if the message's header has been read at the time the log
32108 is written, its contents are written to this log. Only the original header
32109 lines are available; header lines added by ACLs are not logged. You can use the
32110 reject log to check that your policy controls are working correctly; on a busy
32111 host this may be easier than scanning the main log for rejection messages. You
32112 can suppress the writing of the reject log by setting &%write_rejectlog%&
32113 false.
32114 .next
32115 .cindex "panic log"
32116 .cindex "system log"
32117 When certain serious errors occur, Exim writes entries to its panic log. If the
32118 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
32119 are usually written to the main log as well, but can get lost amid the mass of
32120 other entries. The panic log should be empty under normal circumstances. It is
32121 therefore a good idea to check it (or to have a &'cron'& script check it)
32122 regularly, in order to become aware of any problems. When Exim cannot open its
32123 panic log, it tries as a last resort to write to the system log (syslog). This
32124 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
32125 message itself is written at priority LOG_CRIT.
32126 .endlist
32127
32128 Every log line starts with a timestamp, in the format shown in the following
32129 example. Note that many of the examples shown in this chapter are line-wrapped.
32130 In the log file, this would be all on one line:
32131 .code
32132 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
32133   by QUIT
32134 .endd
32135 By default, the timestamps are in the local timezone. There are two
32136 ways of changing this:
32137
32138 .ilist
32139 You can set the &%timezone%& option to a different time zone; in particular, if
32140 you set
32141 .code
32142 timezone = UTC
32143 .endd
32144 the timestamps will be in UTC (aka GMT).
32145 .next
32146 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
32147 example:
32148 .code
32149 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
32150 .endd
32151 .endlist
32152
32153 .cindex "log" "process ids in"
32154 .cindex "pid (process id)" "in log lines"
32155 Exim does not include its process id in log lines by default, but you can
32156 request that it does so by specifying the &`pid`& log selector (see section
32157 &<<SECTlogselector>>&). When this is set, the process id is output, in square
32158 brackets, immediately after the time and date.
32159
32160
32161
32162
32163 .section "Where the logs are written" "SECTwhelogwri"
32164 .cindex "log" "destination"
32165 .cindex "log" "to file"
32166 .cindex "log" "to syslog"
32167 .cindex "syslog"
32168 The logs may be written to local files, or to syslog, or both. However, it
32169 should be noted that many syslog implementations use UDP as a transport, and
32170 are therefore unreliable in the sense that messages are not guaranteed to
32171 arrive at the loghost, nor is the ordering of messages necessarily maintained.
32172 It has also been reported that on large log files (tens of megabytes) you may
32173 need to tweak syslog to prevent it syncing the file with each write &-- on
32174 Linux this has been seen to make syslog take 90% plus of CPU time.
32175
32176 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
32177 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
32178 configuration. This latter string is expanded, so it can contain, for example,
32179 references to the host name:
32180 .code
32181 log_file_path = /var/log/$primary_hostname/exim_%slog
32182 .endd
32183 It is generally advisable, however, to set the string in &_Local/Makefile_&
32184 rather than at run time, because then the setting is available right from the
32185 start of Exim's execution. Otherwise, if there's something it wants to log
32186 before it has read the configuration file (for example, an error in the
32187 configuration file) it will not use the path you want, and may not be able to
32188 log at all.
32189
32190 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
32191 list, currently limited to at most two items. This is one option where the
32192 facility for changing a list separator may not be used. The list must always be
32193 colon-separated. If an item in the list is &"syslog"& then syslog is used;
32194 otherwise the item must either be an absolute path, containing &`%s`& at the
32195 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
32196 implying the use of a default path.
32197
32198 When Exim encounters an empty item in the list, it searches the list defined by
32199 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
32200 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
32201 mean &"use the path specified at build time"&. It no such item exists, log
32202 files are written in the &_log_& subdirectory of the spool directory. This is
32203 equivalent to the setting:
32204 .code
32205 log_file_path = $spool_directory/log/%slog
32206 .endd
32207 If you do not specify anything at build time or run time, that is where the
32208 logs are written.
32209
32210 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
32211 are in use &-- see section &<<SECTdatlogfil>>& below.
32212
32213 Here are some examples of possible settings:
32214 .display
32215 &`LOG_FILE_PATH=syslog                    `& syslog only
32216 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
32217 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
32218 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
32219 .endd
32220 If there are more than two paths in the list, the first is used and a panic
32221 error is logged.
32222
32223
32224
32225 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
32226 .cindex "log" "cycling local files"
32227 .cindex "cycling logs"
32228 .cindex "&'exicyclog'&"
32229 .cindex "log" "local files; writing to"
32230 Some operating systems provide centralized and standardized methods for cycling
32231 log files. For those that do not, a utility script called &'exicyclog'& is
32232 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
32233 main and reject logs each time it is called. The maximum number of old logs to
32234 keep can be set. It is suggested this script is run as a daily &'cron'& job.
32235
32236 An Exim delivery process opens the main log when it first needs to write to it,
32237 and it keeps the file open in case subsequent entries are required &-- for
32238 example, if a number of different deliveries are being done for the same
32239 message. However, remote SMTP deliveries can take a long time, and this means
32240 that the file may be kept open long after it is renamed if &'exicyclog'& or
32241 something similar is being used to rename log files on a regular basis. To
32242 ensure that a switch of log files is noticed as soon as possible, Exim calls
32243 &[stat()]& on the main log's name before reusing an open file, and if the file
32244 does not exist, or its inode has changed, the old file is closed and Exim
32245 tries to open the main log from scratch. Thus, an old log file may remain open
32246 for quite some time, but no Exim processes should write to it once it has been
32247 renamed.
32248
32249
32250
32251 .section "Datestamped log files" "SECTdatlogfil"
32252 .cindex "log" "datestamped files"
32253 Instead of cycling the main and reject log files by renaming them
32254 periodically, some sites like to use files whose names contain a datestamp,
32255 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
32256 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
32257 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
32258 point where the datestamp is required. For example:
32259 .code
32260 log_file_path = /var/spool/exim/log/%slog-%D
32261 log_file_path = /var/log/exim-%s-%D.log
32262 log_file_path = /var/spool/exim/log/%D-%slog
32263 log_file_path = /var/log/exim/%s.%M
32264 .endd
32265 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
32266 examples of names generated by the above examples:
32267 .code
32268 /var/spool/exim/log/mainlog-20021225
32269 /var/log/exim-reject-20021225.log
32270 /var/spool/exim/log/20021225-mainlog
32271 /var/log/exim/main.200212
32272 .endd
32273 When this form of log file is specified, Exim automatically switches to new
32274 files at midnight. It does not make any attempt to compress old logs; you
32275 will need to write your own script if you require this. You should not
32276 run &'exicyclog'& with this form of logging.
32277
32278 The location of the panic log is also determined by &%log_file_path%&, but it
32279 is not datestamped, because rotation of the panic log does not make sense.
32280 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
32281 the string. In addition, if it immediately follows a slash, a following
32282 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
32283 character is removed. Thus, the four examples above would give these panic
32284 log names:
32285 .code
32286 /var/spool/exim/log/paniclog
32287 /var/log/exim-panic.log
32288 /var/spool/exim/log/paniclog
32289 /var/log/exim/panic
32290 .endd
32291
32292
32293 .section "Logging to syslog" "SECID249"
32294 .cindex "log" "syslog; writing to"
32295 The use of syslog does not change what Exim logs or the format of its messages,
32296 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
32297 Exim's log lines are omitted when these lines are sent to syslog. Apart from
32298 that, the same strings are written to syslog as to log files. The syslog
32299 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
32300 by default, but you can change these by setting the &%syslog_facility%& and
32301 &%syslog_processname%& options, respectively. If Exim was compiled with
32302 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
32303 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
32304 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
32305 the time and host name to each line.
32306 The three log streams are mapped onto syslog priorities as follows:
32307
32308 .ilist
32309 &'mainlog'& is mapped to LOG_INFO
32310 .next
32311 &'rejectlog'& is mapped to LOG_NOTICE
32312 .next
32313 &'paniclog'& is mapped to LOG_ALERT
32314 .endlist
32315
32316 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
32317 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
32318 these are routed by syslog to the same place. You can suppress this duplication
32319 by setting &%syslog_duplication%& false.
32320
32321 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
32322 entries contain multiple lines when headers are included. To cope with both
32323 these cases, entries written to syslog are split into separate &[syslog()]&
32324 calls at each internal newline, and also after a maximum of
32325 870 data characters. (This allows for a total syslog line length of 1024, when
32326 additions such as timestamps are added.) If you are running a syslog
32327 replacement that can handle lines longer than the 1024 characters allowed by
32328 RFC 3164, you should set
32329 .code
32330 SYSLOG_LONG_LINES=yes
32331 .endd
32332 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
32333 lines, but it still splits at internal newlines in &'reject'& log entries.
32334
32335 To make it easy to re-assemble split lines later, each component of a split
32336 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
32337 where <&'n'&> is the component number and <&'m'&> is the total number of
32338 components in the entry. The / delimiter is used when the line was split
32339 because it was too long; if it was split because of an internal newline, the \
32340 delimiter is used. For example, supposing the length limit to be 50 instead of
32341 870, the following would be the result of a typical rejection message to
32342 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
32343 name, and pid as added by syslog:
32344 .code
32345 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
32346 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
32347 [3/5]  when scanning for sender: missing or malformed lo
32348 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
32349 [5/5] mple>)
32350 .endd
32351 The same error might cause the following lines to be written to &"rejectlog"&
32352 (LOG_NOTICE):
32353 .code
32354 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
32355 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
32356 [3/18] er when scanning for sender: missing or malformed
32357 [4/18]  local part in "<>" (envelope sender is <ph10@cam
32358 [5\18] .example>)
32359 [6\18] Recipients: ph10@some.domain.cam.example
32360 [7\18] P Received: from [127.0.0.1] (ident=ph10)
32361 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
32362 [9\18]        id 16RdAL-0006pc-00
32363 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
32364 [11\18] 09:43 +0100
32365 [12\18] F From: <>
32366 [13\18]   Subject: this is a test header
32367 [18\18]   X-something: this is another header
32368 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
32369 [16\18] le>
32370 [17\18] B Bcc:
32371 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
32372 .endd
32373 Log lines that are neither too long nor contain newlines are written to syslog
32374 without modification.
32375
32376 If only syslog is being used, the Exim monitor is unable to provide a log tail
32377 display, unless syslog is routing &'mainlog'& to a file on the local host and
32378 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
32379 where it is.
32380
32381
32382
32383 .section "Log line flags" "SECID250"
32384 One line is written to the main log for each message received, and for each
32385 successful, unsuccessful, and delayed delivery. These lines can readily be
32386 picked out by the distinctive two-character flags that immediately follow the
32387 timestamp. The flags are:
32388 .display
32389 &`<=`&     message arrival
32390 &`=>`&     normal message delivery
32391 &`->`&     additional address in same delivery
32392 &`*>`&     delivery suppressed by &%-N%&
32393 &`**`&     delivery failed; address bounced
32394 &`==`&     delivery deferred; temporary problem
32395 .endd
32396
32397
32398 .section "Logging message reception" "SECID251"
32399 .cindex "log" "reception line"
32400 The format of the single-line entry in the main log that is written for every
32401 message received is shown in the basic example below, which is split over
32402 several lines in order to fit it on the page:
32403 .code
32404 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
32405   H=mailer.fict.example [192.168.123.123] U=exim
32406   P=smtp S=5678 id=<incoming message id>
32407 .endd
32408 The address immediately following &"<="& is the envelope sender address. A
32409 bounce message is shown with the sender address &"<>"&, and if it is locally
32410 generated, this is followed by an item of the form
32411 .code
32412 R=<message id>
32413 .endd
32414 which is a reference to the message that caused the bounce to be sent.
32415
32416 .cindex "HELO"
32417 .cindex "EHLO"
32418 For messages from other hosts, the H and U fields identify the remote host and
32419 record the RFC 1413 identity of the user that sent the message, if one was
32420 received. The number given in square brackets is the IP address of the sending
32421 host. If there is a single, unparenthesized  host name in the H field, as
32422 above, it has been verified to correspond to the IP address (see the
32423 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
32424 by the remote host in the SMTP HELO or EHLO command, and has not been
32425 verified. If verification yields a different name to that given for HELO or
32426 EHLO, the verified name appears first, followed by the HELO or EHLO
32427 name in parentheses.
32428
32429 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
32430 without brackets, in the HELO or EHLO command, leading to entries in
32431 the log containing text like these examples:
32432 .code
32433 H=(10.21.32.43) [192.168.8.34]
32434 H=([10.21.32.43]) [192.168.8.34]
32435 .endd
32436 This can be confusing. Only the final address in square brackets can be relied
32437 on.
32438
32439 For locally generated messages (that is, messages not received over TCP/IP),
32440 the H field is omitted, and the U field contains the login name of the caller
32441 of Exim.
32442
32443 .cindex "authentication" "logging"
32444 .cindex "AUTH" "logging"
32445 For all messages, the P field specifies the protocol used to receive the
32446 message. This is the value that is stored in &$received_protocol$&. In the case
32447 of incoming SMTP messages, the value indicates whether or not any SMTP
32448 extensions (ESMTP), encryption, or authentication were used. If the SMTP
32449 session was encrypted, there is an additional X field that records the cipher
32450 suite that was used.
32451
32452 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
32453 hosts that have authenticated themselves using the SMTP AUTH command. The first
32454 value is used when the SMTP connection was encrypted (&"secure"&). In this case
32455 there is an additional item A= followed by the name of the authenticator that
32456 was used. If an authenticated identification was set up by the authenticator's
32457 &%server_set_id%& option, this is logged too, separated by a colon from the
32458 authenticator name.
32459
32460 .cindex "size" "of message"
32461 The id field records the existing message id, if present. The size of the
32462 received message is given by the S field. When the message is delivered,
32463 headers may be removed or added, so that the size of delivered copies of the
32464 message may not correspond with this value (and indeed may be different to each
32465 other).
32466
32467 The &%log_selector%& option can be used to request the logging of additional
32468 data when a message is received. See section &<<SECTlogselector>>& below.
32469
32470
32471
32472 .section "Logging deliveries" "SECID252"
32473 .cindex "log" "delivery line"
32474 The format of the single-line entry in the main log that is written for every
32475 delivery is shown in one of the examples below, for local and remote
32476 deliveries, respectively. Each example has been split into two lines in order
32477 to fit it on the page:
32478 .code
32479 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
32480   <marv@hitch.fict.example> R=localuser T=local_delivery
32481 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
32482   monk@holistic.fict.example R=dnslookup T=remote_smtp
32483   H=holistic.fict.example [192.168.234.234]
32484 .endd
32485 For ordinary local deliveries, the original address is given in angle brackets
32486 after the final delivery address, which might be a pipe or a file. If
32487 intermediate address(es) exist between the original and the final address, the
32488 last of these is given in parentheses after the final address. The R and T
32489 fields record the router and transport that were used to process the address.
32490
32491 If a shadow transport was run after a successful local delivery, the log line
32492 for the successful delivery has an item added on the end, of the form
32493 .display
32494 &`ST=<`&&'shadow transport name'&&`>`&
32495 .endd
32496 If the shadow transport did not succeed, the error message is put in
32497 parentheses afterwards.
32498
32499 .cindex "asterisk" "after IP address"
32500 When more than one address is included in a single delivery (for example, two
32501 SMTP RCPT commands in one transaction) the second and subsequent addresses are
32502 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
32503 down a single SMTP connection, an asterisk follows the IP address in the log
32504 lines for the second and subsequent messages.
32505
32506 The generation of a reply message by a filter file gets logged as a
32507 &"delivery"& to the addressee, preceded by &">"&.
32508
32509 The &%log_selector%& option can be used to request the logging of additional
32510 data when a message is delivered. See section &<<SECTlogselector>>& below.
32511
32512
32513 .section "Discarded deliveries" "SECID253"
32514 .cindex "discarded messages"
32515 .cindex "message" "discarded"
32516 .cindex "delivery" "discarded; logging"
32517 When a message is discarded as a result of the command &"seen finish"& being
32518 obeyed in a filter file which generates no deliveries, a log entry of the form
32519 .code
32520 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
32521   <low.club@bridge.example> R=userforward
32522 .endd
32523 is written, to record why no deliveries are logged. When a message is discarded
32524 because it is aliased to &":blackhole:"& the log line is like this:
32525 .code
32526 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
32527   <hole@nowhere.example> R=blackhole_router
32528 .endd
32529
32530
32531 .section "Deferred deliveries" "SECID254"
32532 When a delivery is deferred, a line of the following form is logged:
32533 .code
32534 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
32535   R=dnslookup T=smtp defer (146): Connection refused
32536 .endd
32537 In the case of remote deliveries, the error is the one that was given for the
32538 last IP address that was tried. Details of individual SMTP failures are also
32539 written to the log, so the above line would be preceded by something like
32540 .code
32541 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
32542   mail1.endrest.example [192.168.239.239]: Connection refused
32543 .endd
32544 When a deferred address is skipped because its retry time has not been reached,
32545 a message is written to the log, but this can be suppressed by setting an
32546 appropriate value in &%log_selector%&.
32547
32548
32549
32550 .section "Delivery failures" "SECID255"
32551 .cindex "delivery" "failure; logging"
32552 If a delivery fails because an address cannot be routed, a line of the
32553 following form is logged:
32554 .code
32555 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
32556   <jim@trek99.example>: unknown mail domain
32557 .endd
32558 If a delivery fails at transport time, the router and transport are shown, and
32559 the response from the remote host is included, as in this example:
32560 .code
32561 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
32562   R=dnslookup T=remote_smtp: SMTP error from remote mailer
32563   after pipelined RCPT TO:<ace400@pb.example>: host
32564   pbmail3.py.example [192.168.63.111]: 553 5.3.0
32565   <ace400@pb.example>...Addressee unknown
32566 .endd
32567 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
32568 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
32569 disabling PIPELINING. The log lines for all forms of delivery failure are
32570 flagged with &`**`&.
32571
32572
32573
32574 .section "Fake deliveries" "SECID256"
32575 .cindex "delivery" "fake; logging"
32576 If a delivery does not actually take place because the &%-N%& option has been
32577 used to suppress it, a normal delivery line is written to the log, except that
32578 &"=>"& is replaced by &"*>"&.
32579
32580
32581
32582 .section "Completion" "SECID257"
32583 A line of the form
32584 .code
32585 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
32586 .endd
32587 is written to the main log when a message is about to be removed from the spool
32588 at the end of its processing.
32589
32590
32591
32592
32593 .section "Summary of Fields in Log Lines" "SECID258"
32594 .cindex "log" "summary of fields"
32595 A summary of the field identifiers that are used in log lines is shown in
32596 the following table:
32597 .display
32598 &`A   `&        authenticator name (and optional id)
32599 &`C   `&        SMTP confirmation on delivery
32600 &`    `&        command list for &"no mail in SMTP session"&
32601 &`CV  `&        certificate verification status
32602 &`D   `&        duration of &"no mail in SMTP session"&
32603 &`DN  `&        distinguished name from peer certificate
32604 &`DT  `&        on &`=>`& lines: time taken for a delivery
32605 &`F   `&        sender address (on delivery lines)
32606 &`H   `&        host name and IP address
32607 &`I   `&        local interface used
32608 &`id  `&        message id for incoming message
32609 &`P   `&        on &`<=`& lines: protocol used
32610 &`    `&        on &`=>`& and &`**`& lines: return path
32611 &`QT  `&        on &`=>`& lines: time spent on queue so far
32612 &`    `&        on &"Completed"& lines: time spent on queue
32613 &`R   `&        on &`<=`& lines: reference for local bounce
32614 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
32615 &`S   `&        size of message
32616 &`ST  `&        shadow transport name
32617 &`T   `&        on &`<=`& lines: message subject (topic)
32618 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
32619 &`U   `&        local user or RFC 1413 identity
32620 &`X   `&        TLS cipher suite
32621 .endd
32622
32623
32624 .section "Other log entries" "SECID259"
32625 Various other types of log entry are written from time to time. Most should be
32626 self-explanatory. Among the more common are:
32627
32628 .ilist
32629 .cindex "retry" "time not reached"
32630 &'retry time not reached'&&~&~An address previously suffered a temporary error
32631 during routing or local delivery, and the time to retry has not yet arrived.
32632 This message is not written to an individual message log file unless it happens
32633 during the first delivery attempt.
32634 .next
32635 &'retry time not reached for any host'&&~&~An address previously suffered
32636 temporary errors during remote delivery, and the retry time has not yet arrived
32637 for any of the hosts to which it is routed.
32638 .next
32639 .cindex "spool directory" "file locked"
32640 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
32641 some other Exim process is already working on the message. This can be quite
32642 common if queue running processes are started at frequent intervals. The
32643 &'exiwhat'& utility script can be used to find out what Exim processes are
32644 doing.
32645 .next
32646 .cindex "error" "ignored"
32647 &'error ignored'&&~&~There are several circumstances that give rise to this
32648 message:
32649 .olist
32650 Exim failed to deliver a bounce message whose age was greater than
32651 &%ignore_bounce_errors_after%&. The bounce was discarded.
32652 .next
32653 A filter file set up a delivery using the &"noerror"& option, and the delivery
32654 failed. The delivery was discarded.
32655 .next
32656 A delivery set up by a router configured with
32657 . ==== As this is a nested list, any displays it contains must be indented
32658 . ==== as otherwise they are too far to the left.
32659 .code
32660     errors_to = <>
32661 .endd
32662 failed. The delivery was discarded.
32663 .endlist olist
32664 .endlist ilist
32665
32666
32667
32668
32669
32670 .section "Reducing or increasing what is logged" "SECTlogselector"
32671 .cindex "log" "selectors"
32672 By setting the &%log_selector%& global option, you can disable some of Exim's
32673 default logging, or you can request additional logging. The value of
32674 &%log_selector%& is made up of names preceded by plus or minus characters. For
32675 example:
32676 .code
32677 log_selector = +arguments -retry_defer
32678 .endd
32679 The list of optional log items is in the following table, with the default
32680 selection marked by asterisks:
32681 .display
32682 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
32683 &` address_rewrite            `&  address rewriting
32684 &` all_parents                `&  all parents in => lines
32685 &` arguments                  `&  command line arguments
32686 &`*connection_reject          `&  connection rejections
32687 &`*delay_delivery             `&  immediate delivery delayed
32688 &` deliver_time               `&  time taken to perform delivery
32689 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
32690 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
32691 &`*etrn                       `&  ETRN commands
32692 &`*host_lookup_failed         `&  as it says
32693 &` ident_timeout              `&  timeout for ident connection
32694 &` incoming_interface         `&  incoming interface on <= lines
32695 &` incoming_port              `&  incoming port on <= lines
32696 &`*lost_incoming_connection   `&  as it says (includes timeouts)
32697 &` outgoing_port              `&  add remote port to => lines
32698 &`*queue_run                  `&  start and end queue runs
32699 &` queue_time                 `&  time on queue for one recipient
32700 &` queue_time_overall         `&  time on queue for whole message
32701 &` pid                        `&  Exim process id
32702 &` received_recipients        `&  recipients on <= lines
32703 &` received_sender            `&  sender on <= lines
32704 &`*rejected_header            `&  header contents on reject log
32705 &`*retry_defer                `&  &"retry time not reached"&
32706 &` return_path_on_delivery    `&  put return path on => and ** lines
32707 &` sender_on_delivery         `&  add sender to => lines
32708 &`*sender_verify_fail         `&  sender verification failures
32709 &`*size_reject                `&  rejection because too big
32710 &`*skip_delivery              `&  delivery skipped in a queue run
32711 &` smtp_confirmation          `&  SMTP confirmation on => lines
32712 &` smtp_connection            `&  SMTP connections
32713 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
32714 &` smtp_no_mail               `&  session with no MAIL commands
32715 &` smtp_protocol_error        `&  SMTP protocol errors
32716 &` smtp_syntax_error          `&  SMTP syntax errors
32717 &` subject                    `&  contents of &'Subject:'& on <= lines
32718 &` tls_certificate_verified   `&  certificate verification status
32719 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
32720 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
32721 &` unknown_in_list            `&  DNS lookup failed in list match
32722
32723 &` all                        `&  all of the above
32724 .endd
32725 More details on each of these items follows:
32726
32727 .ilist
32728 .cindex "&%warn%& ACL verb" "log when skipping"
32729 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
32730 its conditions cannot be evaluated, a log line to this effect is written if
32731 this log selector is set.
32732 .next
32733 .cindex "log" "rewriting"
32734 .cindex "rewriting" "logging"
32735 &%address_rewrite%&: This applies both to global rewrites and per-transport
32736 rewrites, but not to rewrites in filters run as an unprivileged user (because
32737 such users cannot access the log).
32738 .next
32739 .cindex "log" "full parentage"
32740 &%all_parents%&: Normally only the original and final addresses are logged on
32741 delivery lines; with this selector, intermediate parents are given in
32742 parentheses between them.
32743 .next
32744 .cindex "log" "Exim arguments"
32745 .cindex "Exim arguments, logging"
32746 &%arguments%&: This causes Exim to write the arguments with which it was called
32747 to the main log, preceded by the current working directory. This is a debugging
32748 feature, added to make it easier to find out how certain MUAs call
32749 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
32750 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
32751 that are empty or that contain white space are quoted. Non-printing characters
32752 are shown as escape sequences. This facility cannot log unrecognized arguments,
32753 because the arguments are checked before the configuration file is read. The
32754 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
32755 between the caller and Exim.
32756 .next
32757 .cindex "log" "connection rejections"
32758 &%connection_reject%&: A log entry is written whenever an incoming SMTP
32759 connection is rejected, for whatever reason.
32760 .next
32761 .cindex "log" "delayed delivery"
32762 .cindex "delayed delivery, logging"
32763 &%delay_delivery%&: A log entry is written whenever a delivery process is not
32764 started for an incoming message because the load is too high or too many
32765 messages were received on one connection. Logging does not occur if no delivery
32766 process is started because &%queue_only%& is set or &%-odq%& was used.
32767 .next
32768 .cindex "log" "delivery duration"
32769 &%deliver_time%&: For each delivery, the amount of real time it has taken to
32770 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
32771 .next
32772 .cindex "log" "message size on delivery"
32773 .cindex "size" "of message"
32774 &%delivery_size%&: For each delivery, the size of message delivered is added to
32775 the &"=>"& line, tagged with S=.
32776 .next
32777 .cindex "log" "dnslist defer"
32778 .cindex "DNS list" "logging defer"
32779 .cindex "black list (DNS)"
32780 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
32781 DNS black list suffers a temporary error.
32782 .next
32783 .cindex "log" "ETRN commands"
32784 .cindex "ETRN" "logging"
32785 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
32786 is run to determine whether or not it is actually accepted. An invalid ETRN
32787 command, or one received within a message transaction is not logged by this
32788 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
32789 .next
32790 .cindex "log" "host lookup failure"
32791 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
32792 any addresses, or when a lookup of an IP address fails to find a host name, a
32793 log line is written. This logging does not apply to direct DNS lookups when
32794 routing email addresses, but it does apply to &"byname"& lookups.
32795 .next
32796 .cindex "log" "ident timeout"
32797 .cindex "RFC 1413" "logging timeout"
32798 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
32799 client's ident port times out.
32800 .next
32801 .cindex "log" "incoming interface"
32802 .cindex "interface" "logging"
32803 &%incoming_interface%&: The interface on which a message was received is added
32804 to the &"<="& line as an IP address in square brackets, tagged by I= and
32805 followed by a colon and the port number. The local interface and port are also
32806 added to other SMTP log lines, for example &"SMTP connection from"&, and to
32807 rejection lines.
32808 .next
32809 .cindex "log" "incoming remote port"
32810 .cindex "port" "logging remote"
32811 .cindex "TCP/IP" "logging incoming remote port"
32812 .vindex "&$sender_fullhost$&"
32813 .vindex "&$sender_rcvhost$&"
32814 &%incoming_port%&: The remote port number from which a message was received is
32815 added to log entries and &'Received:'& header lines, following the IP address
32816 in square brackets, and separated from it by a colon. This is implemented by
32817 changing the value that is put in the &$sender_fullhost$& and
32818 &$sender_rcvhost$& variables. Recording the remote port number has become more
32819 important with the widening use of NAT (see RFC 2505).
32820 .next
32821 .cindex "log" "dropped connection"
32822 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
32823 connection is unexpectedly dropped.
32824 .next
32825 .cindex "log" "outgoing remote port"
32826 .cindex "port" "logging outgoint remote"
32827 .cindex "TCP/IP" "logging ougtoing remote port"
32828 &%outgoing_port%&: The remote port number is added to delivery log lines (those
32829 containing => tags) following the IP address. This option is not included in
32830 the default setting, because for most ordinary configurations, the remote port
32831 number is always 25 (the SMTP port).
32832 .next
32833 .cindex "log" "process ids in"
32834 .cindex "pid (process id)" "in log lines"
32835 &%pid%&: The current process id is added to every log line, in square brackets,
32836 immediately after the time and date.
32837 .next
32838 .cindex "log" "queue run"
32839 .cindex "queue runner" "logging"
32840 &%queue_run%&: The start and end of every queue run are logged.
32841 .next
32842 .cindex "log" "queue time"
32843 &%queue_time%&: The amount of time the message has been in the queue on the
32844 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
32845 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
32846 includes reception time as well as the delivery time for the current address.
32847 This means that it may be longer than the difference between the arrival and
32848 delivery log line times, because the arrival log line is not written until the
32849 message has been successfully received.
32850 .next
32851 &%queue_time_overall%&: The amount of time the message has been in the queue on
32852 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
32853 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
32854 message, so it includes reception time as well as the total delivery time.
32855 .next
32856 .cindex "log" "recipients"
32857 &%received_recipients%&: The recipients of a message are listed in the main log
32858 as soon as the message is received. The list appears at the end of the log line
32859 that is written when a message is received, preceded by the word &"for"&. The
32860 addresses are listed after they have been qualified, but before any rewriting
32861 has taken place.
32862 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
32863 in the list.
32864 .next
32865 .cindex "log" "sender reception"
32866 &%received_sender%&: The unrewritten original sender of a message is added to
32867 the end of the log line that records the message's arrival, after the word
32868 &"from"& (before the recipients if &%received_recipients%& is also set).
32869 .next
32870 .cindex "log" "header lines for rejection"
32871 &%rejected_header%&: If a message's header has been received at the time a
32872 rejection is written to the reject log, the complete header is added to the
32873 log. Header logging can be turned off individually for messages that are
32874 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
32875 .next
32876 .cindex "log" "retry defer"
32877 &%retry_defer%&: A log line is written if a delivery is deferred because a
32878 retry time has not yet been reached. However, this &"retry time not reached"&
32879 message is always omitted from individual message logs after the first delivery
32880 attempt.
32881 .next
32882 .cindex "log" "return path"
32883 &%return_path_on_delivery%&: The return path that is being transmitted with
32884 the message is included in delivery and bounce lines, using the tag P=.
32885 This is omitted if no delivery actually happens, for example, if routing fails,
32886 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
32887 .next
32888 .cindex "log" "sender on delivery"
32889 &%sender_on_delivery%&: The message's sender address is added to every delivery
32890 and bounce line, tagged by F= (for &"from"&).
32891 This is the original sender that was received with the message; it is not
32892 necessarily the same as the outgoing return path.
32893 .next
32894 .cindex "log" "sender verify failure"
32895 &%sender_verify_fail%&: If this selector is unset, the separate log line that
32896 gives details of a sender verification failure is not written. Log lines for
32897 the rejection of SMTP commands contain just &"sender verify failed"&, so some
32898 detail is lost.
32899 .next
32900 .cindex "log" "size rejection"
32901 &%size_reject%&: A log line is written whenever a message is rejected because
32902 it is too big.
32903 .next
32904 .cindex "log" "frozen messages; skipped"
32905 .cindex "frozen messages" "logging skipping"
32906 &%skip_delivery%&: A log line is written whenever a message is skipped during a
32907 queue run because it is frozen or because another process is already delivering
32908 it.
32909 .cindex "&""spool file is locked""&"
32910 The message that is written is &"spool file is locked"&.
32911 .next
32912 .cindex "log" "smtp confirmation"
32913 .cindex "SMTP" "logging confirmation"
32914 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
32915 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
32916 A number of MTAs (including Exim) return an identifying string in this
32917 response.
32918 .next
32919 .cindex "log" "SMTP connections"
32920 .cindex "SMTP" "logging connections"
32921 &%smtp_connection%&: A log line is written whenever an SMTP connection is
32922 established or closed, unless the connection is from a host that matches
32923 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
32924 only when the closure is unexpected.) This applies to connections from local
32925 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
32926 dropped in the middle of a message, a log line is always written, whether or
32927 not this selector is set, but otherwise nothing is written at the start and end
32928 of connections unless this selector is enabled.
32929
32930 For TCP/IP connections to an Exim daemon, the current number of connections is
32931 included in the log message for each new connection, but note that the count is
32932 reset if the daemon is restarted.
32933 Also, because connections are closed (and the closure is logged) in
32934 subprocesses, the count may not include connections that have been closed but
32935 whose termination the daemon has not yet noticed. Thus, while it is possible to
32936 match up the opening and closing of connections in the log, the value of the
32937 logged counts may not be entirely accurate.
32938 .next
32939 .cindex "log" "SMTP transaction; incomplete"
32940 .cindex "SMTP" "logging incomplete transactions"
32941 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
32942 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
32943 and the message sender plus any accepted recipients are included in the log
32944 line. This can provide evidence of dictionary attacks.
32945 .next
32946 .cindex "log" "non-MAIL SMTP sessions"
32947 .cindex "MAIL" "logging session without"
32948 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
32949 connection terminates without having issued a MAIL command. This includes both
32950 the case when the connection is dropped, and the case when QUIT is used. It
32951 does not include cases where the connection is rejected right at the start (by
32952 an ACL, or because there are too many connections, or whatever). These cases
32953 already have their own log lines.
32954
32955 The log line that is written contains the identity of the client in the usual
32956 way, followed by D= and a time, which records the duration of the connection.
32957 If the connection was authenticated, this fact is logged exactly as it is for
32958 an incoming message, with an A= item. If the connection was encrypted, CV=,
32959 DN=, and X= items may appear as they do for an incoming message, controlled by
32960 the same logging options.
32961
32962 Finally, if any SMTP commands were issued during the connection, a C= item
32963 is added to the line, listing the commands that were used. For example,
32964 .code
32965 C=EHLO,QUIT
32966 .endd
32967 shows that the client issued QUIT straight after EHLO. If there were fewer
32968 than 20 commands, they are all listed. If there were more than 20 commands,
32969 the last 20 are listed, preceded by &"..."&. However, with the default
32970 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
32971 have been aborted before 20 non-mail commands are processed.
32972 .next
32973 .cindex "log" "SMTP protocol error"
32974 .cindex "SMTP" "logging protocol error"
32975 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
32976 encountered. Exim does not have perfect detection of all protocol errors
32977 because of transmission delays and the use of pipelining. If PIPELINING has
32978 been advertised to a client, an Exim server assumes that the client will use
32979 it, and therefore it does not count &"expected"& errors (for example, RCPT
32980 received after rejecting MAIL) as protocol errors.
32981 .next
32982 .cindex "SMTP" "logging syntax errors"
32983 .cindex "SMTP" "syntax errors; logging"
32984 .cindex "SMTP" "unknown command; logging"
32985 .cindex "log" "unknown SMTP command"
32986 .cindex "log" "SMTP syntax error"
32987 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
32988 encountered. An unrecognized command is treated as a syntax error. For an
32989 external connection, the host identity is given; for an internal connection
32990 using &%-bs%& the sender identification (normally the calling user) is given.
32991 .next
32992 .cindex "log" "subject"
32993 .cindex "subject, logging"
32994 &%subject%&: The subject of the message is added to the arrival log line,
32995 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
32996 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
32997 specifies whether characters with values greater than 127 should be logged
32998 unchanged, or whether they should be rendered as escape sequences.
32999 .next
33000 .cindex "log" "certificate verification"
33001 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
33002 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
33003 verified, and &`CV=no`& if not.
33004 .next
33005 .cindex "log" "TLS cipher"
33006 .cindex "TLS" "logging cipher"
33007 &%tls_cipher%&: When a message is sent or received over an encrypted
33008 connection, the cipher suite used is added to the log line, preceded by X=.
33009 .next
33010 .cindex "log" "TLS peer DN"
33011 .cindex "TLS" "logging peer DN"
33012 &%tls_peerdn%&: When a message is sent or received over an encrypted
33013 connection, and a certificate is supplied by the remote host, the peer DN is
33014 added to the log line, preceded by DN=.
33015 .next
33016 .cindex "log" "DNS failure in list"
33017 &%unknown_in_list%&: This setting causes a log entry to be written when the
33018 result of a list match is failure because a DNS lookup failed.
33019 .endlist
33020
33021
33022 .section "Message log" "SECID260"
33023 .cindex "message" "log file for"
33024 .cindex "log" "message log; description of"
33025 .cindex "&_msglog_& directory"
33026 .oindex "&%preserve_message_logs%&"
33027 In addition to the general log files, Exim writes a log file for each message
33028 that it handles. The names of these per-message logs are the message ids, and
33029 they are kept in the &_msglog_& sub-directory of the spool directory. Each
33030 message log contains copies of the log lines that apply to the message. This
33031 makes it easier to inspect the status of an individual message without having
33032 to search the main log. A message log is deleted when processing of the message
33033 is complete, unless &%preserve_message_logs%& is set, but this should be used
33034 only with great care because they can fill up your disk very quickly.
33035
33036 On a heavily loaded system, it may be desirable to disable the use of
33037 per-message logs, in order to reduce disk I/O. This can be done by setting the
33038 &%message_logs%& option false.
33039 .ecindex IIDloggen
33040
33041
33042
33043
33044 . ////////////////////////////////////////////////////////////////////////////
33045 . ////////////////////////////////////////////////////////////////////////////
33046
33047 .chapter "Exim utilities" "CHAPutils"
33048 .scindex IIDutils "utilities"
33049 A number of utility scripts and programs are supplied with Exim and are
33050 described in this chapter. There is also the Exim Monitor, which is covered in
33051 the next chapter. The utilities described here are:
33052
33053 .itable none 0 0 3  7* left  15* left  40* left
33054 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
33055   "list what Exim processes are doing"
33056 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
33057 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
33058 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
33059 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
33060                                                 various criteria"
33061 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
33062 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
33063   "extract statistics from the log"
33064 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
33065   "check address acceptance from given IP"
33066 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
33067 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
33068 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
33069 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
33070 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
33071 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
33072 .endtable
33073
33074 Another utility that might be of use to sites with many MTAs is Tom Kistner's
33075 &'exilog'&. It provides log visualizations across multiple Exim servers. See
33076 &url(http://duncanthrax.net/exilog/) for details.
33077
33078
33079
33080
33081 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
33082 .cindex "&'exiwhat'&"
33083 .cindex "process, querying"
33084 .cindex "SIGUSR1"
33085 On operating systems that can restart a system call after receiving a signal
33086 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
33087 a line describing what it is doing to the file &_exim-process.info_& in the
33088 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
33089 processes it can find, having first emptied the file. It then waits for one
33090 second to allow the Exim processes to react before displaying the results. In
33091 order to run &'exiwhat'& successfully you have to have sufficient privilege to
33092 send the signal to the Exim processes, so it is normally run as root.
33093
33094 &*Warning*&: This is not an efficient process. It is intended for occasional
33095 use by system administrators. It is not sensible, for example, to set up a
33096 script that sends SIGUSR1 signals to Exim processes at short intervals.
33097
33098
33099 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
33100 varies in different operating systems. Not only are different options used,
33101 but the format of the output is different. For this reason, there are some
33102 system configuration options that configure exactly how &'exiwhat'& works. If
33103 it doesn't seem to be working for you, check the following compile-time
33104 options:
33105 .display
33106 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
33107 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
33108 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
33109 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
33110 .endd
33111 An example of typical output from &'exiwhat'& is
33112 .code
33113 164 daemon: -q1h, listening on port 25
33114 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
33115 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
33116   [10.19.42.42] (editor@ref.example)
33117 10592 handling incoming call from [192.168.243.242]
33118 10628 accepting a local non-SMTP message
33119 .endd
33120 The first number in the output line is the process number. The third line has
33121 been split here, in order to fit it on the page.
33122
33123
33124
33125 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
33126 .cindex "&'exiqgrep'&"
33127 .cindex "queue" "grepping"
33128 This utility is a Perl script contributed by Matt Hubbard. It runs
33129 .code
33130 exim -bpu
33131 .endd
33132 to obtain a queue listing with undelivered recipients only, and then greps the
33133 output to select messages that match given criteria. The following selection
33134 options are available:
33135
33136 .vlist
33137 .vitem &*-f*&&~<&'regex'&>
33138 Match the sender address. The field that is tested is enclosed in angle
33139 brackets, so you can test for bounce messages with
33140 .code
33141 exiqgrep -f '^<>$'
33142 .endd
33143 .vitem &*-r*&&~<&'regex'&>
33144 Match a recipient address. The field that is tested is not enclosed in angle
33145 brackets.
33146
33147 .vitem &*-s*&&~<&'regex'&>
33148 Match against the size field.
33149
33150 .vitem &*-y*&&~<&'seconds'&>
33151 Match messages that are younger than the given time.
33152
33153 .vitem &*-o*&&~<&'seconds'&>
33154 Match messages that are older than the given time.
33155
33156 .vitem &*-z*&
33157 Match only frozen messages.
33158
33159 .vitem &*-x*&
33160 Match only non-frozen messages.
33161 .endlist
33162
33163 The following options control the format of the output:
33164
33165 .vlist
33166 .vitem &*-c*&
33167 Display only the count of matching messages.
33168
33169 .vitem &*-l*&
33170 Long format &-- display the full message information as output by Exim. This is
33171 the default.
33172
33173 .vitem &*-i*&
33174 Display message ids only.
33175
33176 .vitem &*-b*&
33177 Brief format &-- one line per message.
33178
33179 .vitem &*-R*&
33180 Display messages in reverse order.
33181 .endlist
33182
33183 There is one more option, &%-h%&, which outputs a list of options.
33184
33185
33186
33187 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
33188 .cindex "&'exiqsumm'&"
33189 .cindex "queue" "summary"
33190 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
33191 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
33192 running a command such as
33193 .code
33194 exim -bp | exiqsumm
33195 .endd
33196 The output consists of one line for each domain that has messages waiting for
33197 it, as in the following example:
33198 .code
33199 3   2322   74m   66m  msn.com.example
33200 .endd
33201 Each line lists the number of pending deliveries for a domain, their total
33202 volume, and the length of time that the oldest and the newest messages have
33203 been waiting. Note that the number of pending deliveries is greater than the
33204 number of messages when messages have more than one recipient.
33205
33206 A summary line is output at the end. By default the output is sorted on the
33207 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
33208 the output to be sorted by oldest message and by count of messages,
33209 respectively. There are also three options that split the messages for each
33210 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
33211 separates frozen messages, and &%-s%& separates messages according to their
33212 sender.
33213
33214 The output of &'exim -bp'& contains the original addresses in the message, so
33215 this also applies to the output from &'exiqsumm'&. No domains from addresses
33216 generated by aliasing or forwarding are included (unless the &%one_time%&
33217 option of the &(redirect)& router has been used to convert them into &"top
33218 level"& addresses).
33219
33220
33221
33222
33223 .section "Extracting specific information from the log (exigrep)" &&&
33224          "SECTextspeinf"
33225 .cindex "&'exigrep'&"
33226 .cindex "log" "extracts; grepping for"
33227 The &'exigrep'& utility is a Perl script that searches one or more main log
33228 files for entries that match a given pattern. When it finds a match, it
33229 extracts all the log entries for the relevant message, not just those that
33230 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
33231 given message, or all mail for a given user, or for a given host, for example.
33232 The input files can be in Exim log format or syslog format.
33233 If a matching log line is not associated with a specific message, it is
33234 included in &'exigrep'&'s output without any additional lines. The usage is:
33235 .display
33236 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
33237 .endd
33238 If no log file names are given on the command line, the standard input is read.
33239
33240 The &%-t%& argument specifies a number of seconds. It adds an additional
33241 condition for message selection. Messages that are complete are shown only if
33242 they spent more than <&'n'&> seconds on the queue.
33243
33244 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
33245 makes it case-sensitive. This may give a performance improvement when searching
33246 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
33247 option; with &%-I%& they do not. In both cases it is possible to change the
33248 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
33249
33250 The &%-l%& option means &"literal"&, that is, treat all characters in the
33251 pattern as standing for themselves. Otherwise the pattern must be a Perl
33252 regular expression.
33253
33254 The &%-v%& option inverts the matching condition. That is, a line is selected
33255 if it does &'not'& match the pattern.
33256
33257 If the location of a &'zcat'& command is known from the definition of
33258 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
33259 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
33260
33261
33262 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
33263 .cindex "&'exipick'&"
33264 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
33265 lists messages from the queue according to a variety of criteria. For details
33266 of &'exipick'&'s facilities, visit the web page at
33267 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
33268 the &%--help%& option.
33269
33270
33271 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
33272 .cindex "log" "cycling local files"
33273 .cindex "cycling logs"
33274 .cindex "&'exicyclog'&"
33275 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
33276 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
33277 you are using log files with datestamps in their names (see section
33278 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
33279 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
33280 There are two command line options for &'exicyclog'&:
33281 .ilist
33282 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
33283 default that is set when Exim is built. The default default is 10.
33284 .next
33285 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
33286 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
33287 overriding the script's default, which is to find the setting from Exim's
33288 configuration.
33289 .endlist
33290
33291 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
33292 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
33293 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
33294 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
33295 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
33296 logs are handled similarly.
33297
33298 If the limit is greater than 99, the script uses 3-digit numbers such as
33299 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
33300 to one that is greater, or &'vice versa'&, you will have to fix the names of
33301 any existing log files.
33302
33303 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
33304 the end are deleted. All files with numbers greater than 01 are compressed,
33305 using a compression command which is configured by the COMPRESS_COMMAND
33306 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
33307 root &%crontab%& entry of the form
33308 .code
33309 1 0 * * * su exim -c /usr/exim/bin/exicyclog
33310 .endd
33311 assuming you have used the name &"exim"& for the Exim user. You can run
33312 &'exicyclog'& as root if you wish, but there is no need.
33313
33314
33315
33316 .section "Mail statistics (eximstats)" "SECTmailstat"
33317 .cindex "statistics"
33318 .cindex "&'eximstats'&"
33319 A Perl script called &'eximstats'& is provided for extracting statistical
33320 information from log files. The output is either plain text, or HTML.
33321 Exim log files are also supported by the &'Lire'& system produced by the
33322 LogReport Foundation &url(http://www.logreport.org).
33323
33324 The &'eximstats'& script has been hacked about quite a bit over time. The
33325 latest version is the result of some extensive revision by Steve Campbell. A
33326 lot of information is given by default, but there are options for suppressing
33327 various parts of it. Following any options, the arguments to the script are a
33328 list of files, which should be main log files. For example:
33329 .code
33330 eximstats -nr /var/spool/exim/log/mainlog.01
33331 .endd
33332 By default, &'eximstats'& extracts information about the number and volume of
33333 messages received from or delivered to various hosts. The information is sorted
33334 both by message count and by volume, and the top fifty hosts in each category
33335 are listed on the standard output. Similar information, based on email
33336 addresses or domains instead of hosts can be requested by means of various
33337 options. For messages delivered and received locally, similar statistics are
33338 also produced per user.
33339
33340 The output also includes total counts and statistics about delivery errors, and
33341 histograms showing the number of messages received and deliveries made in each
33342 hour of the day. A delivery with more than one address in its envelope (for
33343 example, an SMTP transaction with more than one RCPT command) is counted
33344 as a single delivery by &'eximstats'&.
33345
33346 Though normally more deliveries than receipts are reported (as messages may
33347 have multiple recipients), it is possible for &'eximstats'& to report more
33348 messages received than delivered, even though the queue is empty at the start
33349 and end of the period in question. If an incoming message contains no valid
33350 recipients, no deliveries are recorded for it. A bounce message is handled as
33351 an entirely separate message.
33352
33353 &'eximstats'& always outputs a grand total summary giving the volume and number
33354 of messages received and deliveries made, and the number of hosts involved in
33355 each case. It also outputs the number of messages that were delayed (that is,
33356 not completely delivered at the first attempt), and the number that had at
33357 least one address that failed.
33358
33359 The remainder of the output is in sections that can be independently disabled
33360 or modified by various options. It consists of a summary of deliveries by
33361 transport, histograms of messages received and delivered per time interval
33362 (default per hour), information about the time messages spent on the queue,
33363 a list of relayed messages, lists of the top fifty sending hosts, local
33364 senders, destination hosts, and destination local users by count and by volume,
33365 and a list of delivery errors that occurred.
33366
33367 The relay information lists messages that were actually relayed, that is, they
33368 came from a remote host and were directly delivered to some other remote host,
33369 without being processed (for example, for aliasing or forwarding) locally.
33370
33371 There are quite a few options for &'eximstats'& to control exactly what it
33372 outputs. These are documented in the Perl script itself, and can be extracted
33373 by running the command &(perldoc)& on the script. For example:
33374 .code
33375 perldoc /usr/exim/bin/eximstats
33376 .endd
33377
33378 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
33379 .cindex "&'exim_checkaccess'&"
33380 .cindex "policy control" "checking access"
33381 .cindex "checking access"
33382 The &%-bh%& command line argument allows you to run a fake SMTP session with
33383 debugging output, in order to check what Exim is doing when it is applying
33384 policy controls to incoming SMTP mail. However, not everybody is sufficiently
33385 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
33386 sometimes you just want to answer the question &"Does this address have
33387 access?"& without bothering with any further details.
33388
33389 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
33390 two arguments, an IP address and an email address:
33391 .code
33392 exim_checkaccess 10.9.8.7 A.User@a.domain.example
33393 .endd
33394 The utility runs a call to Exim with the &%-bh%& option, to test whether the
33395 given email address would be accepted in a RCPT command in a TCP/IP
33396 connection from the host with the given IP address. The output of the utility
33397 is either the word &"accepted"&, or the SMTP error response, for example:
33398 .code
33399 Rejected:
33400 550 Relay not permitted
33401 .endd
33402 When running this test, the utility uses &`<>`& as the envelope sender address
33403 for the MAIL command, but you can change this by providing additional
33404 options. These are passed directly to the Exim command. For example, to specify
33405 that the test is to be run with the sender address &'himself@there.example'&
33406 you can use:
33407 .code
33408 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
33409                  -f himself@there.example
33410 .endd
33411 Note that these additional Exim command line items must be given after the two
33412 mandatory arguments.
33413
33414 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
33415 while running its checks. You can run checks that include callouts by using
33416 &%-bhc%&, but this is not yet available in a &"packaged"& form.
33417
33418
33419
33420 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
33421 .cindex "DBM" "building dbm files"
33422 .cindex "building DBM files"
33423 .cindex "&'exim_dbmbuild'&"
33424 .cindex "lower casing"
33425 .cindex "binary zero" "in lookup key"
33426 The &'exim_dbmbuild'& program reads an input file containing keys and data in
33427 the format used by the &(lsearch)& lookup (see section
33428 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
33429 names as keys and the remainder of the information as data. The lower-casing
33430 can be prevented by calling the program with the &%-nolc%& option.
33431
33432 A terminating zero is included as part of the key string. This is expected by
33433 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
33434 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
33435 strings or the data strings. The &(dbmnz)& lookup type can be used with such
33436 files.
33437
33438 The program requires two arguments: the name of the input file (which can be a
33439 single hyphen to indicate the standard input), and the name of the output file.
33440 It creates the output under a temporary name, and then renames it if all went
33441 well.
33442
33443 .cindex "USE_DB"
33444 If the native DB interface is in use (USE_DB is set in a compile-time
33445 configuration file &-- this is common in free versions of Unix) the two file
33446 names must be different, because in this mode the Berkeley DB functions create
33447 a single output file using exactly the name given. For example,
33448 .code
33449 exim_dbmbuild /etc/aliases /etc/aliases.db
33450 .endd
33451 reads the system alias file and creates a DBM version of it in
33452 &_/etc/aliases.db_&.
33453
33454 In systems that use the &'ndbm'& routines (mostly proprietary versions of
33455 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
33456 environment, the suffixes are added to the second argument of
33457 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
33458 when the Berkeley functions are used in compatibility mode (though this is not
33459 recommended), because in that case it adds a &_.db_& suffix to the file name.
33460
33461 If a duplicate key is encountered, the program outputs a warning, and when it
33462 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
33463 option is used. By default, only the first of a set of duplicates is used &--
33464 this makes it compatible with &(lsearch)& lookups. There is an option
33465 &%-lastdup%& which causes it to use the data for the last duplicate instead.
33466 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
33467 &%stderr%&. For other errors, where it doesn't actually make a new file, the
33468 return code is 2.
33469
33470
33471
33472
33473 .section "Finding individual retry times (exinext)" "SECTfinindret"
33474 .cindex "retry" "times"
33475 .cindex "&'exinext'&"
33476 A utility called &'exinext'& (mostly a Perl script) provides the ability to
33477 fish specific information out of the retry database. Given a mail domain (or a
33478 complete address), it looks up the hosts for that domain, and outputs any retry
33479 information for the hosts or for the domain. At present, the retry information
33480 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
33481 output. For example:
33482 .code
33483 $ exinext piglet@milne.fict.example
33484 kanga.milne.example:192.168.8.1 error 146: Connection refused
33485   first failed: 21-Feb-1996 14:57:34
33486   last tried:   21-Feb-1996 14:57:34
33487   next try at:  21-Feb-1996 15:02:34
33488 roo.milne.example:192.168.8.3 error 146: Connection refused
33489   first failed: 20-Jan-1996 13:12:08
33490   last tried:   21-Feb-1996 11:42:03
33491   next try at:  21-Feb-1996 19:42:03
33492   past final cutoff time
33493 .endd
33494 You can also give &'exinext'& a local part, without a domain, and it
33495 will give any retry information for that local part in your default domain.
33496 A message id can be used to obtain retry information pertaining to a specific
33497 message. This exists only when an attempt to deliver a message to a remote host
33498 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
33499 &'exinext'& is not particularly efficient, but then it is not expected to be
33500 run very often.
33501
33502 The &'exinext'& utility calls Exim to find out information such as the location
33503 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
33504 passed on to the &'exim'& commands. The first specifies an alternate Exim
33505 configuration file, and the second sets macros for use within the configuration
33506 file. These features are mainly to help in testing, but might also be useful in
33507 environments where more than one configuration file is in use.
33508
33509
33510
33511 .section "Hints database maintenance" "SECThindatmai"
33512 .cindex "hints database" "maintenance"
33513 .cindex "maintaining Exim's hints database"
33514 Three utility programs are provided for maintaining the DBM files that Exim
33515 uses to contain its delivery hint information. Each program requires two
33516 arguments. The first specifies the name of Exim's spool directory, and the
33517 second is the name of the database it is to operate on. These are as follows:
33518
33519 .ilist
33520 &'retry'&: the database of retry information
33521 .next
33522 &'wait-'&<&'transport name'&>: databases of information about messages waiting
33523 for remote hosts
33524 .next
33525 &'callout'&: the callout cache
33526 .next
33527 &'ratelimit'&: the data for implementing the ratelimit ACL condition
33528 .next
33529 &'misc'&: other hints data
33530 .endlist
33531
33532 The &'misc'& database is used for
33533
33534 .ilist
33535 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
33536 .next
33537 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
33538 &(smtp)& transport)
33539 .endlist
33540
33541
33542
33543 .section "exim_dumpdb" "SECID261"
33544 .cindex "&'exim_dumpdb'&"
33545 The entire contents of a database are written to the standard output by the
33546 &'exim_dumpdb'& program, which has no options or arguments other than the
33547 spool and database names. For example, to dump the retry database:
33548 .code
33549 exim_dumpdb /var/spool/exim retry
33550 .endd
33551 Two lines of output are produced for each entry:
33552 .code
33553 T:mail.ref.example:192.168.242.242 146 77 Connection refused
33554 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
33555 .endd
33556 The first item on the first line is the key of the record. It starts with one
33557 of the letters R, or T, depending on whether it refers to a routing or
33558 transport retry. For a local delivery, the next part is the local address; for
33559 a remote delivery it is the name of the remote host, followed by its failing IP
33560 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
33561 transport). If the remote port is not the standard one (port 25), it is added
33562 to the IP address. Then there follows an error code, an additional error code,
33563 and a textual description of the error.
33564
33565 The three times on the second line are the time of first failure, the time of
33566 the last delivery attempt, and the computed time for the next attempt. The line
33567 ends with an asterisk if the cutoff time for the last retry rule has been
33568 exceeded.
33569
33570 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
33571 consists of a host name followed by a list of ids for messages that are or were
33572 waiting to be delivered to that host. If there are a very large number for any
33573 one host, continuation records, with a sequence number added to the host name,
33574 may be seen. The data in these records is often out of date, because a message
33575 may be routed to several alternative hosts, and Exim makes no effort to keep
33576 cross-references.
33577
33578
33579
33580 .section "exim_tidydb" "SECID262"
33581 .cindex "&'exim_tidydb'&"
33582 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
33583 database. If run with no options, it removes all records that are more than 30
33584 days old. The age is calculated from the date and time that the record was last
33585 updated. Note that, in the case of the retry database, it is &'not'& the time
33586 since the first delivery failure. Information about a host that has been down
33587 for more than 30 days will remain in the database, provided that the record is
33588 updated sufficiently often.
33589
33590 The cutoff date can be altered by means of the &%-t%& option, which must be
33591 followed by a time. For example, to remove all records older than a week from
33592 the retry database:
33593 .code
33594 exim_tidydb -t 7d /var/spool/exim retry
33595 .endd
33596 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
33597 message ids. In the former these appear as data in records keyed by host &--
33598 they were messages that were waiting for that host &-- and in the latter they
33599 are the keys for retry information for messages that have suffered certain
33600 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
33601 message ids in database records are those of messages that are still on the
33602 queue. Message ids for messages that no longer exist are removed from
33603 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
33604 For the &'retry'& database, records whose keys are non-existent message ids are
33605 removed. The &'exim_tidydb'& utility outputs comments on the standard output
33606 whenever it removes information from the database.
33607
33608 Certain records are automatically removed by Exim when they are no longer
33609 needed, but others are not. For example, if all the MX hosts for a domain are
33610 down, a retry record is created for each one. If the primary MX host comes back
33611 first, its record is removed when Exim successfully delivers to it, but the
33612 records for the others remain because Exim has not tried to use those hosts.
33613
33614 It is important, therefore, to run &'exim_tidydb'& periodically on all the
33615 hints databases. You should do this at a quiet time of day, because it requires
33616 a database to be locked (and therefore inaccessible to Exim) while it does its
33617 work. Removing records from a DBM file does not normally make the file smaller,
33618 but all the common DBM libraries are able to re-use the space that is released.
33619 After an initial phase of increasing in size, the databases normally reach a
33620 point at which they no longer get any bigger, as long as they are regularly
33621 tidied.
33622
33623 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
33624 databases is likely to keep on increasing.
33625
33626
33627
33628
33629 .section "exim_fixdb" "SECID263"
33630 .cindex "&'exim_fixdb'&"
33631 The &'exim_fixdb'& program is a utility for interactively modifying databases.
33632 Its main use is for testing Exim, but it might also be occasionally useful for
33633 getting round problems in a live system. It has no options, and its interface
33634 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
33635 key of a database record can then be entered, and the data for that record is
33636 displayed.
33637
33638 If &"d"& is typed at the next prompt, the entire record is deleted. For all
33639 except the &'retry'& database, that is the only operation that can be carried
33640 out. For the &'retry'& database, each field is output preceded by a number, and
33641 data for individual fields can be changed by typing the field number followed
33642 by new data, for example:
33643 .code
33644 > 4 951102:1000
33645 .endd
33646 resets the time of the next delivery attempt. Time values are given as a
33647 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
33648 used as optional separators.
33649
33650
33651
33652
33653 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
33654 .cindex "mailbox" "maintenance"
33655 .cindex "&'exim_lock'&"
33656 .cindex "locking mailboxes"
33657 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
33658 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
33659 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
33660 a user agent while investigating a problem. The utility requires the name of
33661 the file as its first argument. If the locking is successful, the second
33662 argument is run as a command (using C's &[system()]& function); if there is no
33663 second argument, the value of the SHELL environment variable is used; if this
33664 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
33665 is unlocked and the utility ends. The following options are available:
33666
33667 .vlist
33668 .vitem &%-fcntl%&
33669 Use &[fcntl()]& locking on the open mailbox.
33670
33671 .vitem &%-flock%&
33672 Use &[flock()]& locking on the open mailbox, provided the operating system
33673 supports it.
33674
33675 .vitem &%-interval%&
33676 This must be followed by a number, which is a number of seconds; it sets the
33677 interval to sleep between retries (default 3).
33678
33679 .vitem &%-lockfile%&
33680 Create a lock file before opening the mailbox.
33681
33682 .vitem &%-mbx%&
33683 Lock the mailbox using MBX rules.
33684
33685 .vitem &%-q%&
33686 Suppress verification output.
33687
33688 .vitem &%-retries%&
33689 This must be followed by a number; it sets the number of times to try to get
33690 the lock (default 10).
33691
33692 .vitem &%-restore_time%&
33693 This option causes &%exim_lock%& to restore the modified and read times to the
33694 locked file before exiting. This allows you to access a locked mailbox (for
33695 example, to take a backup copy) without disturbing the times that the user
33696 subsequently sees.
33697
33698 .vitem &%-timeout%&
33699 This must be followed by a number, which is a number of seconds; it sets a
33700 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
33701 default), a non-blocking call is used.
33702
33703 .vitem &%-v%&
33704 Generate verbose output.
33705 .endlist
33706
33707 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
33708 default is to create a lock file and also to use &[fcntl()]& locking on the
33709 mailbox, which is the same as Exim's default. The use of &%-flock%& or
33710 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
33711 requires that the directory containing the file be writeable. Locking by lock
33712 file does not last for ever; Exim assumes that a lock file is expired if it is
33713 more than 30 minutes old.
33714
33715 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
33716 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
33717 to be taken out on the open mailbox, and an exclusive lock on the file
33718 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
33719 number of the mailbox file. When the locking is released, if an exclusive lock
33720 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
33721
33722 The default output contains verification of the locking that takes place. The
33723 &%-v%& option causes some additional information to be given. The &%-q%& option
33724 suppresses all output except error messages.
33725
33726 A command such as
33727 .code
33728 exim_lock /var/spool/mail/spqr
33729 .endd
33730 runs an interactive shell while the file is locked, whereas
33731 .display
33732 &`exim_lock -q /var/spool/mail/spqr <<End`&
33733 <&'some commands'&>
33734 &`End`&
33735 .endd
33736 runs a specific non-interactive sequence of commands while the file is locked,
33737 suppressing all verification output. A single command can be run by a command
33738 such as
33739 .code
33740 exim_lock -q /var/spool/mail/spqr \
33741   "cp /var/spool/mail/spqr /some/where"
33742 .endd
33743 Note that if a command is supplied, it must be entirely contained within the
33744 second argument &-- hence the quotes.
33745 .ecindex IIDutils
33746
33747
33748 . ////////////////////////////////////////////////////////////////////////////
33749 . ////////////////////////////////////////////////////////////////////////////
33750
33751 .chapter "The Exim monitor" "CHAPeximon"
33752 .scindex IIDeximon "Exim monitor" "description"
33753 .cindex "X-windows"
33754 .cindex "&'eximon'&"
33755 .cindex "Local/eximon.conf"
33756 .cindex "&_exim_monitor/EDITME_&"
33757 The Exim monitor is an application which displays in an X window information
33758 about the state of Exim's queue and what Exim is doing. An admin user can
33759 perform certain operations on messages from this GUI interface; however all
33760 such facilities are also available from the command line, and indeed, the
33761 monitor itself makes use of the command line to perform any actions requested.
33762
33763
33764
33765 .section "Running the monitor" "SECID264"
33766 The monitor is started by running the script called &'eximon'&. This is a shell
33767 script that sets up a number of environment variables, and then runs the
33768 binary called &_eximon.bin_&. The default appearance of the monitor window can
33769 be changed by editing the &_Local/eximon.conf_& file created by editing
33770 &_exim_monitor/EDITME_&. Comments in that file describe what the various
33771 parameters are for.
33772
33773 The parameters that get built into the &'eximon'& script can be overridden for
33774 a particular invocation by setting up environment variables of the same names,
33775 preceded by &`EXIMON_`&. For example, a shell command such as
33776 .code
33777 EXIMON_LOG_DEPTH=400 eximon
33778 .endd
33779 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
33780 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
33781 overrides the Exim log file configuration. This makes it possible to have
33782 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
33783 syslog messages are routed to a file on the local host.
33784
33785 X resources can be used to change the appearance of the window in the normal
33786 way. For example, a resource setting of the form
33787 .code
33788 Eximon*background: gray94
33789 .endd
33790 changes the colour of the background to light grey rather than white. The
33791 stripcharts are drawn with both the data lines and the reference lines in
33792 black. This means that the reference lines are not visible when on top of the
33793 data. However, their colour can be changed by setting a resource called
33794 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
33795 For example, if your X server is running Unix, you could set up lighter
33796 reference lines in the stripcharts by obeying
33797 .code
33798 xrdb -merge <<End
33799 Eximon*highlight: gray
33800 End
33801 .endd
33802 .cindex "admin user"
33803 In order to see the contents of messages on the queue, and to operate on them,
33804 &'eximon'& must either be run as root or by an admin user.
33805
33806 The monitor's window is divided into three parts. The first contains one or
33807 more stripcharts and two action buttons, the second contains a &"tail"& of the
33808 main log file, and the third is a display of the queue of messages awaiting
33809 delivery, with two more action buttons. The following sections describe these
33810 different parts of the display.
33811
33812
33813
33814
33815 .section "The stripcharts" "SECID265"
33816 .cindex "stripchart"
33817 The first stripchart is always a count of messages on the queue. Its name can
33818 be configured by setting QUEUE_STRIPCHART_NAME in the
33819 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
33820 configuration script by regular expression matches on log file entries, making
33821 it possible to display, for example, counts of messages delivered to certain
33822 hosts or using certain transports. The supplied defaults display counts of
33823 received and delivered messages, and of local and SMTP deliveries. The default
33824 period between stripchart updates is one minute; this can be adjusted by a
33825 parameter in the &_Local/eximon.conf_& file.
33826
33827 The stripchart displays rescale themselves automatically as the value they are
33828 displaying changes. There are always 10 horizontal lines in each chart; the
33829 title string indicates the value of each division when it is greater than one.
33830 For example, &"x2"& means that each division represents a value of 2.
33831
33832 It is also possible to have a stripchart which shows the percentage fullness of
33833 a particular disk partition, which is useful when local deliveries are confined
33834 to a single partition.
33835
33836 .cindex "&%statvfs%& function"
33837 This relies on the availability of the &[statvfs()]& function or equivalent in
33838 the operating system. Most, but not all versions of Unix that support Exim have
33839 this. For this particular stripchart, the top of the chart always represents
33840 100%, and the scale is given as &"x10%"&. This chart is configured by setting
33841 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
33842 &_Local/eximon.conf_& file.
33843
33844
33845
33846
33847 .section "Main action buttons" "SECID266"
33848 .cindex "size" "of monitor window"
33849 .cindex "Exim monitor" "window size"
33850 .cindex "window size"
33851 Below the stripcharts there is an action button for quitting the monitor. Next
33852 to this is another button marked &"Size"&. They are placed here so that
33853 shrinking the window to its default minimum size leaves just the queue count
33854 stripchart and these two buttons visible. Pressing the &"Size"& button causes
33855 the window to expand to its maximum size, unless it is already at the maximum,
33856 in which case it is reduced to its minimum.
33857
33858 When expanding to the maximum, if the window cannot be fully seen where it
33859 currently is, it is moved back to where it was the last time it was at full
33860 size. When it is expanding from its minimum size, the old position is
33861 remembered, and next time it is reduced to the minimum it is moved back there.
33862
33863 The idea is that you can keep a reduced window just showing one or two
33864 stripcharts at a convenient place on your screen, easily expand it to show
33865 the full window when required, and just as easily put it back to what it was.
33866 The idea is copied from what the &'twm'& window manager does for its
33867 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
33868 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
33869
33870 Normally, the monitor starts up with the window at its full size, but it can be
33871 built so that it starts up with the window at its smallest size, by setting
33872 START_SMALL=yes in &_Local/eximon.conf_&.
33873
33874
33875
33876 .section "The log display" "SECID267"
33877 .cindex "log" "tail of; in monitor"
33878 The second section of the window is an area in which a display of the tail of
33879 the main log is maintained.
33880 To save space on the screen, the timestamp on each log line is shortened by
33881 removing the date and, if &%log_timezone%& is set, the timezone.
33882 The log tail is not available when the only destination for logging data is
33883 syslog, unless the syslog lines are routed to a local file whose name is passed
33884 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
33885
33886 The log sub-window has a scroll bar at its lefthand side which can be used to
33887 move back to look at earlier text, and the up and down arrow keys also have a
33888 scrolling effect. The amount of log that is kept depends on the setting of
33889 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
33890 to use. When this is full, the earlier 50% of data is discarded &-- this is
33891 much more efficient than throwing it away line by line. The sub-window also has
33892 a horizontal scroll bar for accessing the ends of long log lines. This is the
33893 only means of horizontal scrolling; the right and left arrow keys are not
33894 available. Text can be cut from this part of the window using the mouse in the
33895 normal way. The size of this subwindow is controlled by parameters in the
33896 configuration file &_Local/eximon.conf_&.
33897
33898 Searches of the text in the log window can be carried out by means of the ^R
33899 and ^S keystrokes, which default to a reverse and a forward search,
33900 respectively. The search covers only the text that is displayed in the window.
33901 It cannot go further back up the log.
33902
33903 The point from which the search starts is indicated by a caret marker. This is
33904 normally at the end of the text in the window, but can be positioned explicitly
33905 by pointing and clicking with the left mouse button, and is moved automatically
33906 by a successful search. If new text arrives in the window when it is scrolled
33907 back, the caret remains where it is, but if the window is not scrolled back,
33908 the caret is moved to the end of the new text.
33909
33910 Pressing ^R or ^S pops up a window into which the search text can be typed.
33911 There are buttons for selecting forward or reverse searching, for carrying out
33912 the search, and for cancelling. If the &"Search"& button is pressed, the search
33913 happens and the window remains so that further searches can be done. If the
33914 &"Return"& key is pressed, a single search is done and the window is closed. If
33915 ^C is typed the search is cancelled.
33916
33917 The searching facility is implemented using the facilities of the Athena text
33918 widget. By default this pops up a window containing both &"search"& and
33919 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
33920 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
33921 However, the linkers in BSDI and HP-UX seem unable to handle an externally
33922 provided version of &%TextPop%& when the remaining parts of the text widget
33923 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
33924 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
33925 on these systems, at the expense of having unwanted items in the search popup
33926 window.
33927
33928
33929
33930 .section "The queue display" "SECID268"
33931 .cindex "queue" "display in monitor"
33932 The bottom section of the monitor window contains a list of all messages that
33933 are on the queue, which includes those currently being received or delivered,
33934 as well as those awaiting delivery. The size of this subwindow is controlled by
33935 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
33936 at which it is updated is controlled by another parameter in the same file &--
33937 the default is 5 minutes, since queue scans can be quite expensive. However,
33938 there is an &"Update"& action button just above the display which can be used
33939 to force an update of the queue display at any time.
33940
33941 When a host is down for some time, a lot of pending mail can build up for it,
33942 and this can make it hard to deal with other messages on the queue. To help
33943 with this situation there is a button next to &"Update"& called &"Hide"&. If
33944 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
33945 type anything in here and press &"Return"&, the text is added to a chain of
33946 such texts, and if every undelivered address in a message matches at least one
33947 of the texts, the message is not displayed.
33948
33949 If there is an address that does not match any of the texts, all the addresses
33950 are displayed as normal. The matching happens on the ends of addresses so, for
33951 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
33952 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
33953 has been set up, a button called &"Unhide"& is displayed. If pressed, it
33954 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
33955 a hide request is automatically cancelled after one hour.
33956
33957 While the dialogue box is displayed, you can't press any buttons or do anything
33958 else to the monitor window. For this reason, if you want to cut text from the
33959 queue display to use in the dialogue box, you have to do the cutting before
33960 pressing the &"Hide"& button.
33961
33962 The queue display contains, for each unhidden queued message, the length of
33963 time it has been on the queue, the size of the message, the message id, the
33964 message sender, and the first undelivered recipient, all on one line. If it is
33965 a bounce message, the sender is shown as &"<>"&. If there is more than one
33966 recipient to which the message has not yet been delivered, subsequent ones are
33967 listed on additional lines, up to a maximum configured number, following which
33968 an ellipsis is displayed. Recipients that have already received the message are
33969 not shown.
33970
33971 .cindex "frozen messages" "display"
33972 If a message is frozen, an asterisk is displayed at the left-hand side.
33973
33974 The queue display has a vertical scroll bar, and can also be scrolled by means
33975 of the arrow keys. Text can be cut from it using the mouse in the normal way.
33976 The text searching facilities, as described above for the log window, are also
33977 available, but the caret is always moved to the end of the text when the queue
33978 display is updated.
33979
33980
33981
33982 .section "The queue menu" "SECID269"
33983 .cindex "queue" "menu in monitor"
33984 If the &%shift%& key is held down and the left button is clicked when the mouse
33985 pointer is over the text for any message, an action menu pops up, and the first
33986 line of the queue display for the message is highlighted. This does not affect
33987 any selected text.
33988
33989 If you want to use some other event for popping up the menu, you can set the
33990 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
33991 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
33992 value set in this parameter is a standard X event description. For example, to
33993 run eximon using &%ctrl%& rather than &%shift%& you could use
33994 .code
33995 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
33996 .endd
33997 The title of the menu is the message id, and it contains entries which act as
33998 follows:
33999
34000 .ilist
34001 &'message log'&: The contents of the message log for the message are displayed
34002 in a new text window.
34003 .next
34004 &'headers'&: Information from the spool file that contains the envelope
34005 information and headers is displayed in a new text window. See chapter
34006 &<<CHAPspool>>& for a description of the format of spool files.
34007 .next
34008 &'body'&: The contents of the spool file containing the body of the message are
34009 displayed in a new text window. There is a default limit of 20,000 bytes to the
34010 amount of data displayed. This can be changed by setting the BODY_MAX
34011 option at compile time, or the EXIMON_BODY_MAX option at run time.
34012 .next
34013 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
34014 delivery of the message. This causes an automatic thaw if the message is
34015 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
34016 a new text window. The delivery is run in a separate process, to avoid holding
34017 up the monitor while the delivery proceeds.
34018 .next
34019 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
34020 that the message be frozen.
34021 .next
34022 .cindex "thawing messages"
34023 .cindex "unfreezing messages"
34024 .cindex "frozen messages" "thawing"
34025 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
34026 that the message be thawed.
34027 .next
34028 .cindex "delivery" "forcing failure"
34029 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
34030 that Exim gives up trying to deliver the message. A bounce message is generated
34031 for any remaining undelivered addresses.
34032 .next
34033 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
34034 that the message be deleted from the system without generating a bounce
34035 message.
34036 .next
34037 &'add recipient'&: A dialog box is displayed into which a recipient address can
34038 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34039 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34040 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34041 causes a call to Exim to be made using the &%-Mar%& option to request that an
34042 additional recipient be added to the message, unless the entry box is empty, in
34043 which case no action is taken.
34044 .next
34045 &'mark delivered'&: A dialog box is displayed into which a recipient address
34046 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34047 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34048 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34049 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
34050 recipient address as already delivered, unless the entry box is empty, in which
34051 case no action is taken.
34052 .next
34053 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
34054 mark all recipient addresses as already delivered.
34055 .next
34056 &'edit sender'&: A dialog box is displayed initialized with the current
34057 sender's address. Pressing RETURN causes a call to Exim to be made using the
34058 &%-Mes%& option to replace the sender address, unless the entry box is empty,
34059 in which case no action is taken. If you want to set an empty sender (as in
34060 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
34061 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
34062 the address is qualified with that domain.
34063 .endlist
34064
34065 When a delivery is forced, a window showing the &%-v%& output is displayed. In
34066 other cases when a call to Exim is made, if there is any output from Exim (in
34067 particular, if the command fails) a window containing the command and the
34068 output is displayed. Otherwise, the results of the action are normally apparent
34069 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
34070 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
34071 if no output is generated.
34072
34073 The queue display is automatically updated for actions such as freezing and
34074 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
34075 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
34076 force an update of the display after one of these actions.
34077
34078 In any text window that is displayed as result of a menu action, the normal
34079 cut-and-paste facility is available, and searching can be carried out using ^R
34080 and ^S, as described above for the log tail window.
34081 .ecindex IIDeximon
34082
34083
34084
34085
34086
34087 . ////////////////////////////////////////////////////////////////////////////
34088 . ////////////////////////////////////////////////////////////////////////////
34089
34090 .chapter "Security considerations" "CHAPsecurity"
34091 .scindex IIDsecurcon "security" "discussion of"
34092 This chapter discusses a number of issues concerned with security, some of
34093 which are also covered in other parts of this manual.
34094
34095 For reasons that this author does not understand, some people have promoted
34096 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
34097 existence of this chapter in the documentation. However, the intent of the
34098 chapter is simply to describe the way Exim works in relation to certain
34099 security concerns, not to make any specific claims about the effectiveness of
34100 its security as compared with other MTAs.
34101
34102 What follows is a description of the way Exim is supposed to be. Best efforts
34103 have been made to try to ensure that the code agrees with the theory, but an
34104 absence of bugs can never be guaranteed. Any that are reported will get fixed
34105 as soon as possible.
34106
34107
34108 .section "Building a more &""hardened""& Exim" "SECID286"
34109 .cindex "security" "build-time features"
34110 There are a number of build-time options that can be set in &_Local/Makefile_&
34111 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
34112 Exim administrator who does not have the root password, or by someone who has
34113 penetrated the Exim (but not the root) account. These options are as follows:
34114
34115 .ilist
34116 ALT_CONFIG_PREFIX can be set to a string that is required to match the
34117 start of any file names used with the &%-C%& option. When it is set, these file
34118 names are also not allowed to contain the sequence &"/../"&. (However, if the
34119 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
34120 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
34121 default setting for &%ALT_CONFIG_PREFIX%&.
34122
34123 If the permitted configuration files are confined to a directory to
34124 which only root has access, this guards against someone who has broken
34125 into the Exim account from running a privileged Exim with an arbitrary
34126 configuration file, and using it to break into other accounts.
34127 .next
34128
34129 If a non-trusted configuration file (i.e. not the default configuration file
34130 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
34131 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
34132 the next item), then root privilege is retained only if the caller of Exim is
34133 root. This locks out the possibility of testing a configuration using &%-C%&
34134 right through message reception and delivery, even if the caller is root. The
34135 reception works, but by that time, Exim is running as the Exim user, so when
34136 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
34137 privilege to be lost. However, root can test reception and delivery using two
34138 separate commands.
34139
34140 .next
34141 The WHITELIST_D_MACROS build option declares some macros to be safe to override
34142 with &%-D%& if the real uid is one of root, the Exim run-time user or the
34143 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
34144 requiring the run-time value supplied to &%-D%& to match a regex that errs on
34145 the restrictive side.  Requiring build-time selection of safe macros is onerous
34146 but this option is intended solely as a transition mechanism to permit
34147 previously-working configurations to continue to work after release 4.73.
34148 .next
34149 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
34150 is disabled.
34151 .next
34152 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
34153 never to be used for any deliveries. This is like the &%never_users%& runtime
34154 option, but it cannot be overridden; the runtime option adds additional users
34155 to the list. The default setting is &"root"&; this prevents a non-root user who
34156 is permitted to modify the runtime file from using Exim as a way to get root.
34157 .endlist
34158
34159
34160
34161 .section "Root privilege" "SECID270"
34162 .cindex "setuid"
34163 .cindex "root privilege"
34164 The Exim binary is normally setuid to root, which means that it gains root
34165 privilege (runs as root) when it starts execution. In some special cases (for
34166 example, when the daemon is not in use and there are no local deliveries), it
34167 may be possible to run Exim setuid to some user other than root. This is
34168 discussed in the next section. However, in most installations, root privilege
34169 is required for two things:
34170
34171 .ilist
34172 To set up a socket connected to the standard SMTP port (25) when initialising
34173 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
34174 not required.
34175 .next
34176 To be able to change uid and gid in order to read users' &_.forward_& files and
34177 perform local deliveries as the receiving user or as specified in the
34178 configuration.
34179 .endlist
34180
34181 It is not necessary to be root to do any of the other things Exim does, such as
34182 receiving messages and delivering them externally over SMTP, and it is
34183 obviously more secure if Exim does not run as root except when necessary.
34184 For this reason, a user and group for Exim to use must be defined in
34185 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
34186 group"&. Their values can be changed by the run time configuration, though this
34187 is not recommended. Often a user called &'exim'& is used, but some sites use
34188 &'mail'& or another user name altogether.
34189
34190 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
34191 abdication; the process cannot regain root afterwards. Prior to release 4.00,
34192 &[seteuid()]& was used in some circumstances, but this is no longer the case.
34193
34194 After a new Exim process has interpreted its command line options, it changes
34195 uid and gid in the following cases:
34196
34197 .ilist
34198 .oindex "&%-C%&"
34199 .oindex "&%-D%&"
34200 If the &%-C%& option is used to specify an alternate configuration file, or if
34201 the &%-D%& option is used to define macro values for the configuration, and the
34202 calling process is not running as root, the uid and gid are changed to those of
34203 the calling process.
34204 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
34205 option may not be used at all.
34206 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
34207 can be supplied if the calling process is running as root, the Exim run-time
34208 user or CONFIGURE_OWNER, if defined.
34209 .next
34210 .oindex "&%-be%&"
34211 .oindex "&%-bf%&"
34212 .oindex "&%-bF%&"
34213 If the expansion test option (&%-be%&) or one of the filter testing options
34214 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
34215 calling process.
34216 .next
34217 If the process is not a daemon process or a queue runner process or a delivery
34218 process or a process for testing address routing (started with &%-bt%&), the
34219 uid and gid are changed to the Exim user and group. This means that Exim always
34220 runs under its own uid and gid when receiving messages. This also applies when
34221 testing address verification
34222 .oindex "&%-bv%&"
34223 .oindex "&%-bh%&"
34224 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
34225 option).
34226 .next
34227 For a daemon, queue runner, delivery, or address testing process, the uid
34228 remains as root at this stage, but the gid is changed to the Exim group.
34229 .endlist
34230
34231 The processes that initially retain root privilege behave as follows:
34232
34233 .ilist
34234 A daemon process changes the gid to the Exim group and the uid to the Exim
34235 user after setting up one or more listening sockets. The &[initgroups()]&
34236 function is called, so that if the Exim user is in any additional groups, they
34237 will be used during message reception.
34238 .next
34239 A queue runner process retains root privilege throughout its execution. Its
34240 job is to fork a controlled sequence of delivery processes.
34241 .next
34242 A delivery process retains root privilege throughout most of its execution,
34243 but any actual deliveries (that is, the transports themselves) are run in
34244 subprocesses which always change to a non-root uid and gid. For local
34245 deliveries this is typically the uid and gid of the owner of the mailbox; for
34246 remote deliveries, the Exim uid and gid are used. Once all the delivery
34247 subprocesses have been run, a delivery process changes to the Exim uid and gid
34248 while doing post-delivery tidying up such as updating the retry database and
34249 generating bounce and warning messages.
34250
34251 While the recipient addresses in a message are being routed, the delivery
34252 process runs as root. However, if a user's filter file has to be processed,
34253 this is done in a subprocess that runs under the individual user's uid and
34254 gid. A system filter is run as root unless &%system_filter_user%& is set.
34255 .next
34256 A process that is testing addresses (the &%-bt%& option) runs as root so that
34257 the routing is done in the same environment as a message delivery.
34258 .endlist
34259
34260
34261
34262
34263 .section "Running Exim without privilege" "SECTrunexiwitpri"
34264 .cindex "privilege, running without"
34265 .cindex "unprivileged running"
34266 .cindex "root privilege" "running without"
34267 Some installations like to run Exim in an unprivileged state for more of its
34268 operation, for added security. Support for this mode of operation is provided
34269 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
34270 gid are changed to the Exim user and group at the start of a delivery process
34271 (and also queue runner and address testing processes). This means that address
34272 routing is no longer run as root, and the deliveries themselves cannot change
34273 to any other uid.
34274
34275 .cindex SIGHUP
34276 .cindex "daemon" "restarting"
34277 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
34278 that the daemon can still be started in the usual way, and it can respond
34279 correctly to SIGHUP because the re-invocation regains root privilege.
34280
34281 An alternative approach is to make Exim setuid to the Exim user and also setgid
34282 to the Exim group. If you do this, the daemon must be started from a root
34283 process. (Calling Exim from a root process makes it behave in the way it does
34284 when it is setuid root.) However, the daemon cannot restart itself after a
34285 SIGHUP signal because it cannot regain privilege.
34286
34287 It is still useful to set &%deliver_drop_privilege%& in this case, because it
34288 stops Exim from trying to re-invoke itself to do a delivery after a message has
34289 been received. Such a re-invocation is a waste of resources because it has no
34290 effect.
34291
34292 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
34293 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
34294 to the Exim user seems a clean approach, but there is one complication:
34295
34296 In this style of operation, Exim is running with the real uid and gid set to
34297 those of the calling process, and the effective uid/gid set to Exim's values.
34298 Ideally, any association with the calling process' uid/gid should be dropped,
34299 that is, the real uid/gid should be reset to the effective values so as to
34300 discard any privileges that the caller may have. While some operating systems
34301 have a function that permits this action for a non-root effective uid, quite a
34302 number of them do not. Because of this lack of standardization, Exim does not
34303 address this problem at this time.
34304
34305 For this reason, the recommended approach for &"mostly unprivileged"& running
34306 is to keep the Exim binary setuid to root, and to set
34307 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
34308 be used in the most straightforward way.
34309
34310 If you configure Exim not to run delivery processes as root, there are a
34311 number of restrictions on what you can do:
34312
34313 .ilist
34314 You can deliver only as the Exim user/group. You should  explicitly use the
34315 &%user%& and &%group%& options to override routers or local transports that
34316 normally deliver as the recipient. This makes sure that configurations that
34317 work in this mode function the same way in normal mode. Any implicit or
34318 explicit specification of another user causes an error.
34319 .next
34320 Use of &_.forward_& files is severely restricted, such that it is usually
34321 not worthwhile to include them in the configuration.
34322 .next
34323 Users who wish to use &_.forward_& would have to make their home directory and
34324 the file itself accessible to the Exim user. Pipe and append-to-file entries,
34325 and their equivalents in Exim filters, cannot be used. While they could be
34326 enabled in the Exim user's name, that would be insecure and not very useful.
34327 .next
34328 Unless the local user mailboxes are all owned by the Exim user (possible in
34329 some POP3 or IMAP-only environments):
34330
34331 .olist
34332 They must be owned by the Exim group and be writeable by that group. This
34333 implies you must set &%mode%& in the appendfile configuration, as well as the
34334 mode of the mailbox files themselves.
34335 .next
34336 You must set &%no_check_owner%&, since most or all of the files will not be
34337 owned by the Exim user.
34338 .next
34339 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
34340 on a newly created mailbox when unprivileged. This also implies that new
34341 mailboxes need to be created manually.
34342 .endlist olist
34343 .endlist ilist
34344
34345
34346 These restrictions severely restrict what can be done in local deliveries.
34347 However, there are no restrictions on remote deliveries. If you are running a
34348 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
34349 gives more security at essentially no cost.
34350
34351 If you are using the &%mua_wrapper%& facility (see chapter
34352 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
34353
34354
34355
34356
34357 .section "Delivering to local files" "SECID271"
34358 Full details of the checks applied by &(appendfile)& before it writes to a file
34359 are given in chapter &<<CHAPappendfile>>&.
34360
34361
34362
34363 .section "IPv4 source routing" "SECID272"
34364 .cindex "source routing" "in IP packets"
34365 .cindex "IP source routing"
34366 Many operating systems suppress IP source-routed packets in the kernel, but
34367 some cannot be made to do this, so Exim does its own check. It logs incoming
34368 IPv4 source-routed TCP calls, and then drops them. Things are all different in
34369 IPv6. No special checking is currently done.
34370
34371
34372
34373 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
34374 Support for these SMTP commands is disabled by default. If required, they can
34375 be enabled by defining suitable ACLs.
34376
34377
34378
34379
34380 .section "Privileged users" "SECID274"
34381 .cindex "trusted users"
34382 .cindex "admin user"
34383 .cindex "privileged user"
34384 .cindex "user" "trusted"
34385 .cindex "user" "admin"
34386 Exim recognizes two sets of users with special privileges. Trusted users are
34387 able to submit new messages to Exim locally, but supply their own sender
34388 addresses and information about a sending host. For other users submitting
34389 local messages, Exim sets up the sender address from the uid, and doesn't
34390 permit a remote host to be specified.
34391
34392 .oindex "&%-f%&"
34393 However, an untrusted user is permitted to use the &%-f%& command line option
34394 in the special form &%-f <>%& to indicate that a delivery failure for the
34395 message should not cause an error report. This affects the message's envelope,
34396 but it does not affect the &'Sender:'& header. Untrusted users may also be
34397 permitted to use specific forms of address with the &%-f%& option by setting
34398 the &%untrusted_set_sender%& option.
34399
34400 Trusted users are used to run processes that receive mail messages from some
34401 other mail domain and pass them on to Exim for delivery either locally, or over
34402 the Internet. Exim trusts a caller that is running as root, as the Exim user,
34403 as any user listed in the &%trusted_users%& configuration option, or under any
34404 group listed in the &%trusted_groups%& option.
34405
34406 Admin users are permitted to do things to the messages on Exim's queue. They
34407 can freeze or thaw messages, cause them to be returned to their senders, remove
34408 them entirely, or modify them in various ways. In addition, admin users can run
34409 the Exim monitor and see all the information it is capable of providing, which
34410 includes the contents of files on the spool.
34411
34412 .oindex "&%-M%&"
34413 .oindex "&%-q%&"
34414 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
34415 delivery of messages on its queue is restricted to admin users. This
34416 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
34417 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
34418 queue is also restricted to admin users. This restriction can be relaxed by
34419 setting &%no_queue_list_requires_admin%&.
34420
34421 Exim recognizes an admin user if the calling process is running as root or as
34422 the Exim user or if any of the groups associated with the calling process is
34423 the Exim group. It is not necessary actually to be running under the Exim
34424 group. However, if admin users who are not root or the Exim user are to access
34425 the contents of files on the spool via the Exim monitor (which runs
34426 unprivileged), Exim must be built to allow group read access to its spool
34427 files.
34428
34429
34430
34431 .section "Spool files" "SECID275"
34432 .cindex "spool directory" "files"
34433 Exim's spool directory and everything it contains is owned by the Exim user and
34434 set to the Exim group. The mode for spool files is defined in the
34435 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
34436 any user who is a member of the Exim group can access these files.
34437
34438
34439
34440 .section "Use of argv[0]" "SECID276"
34441 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
34442 of specific strings, Exim assumes certain options. For example, calling Exim
34443 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
34444 to calling it with the option &%-bS%&. There are no security implications in
34445 this.
34446
34447
34448
34449 .section "Use of %f formatting" "SECID277"
34450 The only use made of &"%f"& by Exim is in formatting load average values. These
34451 are actually stored in integer variables as 1000 times the load average.
34452 Consequently, their range is limited and so therefore is the length of the
34453 converted output.
34454
34455
34456
34457 .section "Embedded Exim path" "SECID278"
34458 Exim uses its own path name, which is embedded in the code, only when it needs
34459 to re-exec in order to regain root privilege. Therefore, it is not root when it
34460 does so. If some bug allowed the path to get overwritten, it would lead to an
34461 arbitrary program's being run as exim, not as root.
34462
34463
34464
34465 .section "Dynamic module directory" "SECTdynmoddir"
34466 Any dynamically loadable modules must be installed into the directory
34467 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
34468 loading it.
34469
34470
34471 .section "Use of sprintf()" "SECID279"
34472 .cindex "&[sprintf()]&"
34473 A large number of occurrences of &"sprintf"& in the code are actually calls to
34474 &'string_sprintf()'&, a function that returns the result in malloc'd store.
34475 The intermediate formatting is done into a large fixed buffer by a function
34476 that runs through the format string itself, and checks the length of each
34477 conversion before performing it, thus preventing buffer overruns.
34478
34479 The remaining uses of &[sprintf()]& happen in controlled circumstances where
34480 the output buffer is known to be sufficiently long to contain the converted
34481 string.
34482
34483
34484
34485 .section "Use of debug_printf() and log_write()" "SECID280"
34486 Arbitrary strings are passed to both these functions, but they do their
34487 formatting by calling the function &'string_vformat()'&, which runs through
34488 the format string itself, and checks the length of each conversion.
34489
34490
34491
34492 .section "Use of strcat() and strcpy()" "SECID281"
34493 These are used only in cases where the output buffer is known to be large
34494 enough to hold the result.
34495 .ecindex IIDsecurcon
34496
34497
34498
34499
34500 . ////////////////////////////////////////////////////////////////////////////
34501 . ////////////////////////////////////////////////////////////////////////////
34502
34503 .chapter "Format of spool files" "CHAPspool"
34504 .scindex IIDforspo1 "format" "spool files"
34505 .scindex IIDforspo2 "spool directory" "format of files"
34506 .scindex IIDforspo3 "spool files" "format of"
34507 .cindex "spool files" "editing"
34508 A message on Exim's queue consists of two files, whose names are the message id
34509 followed by -D and -H, respectively. The data portion of the message is kept in
34510 the -D file on its own. The message's envelope, status, and headers are all
34511 kept in the -H file, whose format is described in this chapter. Each of these
34512 two files contains the final component of its own name as its first line. This
34513 is insurance against disk crashes where the directory is lost but the files
34514 themselves are recoverable.
34515
34516 Some people are tempted into editing -D files in order to modify messages. You
34517 need to be extremely careful if you do this; it is not recommended and you are
34518 on your own if you do it. Here are some of the pitfalls:
34519
34520 .ilist
34521 You must ensure that Exim does not try to deliver the message while you are
34522 fiddling with it. The safest way is to take out a write lock on the -D file,
34523 which is what Exim itself does, using &[fcntl()]&. If you update the file in
34524 place, the lock will be retained. If you write a new file and rename it, the
34525 lock will be lost at the instant of rename.
34526 .next
34527 .vindex "&$body_linecount$&"
34528 If you change the number of lines in the file, the value of
34529 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
34530 present, this value is not used by Exim, but there is no guarantee that this
34531 will always be the case.
34532 .next
34533 If the message is in MIME format, you must take care not to break it.
34534 .next
34535 If the message is cryptographically signed, any change will invalidate the
34536 signature.
34537 .endlist
34538 All in all, modifying -D files is fraught with danger.
34539
34540 Files whose names end with -J may also be seen in the &_input_& directory (or
34541 its subdirectories when &%split_spool_directory%& is set). These are journal
34542 files, used to record addresses to which the message has been delivered during
34543 the course of a delivery attempt. If there are still undelivered recipients at
34544 the end, the -H file is updated, and the -J file is deleted. If, however, there
34545 is some kind of crash (for example, a power outage) before this happens, the -J
34546 file remains in existence. When Exim next processes the message, it notices the
34547 -J file and uses it to update the -H file before starting the next delivery
34548 attempt.
34549
34550 .section "Format of the -H file" "SECID282"
34551 .cindex "uid (user id)" "in spool file"
34552 .cindex "gid (group id)" "in spool file"
34553 The second line of the -H file contains the login name for the uid of the
34554 process that called Exim to read the message, followed by the numerical uid and
34555 gid. For a locally generated message, this is normally the user who sent the
34556 message. For a message received over TCP/IP via the daemon, it is
34557 normally the Exim user.
34558
34559 The third line of the file contains the address of the message's sender as
34560 transmitted in the envelope, contained in angle brackets. The sender address is
34561 empty for bounce messages. For incoming SMTP mail, the sender address is given
34562 in the MAIL command. For locally generated mail, the sender address is
34563 created by Exim from the login name of the current user and the configured
34564 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
34565 leading &"From&~"& line if the caller is trusted, or if the supplied address is
34566 &"<>"& or an address that matches &%untrusted_set_senders%&.
34567
34568 The fourth line contains two numbers. The first is the time that the message
34569 was received, in the conventional Unix form &-- the number of seconds since the
34570 start of the epoch. The second number is a count of the number of messages
34571 warning of delayed delivery that have been sent to the sender.
34572
34573 There follow a number of lines starting with a hyphen. These can appear in any
34574 order, and are omitted when not relevant:
34575
34576 .vlist
34577 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
34578 This item is obsolete, and is not generated from Exim release 4.61 onwards;
34579 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
34580 recognized, to provide backward compatibility. In the old format, a line of
34581 this form is present for every ACL variable that is not empty. The number
34582 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
34583 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
34584 the data string for the variable. The string itself starts at the beginning of
34585 the next line, and is followed by a newline character. It may contain internal
34586 newlines.
34587
34588 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
34589 A line of this form is present for every ACL connection variable that is
34590 defined. Note that there is a space between &%-aclc%& and the rest of the name.
34591 The length is the length of the data string for the variable. The string itself
34592 starts at the beginning of the next line, and is followed by a newline
34593 character. It may contain internal newlines.
34594
34595 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
34596 A line of this form is present for every ACL message variable that is defined.
34597 Note that there is a space between &%-aclm%& and the rest of the name. The
34598 length is the length of the data string for the variable. The string itself
34599 starts at the beginning of the next line, and is followed by a newline
34600 character. It may contain internal newlines.
34601
34602 .vitem "&%-active_hostname%&&~<&'hostname'&>"
34603 This is present if, when the message was received over SMTP, the value of
34604 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
34605
34606 .vitem &%-allow_unqualified_recipient%&
34607 This is present if unqualified recipient addresses are permitted in header
34608 lines (to stop such addresses from being qualified if rewriting occurs at
34609 transport time). Local messages that were input using &%-bnq%& and remote
34610 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
34611
34612 .vitem &%-allow_unqualified_sender%&
34613 This is present if unqualified sender addresses are permitted in header lines
34614 (to stop such addresses from being qualified if rewriting occurs at transport
34615 time). Local messages that were input using &%-bnq%& and remote messages from
34616 hosts that match &%sender_unqualified_hosts%& set this flag.
34617
34618 .vitem "&%-auth_id%&&~<&'text'&>"
34619 The id information for a message received on an authenticated SMTP connection
34620 &-- the value of the &$authenticated_id$& variable.
34621
34622 .vitem "&%-auth_sender%&&~<&'address'&>"
34623 The address of an authenticated sender &-- the value of the
34624 &$authenticated_sender$& variable.
34625
34626 .vitem "&%-body_linecount%&&~<&'number'&>"
34627 This records the number of lines in the body of the message, and is always
34628 present.
34629
34630 .vitem "&%-body_zerocount%&&~<&'number'&>"
34631 This records the number of binary zero bytes in the body of the message, and is
34632 present if the number is greater than zero.
34633
34634 .vitem &%-deliver_firsttime%&
34635 This is written when a new message is first added to the spool. When the spool
34636 file is updated after a deferral, it is omitted.
34637
34638 .vitem "&%-frozen%&&~<&'time'&>"
34639 .cindex "frozen messages" "spool data"
34640 The message is frozen, and the freezing happened at <&'time'&>.
34641
34642 .vitem "&%-helo_name%&&~<&'text'&>"
34643 This records the host name as specified by a remote host in a HELO or EHLO
34644 command.
34645
34646 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
34647 This records the IP address of the host from which the message was received and
34648 the remote port number that was used. It is omitted for locally generated
34649 messages.
34650
34651 .vitem "&%-host_auth%&&~<&'text'&>"
34652 If the message was received on an authenticated SMTP connection, this records
34653 the name of the authenticator &-- the value of the
34654 &$sender_host_authenticated$& variable.
34655
34656 .vitem &%-host_lookup_failed%&
34657 This is present if an attempt to look up the sending host's name from its IP
34658 address failed. It corresponds to the &$host_lookup_failed$& variable.
34659
34660 .vitem "&%-host_name%&&~<&'text'&>"
34661 .cindex "reverse DNS lookup"
34662 .cindex "DNS" "reverse lookup"
34663 This records the name of the remote host from which the message was received,
34664 if the host name was looked up from the IP address when the message was being
34665 received. It is not present if no reverse lookup was done.
34666
34667 .vitem "&%-ident%&&~<&'text'&>"
34668 For locally submitted messages, this records the login of the originating user,
34669 unless it was a trusted user and the &%-oMt%& option was used to specify an
34670 ident value. For messages received over TCP/IP, this records the ident string
34671 supplied by the remote host, if any.
34672
34673 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
34674 This records the IP address of the local interface and the port number through
34675 which a message was received from a remote host. It is omitted for locally
34676 generated messages.
34677
34678 .vitem &%-local%&
34679 The message is from a local sender.
34680
34681 .vitem &%-localerror%&
34682 The message is a locally-generated bounce message.
34683
34684 .vitem "&%-local_scan%&&~<&'string'&>"
34685 This records the data string that was returned by the &[local_scan()]& function
34686 when the message was received &-- the value of the &$local_scan_data$&
34687 variable. It is omitted if no data was returned.
34688
34689 .vitem &%-manual_thaw%&
34690 The message was frozen but has been thawed manually, that is, by an explicit
34691 Exim command rather than via the auto-thaw process.
34692
34693 .vitem &%-N%&
34694 A testing delivery process was started using the &%-N%& option to suppress any
34695 actual deliveries, but delivery was deferred. At any further delivery attempts,
34696 &%-N%& is assumed.
34697
34698 .vitem &%-received_protocol%&
34699 This records the value of the &$received_protocol$& variable, which contains
34700 the name of the protocol by which the message was received.
34701
34702 .vitem &%-sender_set_untrusted%&
34703 The envelope sender of this message was set by an untrusted local caller (used
34704 to ensure that the caller is displayed in queue listings).
34705
34706 .vitem "&%-spam_score_int%&&~<&'number'&>"
34707 If a message was scanned by SpamAssassin, this is present. It records the value
34708 of &$spam_score_int$&.
34709
34710 .vitem &%-tls_certificate_verified%&
34711 A TLS certificate was received from the client that sent this message, and the
34712 certificate was verified by the server.
34713
34714 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
34715 When the message was received over an encrypted connection, this records the
34716 name of the cipher suite that was used.
34717
34718 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
34719 When the message was received over an encrypted connection, and a certificate
34720 was received from the client, this records the Distinguished Name from that
34721 certificate.
34722 .endlist
34723
34724 Following the options there is a list of those addresses to which the message
34725 is not to be delivered. This set of addresses is initialized from the command
34726 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
34727 is set; otherwise it starts out empty. Whenever a successful delivery is made,
34728 the address is added to this set. The addresses are kept internally as a
34729 balanced binary tree, and it is a representation of that tree which is written
34730 to the spool file. If an address is expanded via an alias or forward file, the
34731 original address is added to the tree when deliveries to all its child
34732 addresses are complete.
34733
34734 If the tree is empty, there is a single line in the spool file containing just
34735 the text &"XX"&. Otherwise, each line consists of two letters, which are either
34736 Y or N, followed by an address. The address is the value for the node of the
34737 tree, and the letters indicate whether the node has a left branch and/or a
34738 right branch attached to it, respectively. If branches exist, they immediately
34739 follow. Here is an example of a three-node tree:
34740 .code
34741 YY darcy@austen.fict.example
34742 NN alice@wonderland.fict.example
34743 NN editor@thesaurus.ref.example
34744 .endd
34745 After the non-recipients tree, there is a list of the message's recipients.
34746 This is a simple list, preceded by a count. It includes all the original
34747 recipients of the message, including those to whom the message has already been
34748 delivered. In the simplest case, the list contains one address per line. For
34749 example:
34750 .code
34751 4
34752 editor@thesaurus.ref.example
34753 darcy@austen.fict.example
34754 rdo@foundation
34755 alice@wonderland.fict.example
34756 .endd
34757 However, when a child address has been added to the top-level addresses as a
34758 result of the use of the &%one_time%& option on a &(redirect)& router, each
34759 line is of the following form:
34760 .display
34761 <&'top-level address'&> <&'errors_to address'&> &&&
34762   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
34763 .endd
34764 The 01 flag bit indicates the presence of the three other fields that follow
34765 the top-level address. Other bits may be used in future to support additional
34766 fields. The <&'parent number'&> is the offset in the recipients list of the
34767 original parent of the &"one time"& address. The first two fields are the
34768 envelope sender that is associated with this address and its length. If the
34769 length is zero, there is no special envelope sender (there are then two space
34770 characters in the line). A non-empty field can arise from a &(redirect)& router
34771 that has an &%errors_to%& setting.
34772
34773
34774 A blank line separates the envelope and status information from the headers
34775 which follow. A header may occupy several lines of the file, and to save effort
34776 when reading it in, each header is preceded by a number and an identifying
34777 character. The number is the number of characters in the header, including any
34778 embedded newlines and the terminating newline. The character is one of the
34779 following:
34780
34781 .table2 50pt
34782 .row <&'blank'&>         "header in which Exim has no special interest"
34783 .row &`B`&               "&'Bcc:'& header"
34784 .row &`C`&               "&'Cc:'& header"
34785 .row &`F`&               "&'From:'& header"
34786 .row &`I`&               "&'Message-id:'& header"
34787 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
34788 .row &`R`&               "&'Reply-To:'& header"
34789 .row &`S`&               "&'Sender:'& header"
34790 .row &`T`&               "&'To:'& header"
34791 .row &`*`&               "replaced or deleted header"
34792 .endtable
34793
34794 Deleted or replaced (rewritten) headers remain in the spool file for debugging
34795 purposes. They are not transmitted when the message is delivered. Here is a
34796 typical set of headers:
34797 .code
34798 111P Received: by hobbit.fict.example with local (Exim 4.00)
34799 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
34800 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
34801 038* X-rewrote-sender: bb@hobbit.fict.example
34802 042* From: Bilbo Baggins <bb@hobbit.fict.example>
34803 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
34804 099* To: alice@wonderland.fict.example, rdo@foundation,
34805 darcy@austen.fict.example, editor@thesaurus.ref.example
34806 104T To: alice@wonderland.fict.example, rdo@foundation.example,
34807 darcy@austen.fict.example, editor@thesaurus.ref.example
34808 038  Date: Fri, 11 May 2001 10:28:59 +0100
34809 .endd
34810 The asterisked headers indicate that the envelope sender, &'From:'& header, and
34811 &'To:'& header have been rewritten, the last one because routing expanded the
34812 unqualified domain &'foundation'&.
34813 .ecindex IIDforspo1
34814 .ecindex IIDforspo2
34815 .ecindex IIDforspo3
34816
34817 . ////////////////////////////////////////////////////////////////////////////
34818 . ////////////////////////////////////////////////////////////////////////////
34819
34820 .chapter "Support for DKIM (DomainKeys Identified Mail) - RFC4871" "CHID12" &&&
34821          "DKIM Support"
34822 .cindex "DKIM"
34823
34824 Since version 4.70, DKIM support is compiled into Exim by default. It can be
34825 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
34826
34827 Exim's DKIM implementation allows to
34828 .olist
34829 Sign outgoing messages: This function is implemented in the SMTP transport.
34830 It can co-exist with all other Exim features, including transport filters.
34831 .next
34832 Verify signatures in incoming messages: This is implemented by an additional
34833 ACL (acl_smtp_dkim), which can be called several times per message, with
34834 different signature contexts.
34835 .endlist
34836
34837 In typical Exim style, the verification implementation does not include any
34838 default "policy". Instead it enables you to build your own policy using
34839 Exim's standard controls.
34840
34841 Please note that verification of DKIM signatures in incoming mail is turned
34842 on by default for logging purposes. For each signature in incoming email,
34843 exim will log a line displaying the most important signature details, and the
34844 signature status. Here is an example:
34845 .code
34846 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM: d=facebookmail.com s=q1-2009b c=relaxed/relaxed a=rsa-sha1 i=@facebookmail.com t=1252484542 [verification succeeded]
34847 .endd
34848 You might want to turn off DKIM verification processing entirely for internal
34849 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
34850 control modifier. This should typically be done in the RCPT ACL, at points
34851 where you accept mail from relay sources (internal hosts or authenticated
34852 senders).
34853
34854
34855 .section "Signing outgoing messages" "SECID513"
34856 .cindex "DKIM" "signing"
34857
34858 Signing is implemented by setting private options on the SMTP transport.
34859 These options take (expandable) strings as arguments.
34860
34861 .option dkim_domain smtp string&!! unset
34862 MANDATORY:
34863 The domain you want to sign with. The result of this expanded
34864 option is put into the &%$dkim_domain%& expansion variable.
34865
34866 .option dkim_selector smtp string&!! unset
34867 MANDATORY:
34868 This sets the key selector string. You can use the &%$dkim_domain%& expansion
34869 variable to look up a matching selector. The result is put in the expansion
34870 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
34871 option along with &%$dkim_domain%&.
34872
34873 .option dkim_private_key smtp string&!! unset
34874 MANDATORY:
34875 This sets the private key to use. You can use the &%$dkim_domain%& and
34876 &%$dkim_selector%& expansion variables to determine the private key to use.
34877 The result can either
34878 .ilist
34879 be a valid RSA private key in ASCII armor, including line breaks.
34880 .next
34881 start with a slash, in which case it is treated as a file that contains
34882 the private key.
34883 .next
34884 be "0", "false" or the empty string, in which case the message will not
34885 be signed. This case will not result in an error, even if &%dkim_strict%&
34886 is set.
34887 .endlist
34888
34889 .option dkim_canon smtp string&!! unset
34890 OPTIONAL:
34891 This option sets the canonicalization method used when signing a message.
34892 The DKIM RFC currently supports two methods: "simple" and "relaxed".
34893 The option defaults to "relaxed" when unset. Note: the current implementation
34894 only supports using the same canonicalization method for both headers and body.
34895
34896 .option dkim_strict smtp string&!! unset
34897 OPTIONAL:
34898 This  option  defines  how  Exim  behaves  when  signing a message that
34899 should be signed fails for some reason.  When the expansion evaluates to
34900 either "1" or "true", Exim will defer. Otherwise Exim will send the message
34901 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
34902 variables here.
34903
34904 .option dkim_sign_headers smtp string&!! unset
34905 OPTIONAL:
34906 When set, this option must expand to (or be specified as) a colon-separated
34907 list of header names. Headers with these names will be included in the message
34908 signature. When unspecified, the header names recommended in RFC4871 will be
34909 used.
34910
34911
34912 .section "Verifying DKIM signatures in incoming mail" "SECID514"
34913 .cindex "DKIM" "verification"
34914
34915 Verification of DKIM signatures in incoming email is implemented via the
34916 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
34917 syntactically(!) correct signature in the incoming message.
34918
34919 To evaluate the signature in the ACL a large number of expansion variables
34920 containing the signature status and its details are set up during the
34921 runtime of the ACL.
34922
34923 Calling the ACL only for existing signatures is not sufficient to build
34924 more advanced policies. For that reason, the global option
34925 &%dkim_verify_signers%&, and a global expansion variable
34926 &%$dkim_signers%& exist.
34927
34928 The global option &%dkim_verify_signers%& can be set to a colon-separated
34929 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
34930 called. It is expanded when the message has been received. At this point,
34931 the expansion variable &%$dkim_signers%& already contains a colon-separated
34932 list of signer domains and identities for the message. When
34933 &%dkim_verify_signers%& is not specified in the main configuration,
34934 it defaults as:
34935 .code
34936 dkim_verify_signers = $dkim_signers
34937 .endd
34938 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
34939 DKIM signature in the message. Current DKIM verifiers may want to explicitly
34940 call the ACL for known domains or identities. This would be achieved as follows:
34941 .code
34942 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
34943 .endd
34944 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
34945 and "ebay.com", plus all domains and identities that have signatures in the message.
34946 You can also be more creative in constructing your policy. For example:
34947 .code
34948 dkim_verify_signers = $sender_address_domain:$dkim_signers
34949 .endd
34950
34951 If a domain or identity is listed several times in the (expanded) value of
34952 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
34953
34954
34955 Inside the &%acl_smtp_dkim%&, the following expansion variables are
34956 available (from most to least important):
34957
34958
34959 .vlist
34960 .vitem &%$dkim_cur_signer%&
34961 The signer that is being evaluated in this ACL run. This can be a domain or
34962 an identity. This is one of the list items from the expanded main option
34963 &%dkim_verify_signers%& (see above).
34964 .vitem &%$dkim_verify_status%&
34965 A string describing the general status of the signature. One of
34966 .ilist
34967 &%none%&: There is no signature in the message for the current domain or
34968 identity (as reflected by &%$dkim_cur_signer%&).
34969 .next
34970 &%invalid%&: The signature could not be verified due to a processing error.
34971 More detail is available in &%$dkim_verify_reason%&.
34972 .next
34973 &%fail%&: Verification of the signature failed.  More detail is
34974 available in &%$dkim_verify_reason%&.
34975 .next
34976 &%pass%&: The signature passed verification. It is valid.
34977 .endlist
34978 .vitem &%$dkim_verify_reason%&
34979 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
34980 "fail" or "invalid". One of
34981 .ilist
34982 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
34983 key for the domain could not be retrieved. This may be a temporary problem.
34984 .next
34985 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
34986 record for the domain is syntactically invalid.
34987 .next
34988 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
34989 body hash does not match the one specified in the signature header. This
34990 means that the message body was modified in transit.
34991 .next
34992 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
34993 could not be verified. This may mean that headers were modified,
34994 re-written or otherwise changed in a way which is incompatible with
34995 DKIM verification. It may of course also mean that the signature is forged.
34996 .endlist
34997 .vitem &%$dkim_domain%&
34998 The signing domain. IMPORTANT: This variable is only populated if there is
34999 an actual signature in the message for the current domain or identity (as
35000 reflected by &%$dkim_cur_signer%&).
35001 .vitem &%$dkim_identity%&
35002 The signing identity, if present. IMPORTANT: This variable is only populated
35003 if there is an actual signature in the message for the current domain or
35004 identity (as reflected by &%$dkim_cur_signer%&).
35005 .vitem &%$dkim_selector%&
35006 The key record selector string.
35007 .vitem &%$dkim_algo%&
35008 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
35009 .vitem &%$dkim_canon_body%&
35010 The body canonicalization method. One of 'relaxed' or 'simple'.
35011 .vitem &%dkim_canon_headers%&
35012 The header canonicalization method. One of 'relaxed' or 'simple'.
35013 .vitem &%$dkim_copiedheaders%&
35014 A transcript of headers and their values which are included in the signature
35015 (copied from the 'z=' tag of the signature).
35016 .vitem &%$dkim_bodylength%&
35017 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
35018 limit was set by the signer, "9999999999999" is returned. This makes sure
35019 that this variable always expands to an integer value.
35020 .vitem &%$dkim_created%&
35021 UNIX timestamp reflecting the date and time when the signature was created.
35022 When this was not specified by the signer, "0" is returned.
35023 .vitem &%$dkim_expires%&
35024 UNIX timestamp reflecting the date and time when the signer wants the
35025 signature to be treated as "expired". When this was not specified by the
35026 signer, "9999999999999" is returned. This makes it possible to do useful
35027 integer size comparisons against this value.
35028 .vitem &%$dkim_headernames%&
35029 A colon-separated list of names of headers included in the signature.
35030 .vitem &%$dkim_key_testing%&
35031 "1" if the key record has the "testing" flag set, "0" if not.
35032 .vitem &%$dkim_key_nosubdomaining%&
35033 "1" if the key record forbids subdomaining, "0" otherwise.
35034 .vitem &%$dkim_key_srvtype%&
35035 Service type (tag s=) from the key record. Defaults to "*" if not specified
35036 in the key record.
35037 .vitem &%$dkim_key_granularity%&
35038 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
35039 in the key record.
35040 .vitem &%$dkim_key_notes%&
35041 Notes from the key record (tag n=).
35042 .endlist
35043
35044 In addition, two ACL conditions are provided:
35045
35046 .vlist
35047 .vitem &%dkim_signers%&
35048 ACL condition that checks a colon-separated list of domains or identities
35049 for a match against the domain or identity that the ACL is currently verifying
35050 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
35051 verb to a group of domains or identities. For example:
35052
35053 .code
35054 # Warn when message apparently from GMail has no signature at all
35055 warn log_message = GMail sender without DKIM signature
35056      sender_domains = gmail.com
35057      dkim_signers = gmail.com
35058      dkim_status = none
35059 .endd
35060
35061 .vitem &%dkim_status%&
35062 ACL condition that checks a colon-separated list of possible DKIM verification
35063 results agains the actual result of verification. This is typically used
35064 to restrict an ACL verb to a list of verification outcomes, like:
35065
35066 .code
35067 deny message = Message from Paypal with invalid or missing signature
35068      sender_domains = paypal.com:paypal.de
35069      dkim_signers = paypal.com:paypal.de
35070      dkim_status = none:invalid:fail
35071 .endd
35072
35073 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
35074 see the documentation of the &%$dkim_verify_status%& expansion variable above
35075 for more information of what they mean.
35076 .endlist
35077
35078 . ////////////////////////////////////////////////////////////////////////////
35079 . ////////////////////////////////////////////////////////////////////////////
35080
35081 .chapter "Adding new drivers or lookup types" "CHID13" &&&
35082          "Adding drivers or lookups"
35083 .cindex "adding drivers"
35084 .cindex "new drivers, adding"
35085 .cindex "drivers" "adding new"
35086 The following actions have to be taken in order to add a new router, transport,
35087 authenticator, or lookup type to Exim:
35088
35089 .olist
35090 Choose a name for the driver or lookup type that does not conflict with any
35091 existing name; I will use &"newdriver"& in what follows.
35092 .next
35093 Add to &_src/EDITME_& the line:
35094 .display
35095 <&'type'&>&`_NEWDRIVER=yes`&
35096 .endd
35097 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
35098 code is not to be included in the binary by default, comment this line out. You
35099 should also add any relevant comments about the driver or lookup type.
35100 .next
35101 Add to &_src/config.h.defaults_& the line:
35102 .code
35103 #define <type>_NEWDRIVER
35104 .endd
35105 .next
35106 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
35107 and create a table entry as is done for all the other drivers and lookup types.
35108 .next
35109 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
35110 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
35111 driver or lookup type and add it to the definition of OBJ.
35112 .next
35113 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
35114 &_src_&.
35115 .next
35116 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
35117 as for other drivers and lookups.
35118 .endlist
35119
35120 Then all you need to do is write the code! A good way to start is to make a
35121 proforma by copying an existing module of the same type, globally changing all
35122 occurrences of the name, and cutting out most of the code. Note that any
35123 options you create must be listed in alphabetical order, because the tables are
35124 searched using a binary chop procedure.
35125
35126 There is a &_README_& file in each of the sub-directories of &_src_& describing
35127 the interface that is expected.
35128
35129
35130
35131
35132 . ////////////////////////////////////////////////////////////////////////////
35133 . ////////////////////////////////////////////////////////////////////////////
35134
35135 . /////////////////////////////////////////////////////////////////////////////
35136 . These lines are processing instructions for the Simple DocBook Processor that
35137 . Philip Hazel has developed as a less cumbersome way of making PostScript and
35138 . PDFs than using xmlto and fop. They will be ignored by all other XML
35139 . processors.
35140 . /////////////////////////////////////////////////////////////////////////////
35141
35142 .literal xml
35143 <?sdop
35144   format="newpage"
35145   foot_right_recto="&chaptertitle;"
35146   foot_right_verso="&chaptertitle;"
35147 ?>
35148 .literal off
35149
35150 .makeindex "Options index"   "option"
35151 .makeindex "Variables index" "variable"
35152 .makeindex "Concept index"   "concept"
35153
35154
35155 . /////////////////////////////////////////////////////////////////////////////
35156 . /////////////////////////////////////////////////////////////////////////////