Bug #198: Add remove_header ACL modifier.
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing. Remember that
45 . the <bookinfo> element must also be updated for each new edition.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.80"
49 .set version "4.80"
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54
55 . /////////////////////////////////////////////////////////////////////////////
56 . Additional xfpt markup used by this document, over and above the default
57 . provided in the xfpt library.
58 . /////////////////////////////////////////////////////////////////////////////
59
60 . --- Override the &$ flag to automatically insert a $ with the variable name
61
62 .flag &$  $&   "<varname>$"  "</varname>"
63
64 . --- Short flags for daggers in option headings. They will always be inside
65 . --- an italic string, but we want the daggers to be roman.
66
67 .flag &!!      "</emphasis>&dagger;<emphasis>"
68 .flag &!?      "</emphasis>&Dagger;<emphasis>"
69
70 . --- A macro for an Exim option definition heading, generating a one-line
71 . --- table with four columns. For cases when the option name is given with
72 . --- a space, so that it can be split, a fifth argument is used for the
73 . --- index entry.
74
75 .macro option
76 .arg 5
77 .oindex "&%$5%&"
78 .endarg
79 .arg -5
80 .oindex "&%$1%&"
81 .endarg
82 .itable all 0 0 4 8* left 6* center 6* center 6* right
83 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
84 .endtable
85 .endmacro
86
87 . --- A macro for the common 2-column tables. The width of the first column
88 . --- is suitable for the many tables at the start of the main options chapter;
89 . --- the small number of other 2-column tables override it.
90
91 .macro table2 196pt 254pt
92 .itable none 0 0 2 $1 left $2 left
93 .endmacro
94
95 . --- A macro that generates .row, but puts &I; at the start of the first
96 . --- argument, thus indenting it. Assume a minimum of two arguments, and
97 . --- allow up to four arguments, which is as many as we'll ever need.
98
99 .macro irow
100 .arg 4
101 .row "&I;$1" "$2" "$3" "$4"
102 .endarg
103 .arg -4
104 .arg 3
105 .row "&I;$1" "$2" "$3"
106 .endarg
107 .arg -3
108 .row "&I;$1" "$2"
109 .endarg
110 .endarg
111 .endmacro
112
113 . --- Macros for option, variable, and concept index entries. For a "range"
114 . --- style of entry, use .scindex for the start and .ecindex for the end. The
115 . --- first argument of .scindex and the only argument of .ecindex must be the
116 . --- ID that ties them together.
117
118 .macro cindex
119 &<indexterm role="concept">&
120 &<primary>&$1&</primary>&
121 .arg 2
122 &<secondary>&$2&</secondary>&
123 .endarg
124 &</indexterm>&
125 .endmacro
126
127 .macro scindex
128 &<indexterm role="concept" id="$1" class="startofrange">&
129 &<primary>&$2&</primary>&
130 .arg 3
131 &<secondary>&$3&</secondary>&
132 .endarg
133 &</indexterm>&
134 .endmacro
135
136 .macro ecindex
137 &<indexterm role="concept" startref="$1" class="endofrange"/>&
138 .endmacro
139
140 .macro oindex
141 &<indexterm role="option">&
142 &<primary>&$1&</primary>&
143 .arg 2
144 &<secondary>&$2&</secondary>&
145 .endarg
146 &</indexterm>&
147 .endmacro
148
149 .macro vindex
150 &<indexterm role="variable">&
151 &<primary>&$1&</primary>&
152 .arg 2
153 &<secondary>&$2&</secondary>&
154 .endarg
155 &</indexterm>&
156 .endmacro
157
158 .macro index
159 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
160 .endmacro
161 . ////////////////////////////////////////////////////////////////////////////
162
163
164 . ////////////////////////////////////////////////////////////////////////////
165 . The <bookinfo> element is removed from the XML before processing for Ascii
166 . output formats.
167 . ////////////////////////////////////////////////////////////////////////////
168
169 .literal xml
170 <bookinfo>
171 <title>Specification of the Exim Mail Transfer Agent</title>
172 <titleabbrev>The Exim MTA</titleabbrev>
173 <date>17 May 2012</date>
174 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
175 <authorinitials>EM</authorinitials>
176 <revhistory><revision>
177   <revnumber>4.80</revnumber>
178   <date>17 May 2012</date>
179   <authorinitials>EM</authorinitials>
180 </revision></revhistory>
181 <copyright><year>2012</year><holder>University of Cambridge</holder></copyright>
182 </bookinfo>
183 .literal off
184
185
186 . /////////////////////////////////////////////////////////////////////////////
187 . This chunk of literal XML implements index entries of the form "x, see y" and
188 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
189 . at the top level, so we have to put the .chapter directive first.
190 . /////////////////////////////////////////////////////////////////////////////
191
192 .chapter "Introduction" "CHID1"
193 .literal xml
194
195 <indexterm role="variable">
196   <primary>$1, $2, etc.</primary>
197   <see><emphasis>numerical variables</emphasis></see>
198 </indexterm>
199 <indexterm role="concept">
200   <primary>address</primary>
201   <secondary>rewriting</secondary>
202   <see><emphasis>rewriting</emphasis></see>
203 </indexterm>
204 <indexterm role="concept">
205   <primary>Bounce Address Tag Validation</primary>
206   <see><emphasis>BATV</emphasis></see>
207 </indexterm>
208 <indexterm role="concept">
209   <primary>Client SMTP Authorization</primary>
210   <see><emphasis>CSA</emphasis></see>
211 </indexterm>
212 <indexterm role="concept">
213   <primary>CR character</primary>
214   <see><emphasis>carriage return</emphasis></see>
215 </indexterm>
216 <indexterm role="concept">
217   <primary>CRL</primary>
218   <see><emphasis>certificate revocation list</emphasis></see>
219 </indexterm>
220 <indexterm role="concept">
221   <primary>delivery</primary>
222   <secondary>failure report</secondary>
223   <see><emphasis>bounce message</emphasis></see>
224 </indexterm>
225 <indexterm role="concept">
226   <primary>dialup</primary>
227   <see><emphasis>intermittently connected hosts</emphasis></see>
228 </indexterm>
229 <indexterm role="concept">
230   <primary>exiscan</primary>
231   <see><emphasis>content scanning</emphasis></see>
232 </indexterm>
233 <indexterm role="concept">
234   <primary>failover</primary>
235   <see><emphasis>fallback</emphasis></see>
236 </indexterm>
237 <indexterm role="concept">
238   <primary>fallover</primary>
239   <see><emphasis>fallback</emphasis></see>
240 </indexterm>
241 <indexterm role="concept">
242   <primary>filter</primary>
243   <secondary>Sieve</secondary>
244   <see><emphasis>Sieve filter</emphasis></see>
245 </indexterm>
246 <indexterm role="concept">
247   <primary>ident</primary>
248   <see><emphasis>RFC 1413</emphasis></see>
249 </indexterm>
250 <indexterm role="concept">
251   <primary>LF character</primary>
252   <see><emphasis>linefeed</emphasis></see>
253 </indexterm>
254 <indexterm role="concept">
255   <primary>maximum</primary>
256   <seealso><emphasis>limit</emphasis></seealso>
257 </indexterm>
258 <indexterm role="concept">
259   <primary>monitor</primary>
260   <see><emphasis>Exim monitor</emphasis></see>
261 </indexterm>
262 <indexterm role="concept">
263   <primary>no_<emphasis>xxx</emphasis></primary>
264   <see>entry for xxx</see>
265 </indexterm>
266 <indexterm role="concept">
267   <primary>NUL</primary>
268   <see><emphasis>binary zero</emphasis></see>
269 </indexterm>
270 <indexterm role="concept">
271   <primary>passwd file</primary>
272   <see><emphasis>/etc/passwd</emphasis></see>
273 </indexterm>
274 <indexterm role="concept">
275   <primary>process id</primary>
276   <see><emphasis>pid</emphasis></see>
277 </indexterm>
278 <indexterm role="concept">
279   <primary>RBL</primary>
280   <see><emphasis>DNS list</emphasis></see>
281 </indexterm>
282 <indexterm role="concept">
283   <primary>redirection</primary>
284   <see><emphasis>address redirection</emphasis></see>
285 </indexterm>
286 <indexterm role="concept">
287   <primary>return path</primary>
288   <seealso><emphasis>envelope sender</emphasis></seealso>
289 </indexterm>
290 <indexterm role="concept">
291   <primary>scanning</primary>
292   <see><emphasis>content scanning</emphasis></see>
293 </indexterm>
294 <indexterm role="concept">
295   <primary>SSL</primary>
296   <see><emphasis>TLS</emphasis></see>
297 </indexterm>
298 <indexterm role="concept">
299   <primary>string</primary>
300   <secondary>expansion</secondary>
301   <see><emphasis>expansion</emphasis></see>
302 </indexterm>
303 <indexterm role="concept">
304   <primary>top bit</primary>
305   <see><emphasis>8-bit characters</emphasis></see>
306 </indexterm>
307 <indexterm role="concept">
308   <primary>variables</primary>
309   <see><emphasis>expansion, variables</emphasis></see>
310 </indexterm>
311 <indexterm role="concept">
312   <primary>zero, binary</primary>
313   <see><emphasis>binary zero</emphasis></see>
314 </indexterm>
315
316 .literal off
317
318
319 . /////////////////////////////////////////////////////////////////////////////
320 . This is the real start of the first chapter. See the comment above as to why
321 . we can't have the .chapter line here.
322 . chapter "Introduction"
323 . /////////////////////////////////////////////////////////////////////////////
324
325 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
326 Unix-like operating systems. It was designed on the assumption that it would be
327 run on hosts that are permanently connected to the Internet. However, it can be
328 used on intermittently connected hosts with suitable configuration adjustments.
329
330 Configuration files currently exist for the following operating systems: AIX,
331 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
332 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
333 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
334 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
335 Some of these operating systems are no longer current and cannot easily be
336 tested, so the configuration files may no longer work in practice.
337
338 There are also configuration files for compiling Exim in the Cygwin environment
339 that can be installed on systems running Windows. However, this document does
340 not contain any information about running Exim in the Cygwin environment.
341
342 The terms and conditions for the use and distribution of Exim are contained in
343 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
344 Public Licence, a copy of which may be found in the file &_LICENCE_&.
345
346 The use, supply or promotion of Exim for the purpose of sending bulk,
347 unsolicited electronic mail is incompatible with the basic aims of the program,
348 which revolve around the free provision of a service that enhances the quality
349 of personal communications. The author of Exim regards indiscriminate
350 mass-mailing as an antisocial, irresponsible abuse of the Internet.
351
352 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
353 experience of running and working on the Smail 3 code, I could never have
354 contemplated starting to write a new MTA. Many of the ideas and user interfaces
355 were originally taken from Smail 3, though the actual code of Exim is entirely
356 new, and has developed far beyond the initial concept.
357
358 Many people, both in Cambridge and around the world, have contributed to the
359 development and the testing of Exim, and to porting it to various operating
360 systems. I am grateful to them all. The distribution now contains a file called
361 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
362 contributors.
363
364
365 .section "Exim documentation" "SECID1"
366 . Keep this example change bar when updating the documentation!
367
368 .new
369 .cindex "documentation"
370 This edition of the Exim specification applies to version &version; of Exim.
371 Substantive changes from the &previousversion; edition are marked in some
372 renditions of the document; this paragraph is so marked if the rendition is
373 capable of showing a change indicator.
374 .wen
375
376 This document is very much a reference manual; it is not a tutorial. The reader
377 is expected to have some familiarity with the SMTP mail transfer protocol and
378 with general Unix system administration. Although there are some discussions
379 and examples in places, the information is mostly organized in a way that makes
380 it easy to look up, rather than in a natural order for sequential reading.
381 Furthermore, the manual aims to cover every aspect of Exim in detail, including
382 a number of rarely-used, special-purpose features that are unlikely to be of
383 very wide interest.
384
385 .cindex "books about Exim"
386 An &"easier"& discussion of Exim which provides more in-depth explanatory,
387 introductory, and tutorial material can be found in a book entitled &'The Exim
388 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
389 (&url(http://www.uit.co.uk/exim-book/)).
390
391 This book also contains a chapter that gives a general introduction to SMTP and
392 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
393 with the latest release of Exim. (Note that the earlier book about Exim,
394 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
395
396 .cindex "Debian" "information sources"
397 If you are using a Debian distribution of Exim, you will find information about
398 Debian-specific features in the file
399 &_/usr/share/doc/exim4-base/README.Debian_&.
400 The command &(man update-exim.conf)& is another source of Debian-specific
401 information.
402
403 .cindex "&_doc/NewStuff_&"
404 .cindex "&_doc/ChangeLog_&"
405 .cindex "change log"
406 As the program develops, there may be features in newer versions that have not
407 yet made it into this document, which is updated only when the most significant
408 digit of the fractional part of the version number changes. Specifications of
409 new features that are not yet in this manual are placed in the file
410 &_doc/NewStuff_& in the Exim distribution.
411
412 Some features may be classified as &"experimental"&. These may change
413 incompatibly while they are developing, or even be withdrawn. For this reason,
414 they are not documented in this manual. Information about experimental features
415 can be found in the file &_doc/experimental.txt_&.
416
417 All changes to the program (whether new features, bug fixes, or other kinds of
418 change) are noted briefly in the file called &_doc/ChangeLog_&.
419
420 .cindex "&_doc/spec.txt_&"
421 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
422 that it can easily be searched with a text editor. Other files in the &_doc_&
423 directory are:
424
425 .table2 100pt
426 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
427 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
428 .row &_exim.8_&              "a man page of Exim's command line options"
429 .row &_experimental.txt_&    "documentation of experimental features"
430 .row &_filter.txt_&          "specification of the filter language"
431 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
432 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
433 .endtable
434
435 The main specification and the specification of the filtering language are also
436 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
437 &<<SECTavail>>& below tells you how to get hold of these.
438
439
440
441 .section "FTP and web sites" "SECID2"
442 .cindex "web site"
443 .cindex "FTP site"
444 The primary site for Exim source distributions is currently the University of
445 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
446 distribution'& below. In addition, there is a web site and an FTP site at
447 &%exim.org%&. These are now also hosted at the University of Cambridge. The
448 &%exim.org%& site was previously hosted for a number of years by Energis
449 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
450
451 .cindex "wiki"
452 .cindex "FAQ"
453 As well as Exim distribution tar files, the Exim web site contains a number of
454 differently formatted versions of the documentation. A recent addition to the
455 online information is the Exim wiki (&url(http://wiki.exim.org)),
456 which contains what used to be a separate FAQ, as well as various other
457 examples, tips, and know-how that have been contributed by Exim users.
458
459 .cindex Bugzilla
460 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
461 this to report bugs, and also to add items to the wish list. Please search
462 first to check that you are not duplicating a previous entry.
463
464
465
466 .section "Mailing lists" "SECID3"
467 .cindex "mailing lists" "for Exim users"
468 The following Exim mailing lists exist:
469
470 .table2 140pt
471 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
472 .row &'exim-users@exim.org'&      "General discussion list"
473 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
474 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
475 .endtable
476
477 You can subscribe to these lists, change your existing subscriptions, and view
478 or search the archives via the mailing lists link on the Exim home page.
479 .cindex "Debian" "mailing list for"
480 If you are using a Debian distribution of Exim, you may wish to subscribe to
481 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
482 via this web page:
483 .display
484 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
485 .endd
486 Please ask Debian-specific questions on this list and not on the general Exim
487 lists.
488
489 .section "Exim training" "SECID4"
490 .cindex "training courses"
491 Training courses in Cambridge (UK) used to be run annually by the author of
492 Exim, before he retired. At the time of writing, there are no plans to run
493 further Exim courses in Cambridge. However, if that changes, relevant
494 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
495
496 .section "Bug reports" "SECID5"
497 .cindex "bug reports"
498 .cindex "reporting bugs"
499 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
500 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
501 whether some behaviour is a bug or not, the best thing to do is to post a
502 message to the &'exim-dev'& mailing list and have it discussed.
503
504
505
506 .section "Where to find the Exim distribution" "SECTavail"
507 .cindex "FTP site"
508 .cindex "distribution" "ftp site"
509 The master ftp site for the Exim distribution is
510 .display
511 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
512 .endd
513 This is mirrored by
514 .display
515 &*ftp://ftp.exim.org/pub/exim*&
516 .endd
517 The file references that follow are relative to the &_exim_& directories at
518 these sites. There are now quite a number of independent mirror sites around
519 the world. Those that I know about are listed in the file called &_Mirrors_&.
520
521 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
522 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
523 distributions), and &_Testing_& for testing versions. In the &_exim4_&
524 subdirectory, the current release can always be found in files called
525 .display
526 &_exim-n.nn.tar.gz_&
527 &_exim-n.nn.tar.bz2_&
528 .endd
529 where &'n.nn'& is the highest such version number in the directory. The two
530 files contain identical data; the only difference is the type of compression.
531 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
532
533 .cindex "distribution" "signing details"
534 .cindex "distribution" "public key"
535 .cindex "public key for signed distribution"
536 The distributions are currently signed with Nigel Metheringham's GPG key. The
537 corresponding public key is available from a number of keyservers, and there is
538 also a copy in the file &_nigel-pubkey.asc_&. The signatures for the tar bundles are
539 in:
540 .display
541 &_exim-n.nn.tar.gz.asc_&
542 &_exim-n.nn.tar.bz2.asc_&
543 .endd
544 For each released version, the log of changes is made separately available in a
545 separate file in the directory &_ChangeLogs_& so that it is possible to
546 find out what has changed without having to download the entire distribution.
547
548 .cindex "documentation" "available formats"
549 The main distribution contains ASCII versions of this specification and other
550 documentation; other formats of the documents are available in separate files
551 inside the &_exim4_& directory of the FTP site:
552 .display
553 &_exim-html-n.nn.tar.gz_&
554 &_exim-pdf-n.nn.tar.gz_&
555 &_exim-postscript-n.nn.tar.gz_&
556 &_exim-texinfo-n.nn.tar.gz_&
557 .endd
558 These tar files contain only the &_doc_& directory, not the complete
559 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
560
561
562 .section "Limitations" "SECID6"
563 .ilist
564 .cindex "limitations of Exim"
565 .cindex "bang paths" "not handled by Exim"
566 Exim is designed for use as an Internet MTA, and therefore handles addresses in
567 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
568 simple two-component bang paths can be converted by a straightforward rewriting
569 configuration. This restriction does not prevent Exim from being interfaced to
570 UUCP as a transport mechanism, provided that domain addresses are used.
571 .next
572 .cindex "domainless addresses"
573 .cindex "address" "without domain"
574 Exim insists that every address it handles has a domain attached. For incoming
575 local messages, domainless addresses are automatically qualified with a
576 configured domain value. Configuration options specify from which remote
577 systems unqualified addresses are acceptable. These are then qualified on
578 arrival.
579 .next
580 .cindex "transport" "external"
581 .cindex "external transports"
582 The only external transport mechanisms that are currently implemented are SMTP
583 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
584 transport is available, and there are facilities for writing messages to files
585 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
586 to send messages to other transport mechanisms such as UUCP, provided they can
587 handle domain-style addresses. Batched SMTP input is also catered for.
588 .next
589 Exim is not designed for storing mail for dial-in hosts. When the volumes of
590 such mail are large, it is better to get the messages &"delivered"& into files
591 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
592 other means.
593 .next
594 Although Exim does have basic facilities for scanning incoming messages, these
595 are not comprehensive enough to do full virus or spam scanning. Such operations
596 are best carried out using additional specialized software packages. If you
597 compile Exim with the content-scanning extension, straightforward interfaces to
598 a number of common scanners are provided.
599 .endlist
600
601
602 .section "Run time configuration" "SECID7"
603 Exim's run time configuration is held in a single text file that is divided
604 into a number of sections. The entries in this file consist of keywords and
605 values, in the style of Smail 3 configuration files. A default configuration
606 file which is suitable for simple online installations is provided in the
607 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
608
609
610 .section "Calling interface" "SECID8"
611 .cindex "Sendmail compatibility" "command line interface"
612 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
613 can be a straight replacement for &_/usr/lib/sendmail_& or
614 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
615 about Sendmail in order to run Exim. For actions other than sending messages,
616 Sendmail-compatible options also exist, but those that produce output (for
617 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
618 format. There are also some additional options that are compatible with Smail
619 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
620 documents all Exim's command line options. This information is automatically
621 made into the man page that forms part of the Exim distribution.
622
623 Control of messages on the queue can be done via certain privileged command
624 line options. There is also an optional monitor program called &'eximon'&,
625 which displays current information in an X window, and which contains a menu
626 interface to Exim's command line administration options.
627
628
629
630 .section "Terminology" "SECID9"
631 .cindex "terminology definitions"
632 .cindex "body of message" "definition of"
633 The &'body'& of a message is the actual data that the sender wants to transmit.
634 It is the last part of a message, and is separated from the &'header'& (see
635 below) by a blank line.
636
637 .cindex "bounce message" "definition of"
638 When a message cannot be delivered, it is normally returned to the sender in a
639 delivery failure message or a &"non-delivery report"& (NDR). The term
640 &'bounce'& is commonly used for this action, and the error reports are often
641 called &'bounce messages'&. This is a convenient shorthand for &"delivery
642 failure error report"&. Such messages have an empty sender address in the
643 message's &'envelope'& (see below) to ensure that they cannot themselves give
644 rise to further bounce messages.
645
646 The term &'default'& appears frequently in this manual. It is used to qualify a
647 value which is used in the absence of any setting in the configuration. It may
648 also qualify an action which is taken unless a configuration setting specifies
649 otherwise.
650
651 The term &'defer'& is used when the delivery of a message to a specific
652 destination cannot immediately take place for some reason (a remote host may be
653 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
654 until a later time.
655
656 The word &'domain'& is sometimes used to mean all but the first component of a
657 host's name. It is &'not'& used in that sense here, where it normally refers to
658 the part of an email address following the @ sign.
659
660 .cindex "envelope, definition of"
661 .cindex "sender" "definition of"
662 A message in transit has an associated &'envelope'&, as well as a header and a
663 body. The envelope contains a sender address (to which bounce messages should
664 be delivered), and any number of recipient addresses. References to the
665 sender or the recipients of a message usually mean the addresses in the
666 envelope. An MTA uses these addresses for delivery, and for returning bounce
667 messages, not the addresses that appear in the header lines.
668
669 .cindex "message" "header, definition of"
670 .cindex "header section" "definition of"
671 The &'header'& of a message is the first part of a message's text, consisting
672 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
673 &'Subject:'&, etc. Long header lines can be split over several text lines by
674 indenting the continuations. The header is separated from the body by a blank
675 line.
676
677 .cindex "local part" "definition of"
678 .cindex "domain" "definition of"
679 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
680 part of an email address that precedes the @ sign. The part that follows the
681 @ sign is called the &'domain'& or &'mail domain'&.
682
683 .cindex "local delivery" "definition of"
684 .cindex "remote delivery, definition of"
685 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
686 delivery to a file or a pipe on the local host from delivery by SMTP over
687 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
688 host it is running on are &'remote'&.
689
690 .cindex "return path" "definition of"
691 &'Return path'& is another name that is used for the sender address in a
692 message's envelope.
693
694 .cindex "queue" "definition of"
695 The term &'queue'& is used to refer to the set of messages awaiting delivery,
696 because this term is in widespread use in the context of MTAs. However, in
697 Exim's case the reality is more like a pool than a queue, because there is
698 normally no ordering of waiting messages.
699
700 .cindex "queue runner" "definition of"
701 The term &'queue runner'& is used to describe a process that scans the queue
702 and attempts to deliver those messages whose retry times have come. This term
703 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
704 the waiting messages are normally processed in an unpredictable order.
705
706 .cindex "spool directory" "definition of"
707 The term &'spool directory'& is used for a directory in which Exim keeps the
708 messages on its queue &-- that is, those that it is in the process of
709 delivering. This should not be confused with the directory in which local
710 mailboxes are stored, which is called a &"spool directory"& by some people. In
711 the Exim documentation, &"spool"& is always used in the first sense.
712
713
714
715
716
717
718 . ////////////////////////////////////////////////////////////////////////////
719 . ////////////////////////////////////////////////////////////////////////////
720
721 .chapter "Incorporated code" "CHID2"
722 .cindex "incorporated code"
723 .cindex "regular expressions" "library"
724 .cindex "PCRE"
725 A number of pieces of external code are included in the Exim distribution.
726
727 .ilist
728 Regular expressions are supported in the main Exim program and in the
729 Exim monitor using the freely-distributable PCRE library, copyright
730 &copy; University of Cambridge. The source to PCRE is no longer shipped with
731 Exim, so you will need to use the version of PCRE shipped with your system,
732 or obtain and install the full version of the library from
733 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
734 .next
735 .cindex "cdb" "acknowledgment"
736 Support for the cdb (Constant DataBase) lookup method is provided by code
737 contributed by Nigel Metheringham of (at the time he contributed it) Planet
738 Online Ltd. The implementation is completely contained within the code of Exim.
739 It does not link against an external cdb library. The code contains the
740 following statements:
741
742 .blockquote
743 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
744
745 This program is free software; you can redistribute it and/or modify it under
746 the terms of the GNU General Public License as published by the Free Software
747 Foundation; either version 2 of the License, or (at your option) any later
748 version.
749 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
750 the spec and sample code for cdb can be obtained from
751 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
752 some code from Dan Bernstein's implementation (which has no license
753 restrictions applied to it).
754 .endblockquote
755 .next
756 .cindex "SPA authentication"
757 .cindex "Samba project"
758 .cindex "Microsoft Secure Password Authentication"
759 Client support for Microsoft's &'Secure Password Authentication'& is provided
760 by code contributed by Marc Prud'hommeaux. Server support was contributed by
761 Tom Kistner. This includes code taken from the Samba project, which is released
762 under the Gnu GPL.
763 .next
764 .cindex "Cyrus"
765 .cindex "&'pwcheck'& daemon"
766 .cindex "&'pwauthd'& daemon"
767 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
768 by code taken from the Cyrus-SASL library and adapted by Alexander S.
769 Sabourenkov. The permission notice appears below, in accordance with the
770 conditions expressed therein.
771
772 .blockquote
773 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
774
775 Redistribution and use in source and binary forms, with or without
776 modification, are permitted provided that the following conditions
777 are met:
778
779 .olist
780 Redistributions of source code must retain the above copyright
781 notice, this list of conditions and the following disclaimer.
782 .next
783 Redistributions in binary form must reproduce the above copyright
784 notice, this list of conditions and the following disclaimer in
785 the documentation and/or other materials provided with the
786 distribution.
787 .next
788 The name &"Carnegie Mellon University"& must not be used to
789 endorse or promote products derived from this software without
790 prior written permission. For permission or any other legal
791 details, please contact
792 .display
793               Office of Technology Transfer
794               Carnegie Mellon University
795               5000 Forbes Avenue
796               Pittsburgh, PA  15213-3890
797               (412) 268-4387, fax: (412) 268-7395
798               tech-transfer@andrew.cmu.edu
799 .endd
800 .next
801 Redistributions of any form whatsoever must retain the following
802 acknowledgment:
803
804 &"This product includes software developed by Computing Services
805 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
806
807 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
808 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
809 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
810 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
811 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
812 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
813 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
814 .endlist
815 .endblockquote
816
817 .next
818 .cindex "Exim monitor" "acknowledgment"
819 .cindex "X-windows"
820 .cindex "Athena"
821 The Exim Monitor program, which is an X-Window application, includes
822 modified versions of the Athena StripChart and TextPop widgets.
823 This code is copyright by DEC and MIT, and their permission notice appears
824 below, in accordance with the conditions expressed therein.
825
826 .blockquote
827 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
828 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
829
830 All Rights Reserved
831
832 Permission to use, copy, modify, and distribute this software and its
833 documentation for any purpose and without fee is hereby granted,
834 provided that the above copyright notice appear in all copies and that
835 both that copyright notice and this permission notice appear in
836 supporting documentation, and that the names of Digital or MIT not be
837 used in advertising or publicity pertaining to distribution of the
838 software without specific, written prior permission.
839
840 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
841 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
842 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
843 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
844 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
845 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
846 SOFTWARE.
847 .endblockquote
848
849 .next
850 Many people have contributed code fragments, some large, some small, that were
851 not covered by any specific licence requirements. It is assumed that the
852 contributors are happy to see their code incorporated into Exim under the GPL.
853 .endlist
854
855
856
857
858
859 . ////////////////////////////////////////////////////////////////////////////
860 . ////////////////////////////////////////////////////////////////////////////
861
862 .chapter "How Exim receives and delivers mail" "CHID11" &&&
863          "Receiving and delivering mail"
864
865
866 .section "Overall philosophy" "SECID10"
867 .cindex "design philosophy"
868 Exim is designed to work efficiently on systems that are permanently connected
869 to the Internet and are handling a general mix of mail. In such circumstances,
870 most messages can be delivered immediately. Consequently, Exim does not
871 maintain independent queues of messages for specific domains or hosts, though
872 it does try to send several messages in a single SMTP connection after a host
873 has been down, and it also maintains per-host retry information.
874
875
876 .section "Policy control" "SECID11"
877 .cindex "policy control" "overview"
878 Policy controls are now an important feature of MTAs that are connected to the
879 Internet. Perhaps their most important job is to stop MTAs being abused as
880 &"open relays"& by misguided individuals who send out vast amounts of
881 unsolicited junk, and want to disguise its source. Exim provides flexible
882 facilities for specifying policy controls on incoming mail:
883
884 .ilist
885 .cindex "&ACL;" "introduction"
886 Exim 4 (unlike previous versions of Exim) implements policy controls on
887 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
888 series of statements that may either grant or deny access. ACLs can be used at
889 several places in the SMTP dialogue while receiving a message from a remote
890 host. However, the most common places are after each RCPT command, and at the
891 very end of the message. The sysadmin can specify conditions for accepting or
892 rejecting individual recipients or the entire message, respectively, at these
893 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
894 error code.
895 .next
896 An ACL is also available for locally generated, non-SMTP messages. In this
897 case, the only available actions are to accept or deny the entire message.
898 .next
899 When Exim is compiled with the content-scanning extension, facilities are
900 provided in the ACL mechanism for passing the message to external virus and/or
901 spam scanning software. The result of such a scan is passed back to the ACL,
902 which can then use it to decide what to do with the message.
903 .next
904 When a message has been received, either from a remote host or from the local
905 host, but before the final acknowledgment has been sent, a locally supplied C
906 function called &[local_scan()]& can be run to inspect the message and decide
907 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
908 is accepted, the list of recipients can be modified by the function.
909 .next
910 Using the &[local_scan()]& mechanism is another way of calling external scanner
911 software. The &%SA-Exim%& add-on package works this way. It does not require
912 Exim to be compiled with the content-scanning extension.
913 .next
914 After a message has been accepted, a further checking mechanism is available in
915 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
916 runs at the start of every delivery process.
917 .endlist
918
919
920
921 .section "User filters" "SECID12"
922 .cindex "filter" "introduction"
923 .cindex "Sieve filter"
924 In a conventional Exim configuration, users are able to run private filters by
925 setting up appropriate &_.forward_& files in their home directories. See
926 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
927 configuration needed to support this, and the separate document entitled
928 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
929 of filtering are available:
930
931 .ilist
932 Sieve filters are written in the standard filtering language that is defined
933 by RFC 3028.
934 .next
935 Exim filters are written in a syntax that is unique to Exim, but which is more
936 powerful than Sieve, which it pre-dates.
937 .endlist
938
939 User filters are run as part of the routing process, described below.
940
941
942
943 .section "Message identification" "SECTmessiden"
944 .cindex "message ids" "details of format"
945 .cindex "format" "of message id"
946 .cindex "id of message"
947 .cindex "base62"
948 .cindex "base36"
949 .cindex "Darwin"
950 .cindex "Cygwin"
951 Every message handled by Exim is given a &'message id'& which is sixteen
952 characters long. It is divided into three parts, separated by hyphens, for
953 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
954 normally encoding numbers in base 62. However, in the Darwin operating
955 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
956 (avoiding the use of lower case letters) is used instead, because the message
957 id is used to construct file names, and the names of files in those systems are
958 not always case-sensitive.
959
960 .cindex "pid (process id)" "re-use of"
961 The detail of the contents of the message id have changed as Exim has evolved.
962 Earlier versions relied on the operating system not re-using a process id (pid)
963 within one second. On modern operating systems, this assumption can no longer
964 be made, so the algorithm had to be changed. To retain backward compatibility,
965 the format of the message id was retained, which is why the following rules are
966 somewhat eccentric:
967
968 .ilist
969 The first six characters of the message id are the time at which the message
970 started to be received, to a granularity of one second. That is, this field
971 contains the number of seconds since the start of the epoch (the normal Unix
972 way of representing the date and time of day).
973 .next
974 After the first hyphen, the next six characters are the id of the process that
975 received the message.
976 .next
977 There are two different possibilities for the final two characters:
978 .olist
979 .oindex "&%localhost_number%&"
980 If &%localhost_number%& is not set, this value is the fractional part of the
981 time of reception, normally in units of 1/2000 of a second, but for systems
982 that must use base 36 instead of base 62 (because of case-insensitive file
983 systems), the units are 1/1000 of a second.
984 .next
985 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
986 the fractional part of the time, which in this case is in units of 1/200
987 (1/100) of a second.
988 .endlist
989 .endlist
990
991 After a message has been received, Exim waits for the clock to tick at the
992 appropriate resolution before proceeding, so that if another message is
993 received by the same process, or by another process with the same (re-used)
994 pid, it is guaranteed that the time will be different. In most cases, the clock
995 will already have ticked while the message was being received.
996
997
998 .section "Receiving mail" "SECID13"
999 .cindex "receiving mail"
1000 .cindex "message" "reception"
1001 The only way Exim can receive mail from another host is using SMTP over
1002 TCP/IP, in which case the sender and recipient addresses are transferred using
1003 SMTP commands. However, from a locally running process (such as a user's MUA),
1004 there are several possibilities:
1005
1006 .ilist
1007 If the process runs Exim with the &%-bm%& option, the message is read
1008 non-interactively (usually via a pipe), with the recipients taken from the
1009 command line, or from the body of the message if &%-t%& is also used.
1010 .next
1011 If the process runs Exim with the &%-bS%& option, the message is also read
1012 non-interactively, but in this case the recipients are listed at the start of
1013 the message in a series of SMTP RCPT commands, terminated by a DATA
1014 command. This is so-called &"batch SMTP"& format,
1015 but it isn't really SMTP. The SMTP commands are just another way of passing
1016 envelope addresses in a non-interactive submission.
1017 .next
1018 If the process runs Exim with the &%-bs%& option, the message is read
1019 interactively, using the SMTP protocol. A two-way pipe is normally used for
1020 passing data between the local process and the Exim process.
1021 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1022 example, the ACLs for SMTP commands are used for this form of submission.
1023 .next
1024 A local process may also make a TCP/IP call to the host's loopback address
1025 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1026 does not treat the loopback address specially. It treats all such connections
1027 in the same way as connections from other hosts.
1028 .endlist
1029
1030
1031 .cindex "message sender, constructed by Exim"
1032 .cindex "sender" "constructed by Exim"
1033 In the three cases that do not involve TCP/IP, the sender address is
1034 constructed from the login name of the user that called Exim and a default
1035 qualification domain (which can be set by the &%qualify_domain%& configuration
1036 option). For local or batch SMTP, a sender address that is passed using the
1037 SMTP MAIL command is ignored. However, the system administrator may allow
1038 certain users (&"trusted users"&) to specify a different sender address
1039 unconditionally, or all users to specify certain forms of different sender
1040 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1041 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1042 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1043 users to change sender addresses.
1044
1045 Messages received by either of the non-interactive mechanisms are subject to
1046 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1047 (either over TCP/IP, or interacting with a local process) can be checked by a
1048 number of ACLs that operate at different times during the SMTP session. Either
1049 individual recipients, or the entire message, can be rejected if local policy
1050 requirements are not met. The &[local_scan()]& function (see chapter
1051 &<<CHAPlocalscan>>&) is run for all incoming messages.
1052
1053 Exim can be configured not to start a delivery process when a message is
1054 received; this can be unconditional, or depend on the number of incoming SMTP
1055 connections or the system load. In these situations, new messages wait on the
1056 queue until a queue runner process picks them up. However, in standard
1057 configurations under normal conditions, delivery is started as soon as a
1058 message is received.
1059
1060
1061
1062
1063
1064 .section "Handling an incoming message" "SECID14"
1065 .cindex "spool directory" "files that hold a message"
1066 .cindex "file" "how a message is held"
1067 When Exim accepts a message, it writes two files in its spool directory. The
1068 first contains the envelope information, the current status of the message, and
1069 the header lines, and the second contains the body of the message. The names of
1070 the two spool files consist of the message id, followed by &`-H`& for the
1071 file containing the envelope and header, and &`-D`& for the data file.
1072
1073 .cindex "spool directory" "&_input_& sub-directory"
1074 By default all these message files are held in a single directory called
1075 &_input_& inside the general Exim spool directory. Some operating systems do
1076 not perform very well if the number of files in a directory gets large; to
1077 improve performance in such cases, the &%split_spool_directory%& option can be
1078 used. This causes Exim to split up the input files into 62 sub-directories
1079 whose names are single letters or digits. When this is done, the queue is
1080 processed one sub-directory at a time instead of all at once, which can improve
1081 overall performance even when there are not enough files in each directory to
1082 affect file system performance.
1083
1084 The envelope information consists of the address of the message's sender and
1085 the addresses of the recipients. This information is entirely separate from
1086 any addresses contained in the header lines. The status of the message includes
1087 a list of recipients who have already received the message. The format of the
1088 first spool file is described in chapter &<<CHAPspool>>&.
1089
1090 .cindex "rewriting" "addresses"
1091 Address rewriting that is specified in the rewrite section of the configuration
1092 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1093 both in the header lines and the envelope, at the time the message is accepted.
1094 If during the course of delivery additional addresses are generated (for
1095 example, via aliasing), these new addresses are rewritten as soon as they are
1096 generated. At the time a message is actually delivered (transported) further
1097 rewriting can take place; because this is a transport option, it can be
1098 different for different forms of delivery. It is also possible to specify the
1099 addition or removal of certain header lines at the time the message is
1100 delivered (see chapters &<<CHAProutergeneric>>& and
1101 &<<CHAPtransportgeneric>>&).
1102
1103
1104
1105 .section "Life of a message" "SECID15"
1106 .cindex "message" "life of"
1107 .cindex "message" "frozen"
1108 A message remains in the spool directory until it is completely delivered to
1109 its recipients or to an error address, or until it is deleted by an
1110 administrator or by the user who originally created it. In cases when delivery
1111 cannot proceed &-- for example, when a message can neither be delivered to its
1112 recipients nor returned to its sender, the message is marked &"frozen"& on the
1113 spool, and no more deliveries are attempted.
1114
1115 .cindex "frozen messages" "thawing"
1116 .cindex "message" "thawing frozen"
1117 An administrator can &"thaw"& such messages when the problem has been
1118 corrected, and can also freeze individual messages by hand if necessary. In
1119 addition, an administrator can force a delivery error, causing a bounce message
1120 to be sent.
1121
1122 .oindex "&%timeout_frozen_after%&"
1123 .oindex "&%ignore_bounce_errors_after%&"
1124 There are options called &%ignore_bounce_errors_after%& and
1125 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1126 The first applies only to frozen bounces, the second to any frozen messages.
1127
1128 .cindex "message" "log file for"
1129 .cindex "log" "file for each message"
1130 While Exim is working on a message, it writes information about each delivery
1131 attempt to its main log file. This includes successful, unsuccessful, and
1132 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1133 lines are also written to a separate &'message log'& file for each message.
1134 These logs are solely for the benefit of the administrator, and are normally
1135 deleted along with the spool files when processing of a message is complete.
1136 The use of individual message logs can be disabled by setting
1137 &%no_message_logs%&; this might give an improvement in performance on very busy
1138 systems.
1139
1140 .cindex "journal file"
1141 .cindex "file" "journal"
1142 All the information Exim itself needs to set up a delivery is kept in the first
1143 spool file, along with the header lines. When a successful delivery occurs, the
1144 address is immediately written at the end of a journal file, whose name is the
1145 message id followed by &`-J`&. At the end of a delivery run, if there are some
1146 addresses left to be tried again later, the first spool file (the &`-H`& file)
1147 is updated to indicate which these are, and the journal file is then deleted.
1148 Updating the spool file is done by writing a new file and renaming it, to
1149 minimize the possibility of data loss.
1150
1151 Should the system or the program crash after a successful delivery but before
1152 the spool file has been updated, the journal is left lying around. The next
1153 time Exim attempts to deliver the message, it reads the journal file and
1154 updates the spool file before proceeding. This minimizes the chances of double
1155 deliveries caused by crashes.
1156
1157
1158
1159 .section "Processing an address for delivery" "SECTprocaddress"
1160 .cindex "drivers" "definition of"
1161 .cindex "router" "definition of"
1162 .cindex "transport" "definition of"
1163 The main delivery processing elements of Exim are called &'routers'& and
1164 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1165 number of them is provided in the source distribution, and compile-time options
1166 specify which ones are included in the binary. Run time options specify which
1167 ones are actually used for delivering messages.
1168
1169 .cindex "drivers" "instance definition"
1170 Each driver that is specified in the run time configuration is an &'instance'&
1171 of that particular driver type. Multiple instances are allowed; for example,
1172 you can set up several different &(smtp)& transports, each with different
1173 option values that might specify different ports or different timeouts. Each
1174 instance has its own identifying name. In what follows we will normally use the
1175 instance name when discussing one particular instance (that is, one specific
1176 configuration of the driver), and the generic driver name when discussing
1177 the driver's features in general.
1178
1179 A &'router'& is a driver that operates on an address, either determining how
1180 its delivery should happen, by assigning it to a specific transport, or
1181 converting the address into one or more new addresses (for example, via an
1182 alias file). A router may also explicitly choose to fail an address, causing it
1183 to be bounced.
1184
1185 A &'transport'& is a driver that transmits a copy of the message from Exim's
1186 spool to some destination. There are two kinds of transport: for a &'local'&
1187 transport, the destination is a file or a pipe on the local host, whereas for a
1188 &'remote'& transport the destination is some other host. A message is passed
1189 to a specific transport as a result of successful routing. If a message has
1190 several recipients, it may be passed to a number of different transports.
1191
1192 .cindex "preconditions" "definition of"
1193 An address is processed by passing it to each configured router instance in
1194 turn, subject to certain preconditions, until a router accepts the address or
1195 specifies that it should be bounced. We will describe this process in more
1196 detail shortly. First, as a simple example, we consider how each recipient
1197 address in a message is processed in a small configuration of three routers.
1198
1199 To make this a more concrete example, it is described in terms of some actual
1200 routers, but remember, this is only an example. You can configure Exim's
1201 routers in many different ways, and there may be any number of routers in a
1202 configuration.
1203
1204 The first router that is specified in a configuration is often one that handles
1205 addresses in domains that are not recognized specially by the local host. These
1206 are typically addresses for arbitrary domains on the Internet. A precondition
1207 is set up which looks for the special domains known to the host (for example,
1208 its own domain name), and the router is run for addresses that do &'not'&
1209 match. Typically, this is a router that looks up domains in the DNS in order to
1210 find the hosts to which this address routes. If it succeeds, the address is
1211 assigned to a suitable SMTP transport; if it does not succeed, the router is
1212 configured to fail the address.
1213
1214 The second router is reached only when the domain is recognized as one that
1215 &"belongs"& to the local host. This router does redirection &-- also known as
1216 aliasing and forwarding. When it generates one or more new addresses from the
1217 original, each of them is routed independently from the start. Otherwise, the
1218 router may cause an address to fail, or it may simply decline to handle the
1219 address, in which case the address is passed to the next router.
1220
1221 The final router in many configurations is one that checks to see if the
1222 address belongs to a local mailbox. The precondition may involve a check to
1223 see if the local part is the name of a login account, or it may look up the
1224 local part in a file or a database. If its preconditions are not met, or if
1225 the router declines, we have reached the end of the routers. When this happens,
1226 the address is bounced.
1227
1228
1229
1230 .section "Processing an address for verification" "SECID16"
1231 .cindex "router" "for verification"
1232 .cindex "verifying address" "overview"
1233 As well as being used to decide how to deliver to an address, Exim's routers
1234 are also used for &'address verification'&. Verification can be requested as
1235 one of the checks to be performed in an ACL for incoming messages, on both
1236 sender and recipient addresses, and it can be tested using the &%-bv%& and
1237 &%-bvs%& command line options.
1238
1239 When an address is being verified, the routers are run in &"verify mode"&. This
1240 does not affect the way the routers work, but it is a state that can be
1241 detected. By this means, a router can be skipped or made to behave differently
1242 when verifying. A common example is a configuration in which the first router
1243 sends all messages to a message-scanning program, unless they have been
1244 previously scanned. Thus, the first router accepts all addresses without any
1245 checking, making it useless for verifying. Normally, the &%no_verify%& option
1246 would be set for such a router, causing it to be skipped in verify mode.
1247
1248
1249
1250
1251 .section "Running an individual router" "SECTrunindrou"
1252 .cindex "router" "running details"
1253 .cindex "preconditions" "checking"
1254 .cindex "router" "result of running"
1255 As explained in the example above, a number of preconditions are checked before
1256 running a router. If any are not met, the router is skipped, and the address is
1257 passed to the next router. When all the preconditions on a router &'are'& met,
1258 the router is run. What happens next depends on the outcome, which is one of
1259 the following:
1260
1261 .ilist
1262 &'accept'&: The router accepts the address, and either assigns it to a
1263 transport, or generates one or more &"child"& addresses. Processing the
1264 original address ceases,
1265 .oindex "&%unseen%&"
1266 unless the &%unseen%& option is set on the router. This option
1267 can be used to set up multiple deliveries with different routing (for example,
1268 for keeping archive copies of messages). When &%unseen%& is set, the address is
1269 passed to the next router. Normally, however, an &'accept'& return marks the
1270 end of routing.
1271
1272 Any child addresses generated by the router are processed independently,
1273 starting with the first router by default. It is possible to change this by
1274 setting the &%redirect_router%& option to specify which router to start at for
1275 child addresses. Unlike &%pass_router%& (see below) the router specified by
1276 &%redirect_router%& may be anywhere in the router configuration.
1277 .next
1278 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1279 requests that the address be passed to another router. By default the address
1280 is passed to the next router, but this can be changed by setting the
1281 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1282 must be below the current router (to avoid loops).
1283 .next
1284 &'decline'&: The router declines to accept the address because it does not
1285 recognize it at all. By default, the address is passed to the next router, but
1286 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1287 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1288 &'decline'& into &'fail'&.
1289 .next
1290 &'fail'&: The router determines that the address should fail, and queues it for
1291 the generation of a bounce message. There is no further processing of the
1292 original address unless &%unseen%& is set on the router.
1293 .next
1294 &'defer'&: The router cannot handle the address at the present time. (A
1295 database may be offline, or a DNS lookup may have timed out.) No further
1296 processing of the address happens in this delivery attempt. It is tried again
1297 next time the message is considered for delivery.
1298 .next
1299 &'error'&: There is some error in the router (for example, a syntax error in
1300 its configuration). The action is as for defer.
1301 .endlist
1302
1303 If an address reaches the end of the routers without having been accepted by
1304 any of them, it is bounced as unrouteable. The default error message in this
1305 situation is &"unrouteable address"&, but you can set your own message by
1306 making use of the &%cannot_route_message%& option. This can be set for any
1307 router; the value from the last router that &"saw"& the address is used.
1308
1309 Sometimes while routing you want to fail a delivery when some conditions are
1310 met but others are not, instead of passing the address on for further routing.
1311 You can do this by having a second router that explicitly fails the delivery
1312 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1313 facility for this purpose.
1314
1315
1316 .section "Duplicate addresses" "SECID17"
1317 .cindex "case of local parts"
1318 .cindex "address duplicate, discarding"
1319 .cindex "duplicate addresses"
1320 Once routing is complete, Exim scans the addresses that are assigned to local
1321 and remote transports, and discards any duplicates that it finds. During this
1322 check, local parts are treated as case-sensitive. This happens only when
1323 actually delivering a message; when testing routers with &%-bt%&, all the
1324 routed addresses are shown.
1325
1326
1327
1328 .section "Router preconditions" "SECTrouprecon"
1329 .cindex "router" "preconditions, order of processing"
1330 .cindex "preconditions" "order of processing"
1331 The preconditions that are tested for each router are listed below, in the
1332 order in which they are tested. The individual configuration options are
1333 described in more detail in chapter &<<CHAProutergeneric>>&.
1334
1335 .ilist
1336 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1337 the local parts handled by the router may or must have certain prefixes and/or
1338 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1339 skipped. These conditions are tested first. When an affix is present, it is
1340 removed from the local part before further processing, including the evaluation
1341 of any other conditions.
1342 .next
1343 Routers can be designated for use only when not verifying an address, that is,
1344 only when routing it for delivery (or testing its delivery routing). If the
1345 &%verify%& option is set false, the router is skipped when Exim is verifying an
1346 address.
1347 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1348 &%verify_recipient%&, which independently control the use of the router for
1349 sender and recipient verification. You can set these options directly if
1350 you want a router to be used for only one type of verification.
1351 .next
1352 If the &%address_test%& option is set false, the router is skipped when Exim is
1353 run with the &%-bt%& option to test an address routing. This can be helpful
1354 when the first router sends all new messages to a scanner of some sort; it
1355 makes it possible to use &%-bt%& to test subsequent delivery routing without
1356 having to simulate the effect of the scanner.
1357 .next
1358 Routers can be designated for use only when verifying an address, as
1359 opposed to routing it for delivery. The &%verify_only%& option controls this.
1360 .next
1361 Individual routers can be explicitly skipped when running the routers to
1362 check an address given in the SMTP EXPN command (see the &%expn%& option).
1363 .next
1364 If the &%domains%& option is set, the domain of the address must be in the set
1365 of domains that it defines.
1366 .next
1367 .vindex "&$local_part_prefix$&"
1368 .vindex "&$local_part$&"
1369 .vindex "&$local_part_suffix$&"
1370 If the &%local_parts%& option is set, the local part of the address must be in
1371 the set of local parts that it defines. If &%local_part_prefix%& or
1372 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1373 part before this check. If you want to do precondition tests on local parts
1374 that include affixes, you can do so by using a &%condition%& option (see below)
1375 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1376 &$local_part_suffix$& as necessary.
1377 .next
1378 .vindex "&$local_user_uid$&"
1379 .vindex "&$local_user_gid$&"
1380 .vindex "&$home$&"
1381 If the &%check_local_user%& option is set, the local part must be the name of
1382 an account on the local host. If this check succeeds, the uid and gid of the
1383 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1384 user's home directory is placed in &$home$&; these values can be used in the
1385 remaining preconditions.
1386 .next
1387 If the &%router_home_directory%& option is set, it is expanded at this point,
1388 because it overrides the value of &$home$&. If this expansion were left till
1389 later, the value of &$home$& as set by &%check_local_user%& would be used in
1390 subsequent tests. Having two different values of &$home$& in the same router
1391 could lead to confusion.
1392 .next
1393 If the &%senders%& option is set, the envelope sender address must be in the
1394 set of addresses that it defines.
1395 .next
1396 If the &%require_files%& option is set, the existence or non-existence of
1397 specified files is tested.
1398 .next
1399 .cindex "customizing" "precondition"
1400 If the &%condition%& option is set, it is evaluated and tested. This option
1401 uses an expanded string to allow you to set up your own custom preconditions.
1402 Expanded strings are described in chapter &<<CHAPexpand>>&.
1403 .endlist
1404
1405
1406 Note that &%require_files%& comes near the end of the list, so you cannot use
1407 it to check for the existence of a file in which to lookup up a domain, local
1408 part, or sender. However, as these options are all expanded, you can use the
1409 &%exists%& expansion condition to make such tests within each condition. The
1410 &%require_files%& option is intended for checking files that the router may be
1411 going to use internally, or which are needed by a specific transport (for
1412 example, &_.procmailrc_&).
1413
1414
1415
1416 .section "Delivery in detail" "SECID18"
1417 .cindex "delivery" "in detail"
1418 When a message is to be delivered, the sequence of events is as follows:
1419
1420 .ilist
1421 If a system-wide filter file is specified, the message is passed to it. The
1422 filter may add recipients to the message, replace the recipients, discard the
1423 message, cause a new message to be generated, or cause the message delivery to
1424 fail. The format of the system filter file is the same as for Exim user filter
1425 files, described in the separate document entitled &'Exim's interfaces to mail
1426 filtering'&.
1427 .cindex "Sieve filter" "not available for system filter"
1428 (&*Note*&: Sieve cannot be used for system filter files.)
1429
1430 Some additional features are available in system filters &-- see chapter
1431 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1432 filter only once per delivery attempt, however many recipients it has. However,
1433 if there are several delivery attempts because one or more addresses could not
1434 be immediately delivered, the system filter is run each time. The filter
1435 condition &%first_delivery%& can be used to detect the first run of the system
1436 filter.
1437 .next
1438 Each recipient address is offered to each configured router in turn, subject to
1439 its preconditions, until one is able to handle it. If no router can handle the
1440 address, that is, if they all decline, the address is failed. Because routers
1441 can be targeted at particular domains, several locally handled domains can be
1442 processed entirely independently of each other.
1443 .next
1444 .cindex "routing" "loops in"
1445 .cindex "loop" "while routing"
1446 A router that accepts an address may assign it to a local or a remote
1447 transport. However, the transport is not run at this time. Instead, the address
1448 is placed on a list for the particular transport, which will be run later.
1449 Alternatively, the router may generate one or more new addresses (typically
1450 from alias, forward, or filter files). New addresses are fed back into this
1451 process from the top, but in order to avoid loops, a router ignores any address
1452 which has an identically-named ancestor that was processed by itself.
1453 .next
1454 When all the routing has been done, addresses that have been successfully
1455 handled are passed to their assigned transports. When local transports are
1456 doing real local deliveries, they handle only one address at a time, but if a
1457 local transport is being used as a pseudo-remote transport (for example, to
1458 collect batched SMTP messages for transmission by some other means) multiple
1459 addresses can be handled. Remote transports can always handle more than one
1460 address at a time, but can be configured not to do so, or to restrict multiple
1461 addresses to the same domain.
1462 .next
1463 Each local delivery to a file or a pipe runs in a separate process under a
1464 non-privileged uid, and these deliveries are run one at a time. Remote
1465 deliveries also run in separate processes, normally under a uid that is private
1466 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1467 run in parallel. The maximum number of simultaneous remote deliveries for any
1468 one message is set by the &%remote_max_parallel%& option.
1469 The order in which deliveries are done is not defined, except that all local
1470 deliveries happen before any remote deliveries.
1471 .next
1472 .cindex "queue runner"
1473 When it encounters a local delivery during a queue run, Exim checks its retry
1474 database to see if there has been a previous temporary delivery failure for the
1475 address before running the local transport. If there was a previous failure,
1476 Exim does not attempt a new delivery until the retry time for the address is
1477 reached. However, this happens only for delivery attempts that are part of a
1478 queue run. Local deliveries are always attempted when delivery immediately
1479 follows message reception, even if retry times are set for them. This makes for
1480 better behaviour if one particular message is causing problems (for example,
1481 causing quota overflow, or provoking an error in a filter file).
1482 .next
1483 .cindex "delivery" "retry in remote transports"
1484 Remote transports do their own retry handling, since an address may be
1485 deliverable to one of a number of hosts, each of which may have a different
1486 retry time. If there have been previous temporary failures and no host has
1487 reached its retry time, no delivery is attempted, whether in a queue run or
1488 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1489 .next
1490 If there were any permanent errors, a bounce message is returned to an
1491 appropriate address (the sender in the common case), with details of the error
1492 for each failing address. Exim can be configured to send copies of bounce
1493 messages to other addresses.
1494 .next
1495 .cindex "delivery" "deferral"
1496 If one or more addresses suffered a temporary failure, the message is left on
1497 the queue, to be tried again later. Delivery of these addresses is said to be
1498 &'deferred'&.
1499 .next
1500 When all the recipient addresses have either been delivered or bounced,
1501 handling of the message is complete. The spool files and message log are
1502 deleted, though the message log can optionally be preserved if required.
1503 .endlist
1504
1505
1506
1507
1508 .section "Retry mechanism" "SECID19"
1509 .cindex "delivery" "retry mechanism"
1510 .cindex "retry" "description of mechanism"
1511 .cindex "queue runner"
1512 Exim's mechanism for retrying messages that fail to get delivered at the first
1513 attempt is the queue runner process. You must either run an Exim daemon that
1514 uses the &%-q%& option with a time interval to start queue runners at regular
1515 intervals, or use some other means (such as &'cron'&) to start them. If you do
1516 not arrange for queue runners to be run, messages that fail temporarily at the
1517 first attempt will remain on your queue for ever. A queue runner process works
1518 its way through the queue, one message at a time, trying each delivery that has
1519 passed its retry time.
1520 You can run several queue runners at once.
1521
1522 Exim uses a set of configured rules to determine when next to retry the failing
1523 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1524 should give up trying to deliver to the address, at which point it generates a
1525 bounce message. If no retry rules are set for a particular host, address, and
1526 error combination, no retries are attempted, and temporary errors are treated
1527 as permanent.
1528
1529
1530
1531 .section "Temporary delivery failure" "SECID20"
1532 .cindex "delivery" "temporary failure"
1533 There are many reasons why a message may not be immediately deliverable to a
1534 particular address. Failure to connect to a remote machine (because it, or the
1535 connection to it, is down) is one of the most common. Temporary failures may be
1536 detected during routing as well as during the transport stage of delivery.
1537 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1538 is on a file system where the user is over quota. Exim can be configured to
1539 impose its own quotas on local mailboxes; where system quotas are set they will
1540 also apply.
1541
1542 If a host is unreachable for a period of time, a number of messages may be
1543 waiting for it by the time it recovers, and sending them in a single SMTP
1544 connection is clearly beneficial. Whenever a delivery to a remote host is
1545 deferred,
1546 .cindex "hints database"
1547 Exim makes a note in its hints database, and whenever a successful
1548 SMTP delivery has happened, it looks to see if any other messages are waiting
1549 for the same host. If any are found, they are sent over the same SMTP
1550 connection, subject to a configuration limit as to the maximum number in any
1551 one connection.
1552
1553
1554
1555 .section "Permanent delivery failure" "SECID21"
1556 .cindex "delivery" "permanent failure"
1557 .cindex "bounce message" "when generated"
1558 When a message cannot be delivered to some or all of its intended recipients, a
1559 bounce message is generated. Temporary delivery failures turn into permanent
1560 errors when their timeout expires. All the addresses that fail in a given
1561 delivery attempt are listed in a single message. If the original message has
1562 many recipients, it is possible for some addresses to fail in one delivery
1563 attempt and others to fail subsequently, giving rise to more than one bounce
1564 message. The wording of bounce messages can be customized by the administrator.
1565 See chapter &<<CHAPemsgcust>>& for details.
1566
1567 .cindex "&'X-Failed-Recipients:'& header line"
1568 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1569 failed addresses, for the benefit of programs that try to analyse such messages
1570 automatically.
1571
1572 .cindex "bounce message" "recipient of"
1573 A bounce message is normally sent to the sender of the original message, as
1574 obtained from the message's envelope. For incoming SMTP messages, this is the
1575 address given in the MAIL command. However, when an address is expanded via a
1576 forward or alias file, an alternative address can be specified for delivery
1577 failures of the generated addresses. For a mailing list expansion (see section
1578 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1579 of the list.
1580
1581
1582
1583 .section "Failures to deliver bounce messages" "SECID22"
1584 .cindex "bounce message" "failure to deliver"
1585 If a bounce message (either locally generated or received from a remote host)
1586 itself suffers a permanent delivery failure, the message is left on the queue,
1587 but it is frozen, awaiting the attention of an administrator. There are options
1588 that can be used to make Exim discard such failed messages, or to keep them
1589 for only a short time (see &%timeout_frozen_after%& and
1590 &%ignore_bounce_errors_after%&).
1591
1592
1593
1594
1595
1596 . ////////////////////////////////////////////////////////////////////////////
1597 . ////////////////////////////////////////////////////////////////////////////
1598
1599 .chapter "Building and installing Exim" "CHID3"
1600 .scindex IIDbuex "building Exim"
1601
1602 .section "Unpacking" "SECID23"
1603 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1604 creates a directory with the name of the current release (for example,
1605 &_exim-&version;_&) into which the following files are placed:
1606
1607 .table2 140pt
1608 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1609 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1610   documented"
1611 .irow &_LICENCE_&         "the GNU General Public Licence"
1612 .irow &_Makefile_&        "top-level make file"
1613 .irow &_NOTICE_&          "conditions for the use of Exim"
1614 .irow &_README_&          "list of files, directories and simple build &&&
1615   instructions"
1616 .endtable
1617
1618 Other files whose names begin with &_README_& may also be present. The
1619 following subdirectories are created:
1620
1621 .table2 140pt
1622 .irow &_Local_&           "an empty directory for local configuration files"
1623 .irow &_OS_&              "OS-specific files"
1624 .irow &_doc_&             "documentation files"
1625 .irow &_exim_monitor_&    "source files for the Exim monitor"
1626 .irow &_scripts_&         "scripts used in the build process"
1627 .irow &_src_&             "remaining source files"
1628 .irow &_util_&            "independent utilities"
1629 .endtable
1630
1631 The main utility programs are contained in the &_src_& directory, and are built
1632 with the Exim binary. The &_util_& directory contains a few optional scripts
1633 that may be useful to some sites.
1634
1635
1636 .section "Multiple machine architectures and operating systems" "SECID24"
1637 .cindex "building Exim" "multiple OS/architectures"
1638 The building process for Exim is arranged to make it easy to build binaries for
1639 a number of different architectures and operating systems from the same set of
1640 source files. Compilation does not take place in the &_src_& directory.
1641 Instead, a &'build directory'& is created for each architecture and operating
1642 system.
1643 .cindex "symbolic link" "to build directory"
1644 Symbolic links to the sources are installed in this directory, which is where
1645 the actual building takes place. In most cases, Exim can discover the machine
1646 architecture and operating system for itself, but the defaults can be
1647 overridden if necessary.
1648
1649
1650 .section "PCRE library" "SECTpcre"
1651 .cindex "PCRE library"
1652 Exim no longer has an embedded PCRE library as the vast majority of
1653 modern systems include PCRE as a system library, although you may need
1654 to install the PCRE or PCRE development package for your operating
1655 system. If your system has a normal PCRE installation the Exim build
1656 process will need no further configuration. If the library or the
1657 headers are in an unusual location you will need to either set the PCRE_LIBS
1658 and INCLUDE directives appropriately,
1659 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1660 If your operating system has no
1661 PCRE support then you will need to obtain and build the current PCRE
1662 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1663 More information on PCRE is available at &url(http://www.pcre.org/).
1664
1665 .section "DBM libraries" "SECTdb"
1666 .cindex "DBM libraries" "discussion of"
1667 .cindex "hints database" "DBM files used for"
1668 Even if you do not use any DBM files in your configuration, Exim still needs a
1669 DBM library in order to operate, because it uses indexed files for its hints
1670 databases. Unfortunately, there are a number of DBM libraries in existence, and
1671 different operating systems often have different ones installed.
1672
1673 .cindex "Solaris" "DBM library for"
1674 .cindex "IRIX, DBM library for"
1675 .cindex "BSD, DBM library for"
1676 .cindex "Linux, DBM library for"
1677 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1678 Linux distribution, the DBM configuration should happen automatically, and you
1679 may be able to ignore this section. Otherwise, you may have to learn more than
1680 you would like about DBM libraries from what follows.
1681
1682 .cindex "&'ndbm'& DBM library"
1683 Licensed versions of Unix normally contain a library of DBM functions operating
1684 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1685 versions of Unix seem to vary in what they contain as standard. In particular,
1686 some early versions of Linux have no default DBM library, and different
1687 distributors have chosen to bundle different libraries with their packaged
1688 versions. However, the more recent releases seem to have standardized on the
1689 Berkeley DB library.
1690
1691 Different DBM libraries have different conventions for naming the files they
1692 use. When a program opens a file called &_dbmfile_&, there are several
1693 possibilities:
1694
1695 .olist
1696 A traditional &'ndbm'& implementation, such as that supplied as part of
1697 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1698 .next
1699 .cindex "&'gdbm'& DBM library"
1700 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1701 compatibility interface it makes two different hard links to it with names
1702 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1703 file name is used unmodified.
1704 .next
1705 .cindex "Berkeley DB library"
1706 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1707 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1708 programmer exactly the same as the traditional &'ndbm'& implementation.
1709 .next
1710 If the Berkeley package is used in its native mode, it operates on a single
1711 file called &_dbmfile_&; the programmer's interface is somewhat different to
1712 the traditional &'ndbm'& interface.
1713 .next
1714 To complicate things further, there are several very different versions of the
1715 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1716 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1717 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1718 versions of Berkeley DB can be obtained from
1719 &url(http://www.sleepycat.com/).
1720 .next
1721 .cindex "&'tdb'& DBM library"
1722 Yet another DBM library, called &'tdb'&, is available from
1723 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1724 operates on a single file.
1725 .endlist
1726
1727 .cindex "USE_DB"
1728 .cindex "DBM libraries" "configuration for building"
1729 Exim and its utilities can be compiled to use any of these interfaces. In order
1730 to use any version of the Berkeley DB package in native mode, you must set
1731 USE_DB in an appropriate configuration file (typically
1732 &_Local/Makefile_&). For example:
1733 .code
1734 USE_DB=yes
1735 .endd
1736 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1737 error is diagnosed if you set more than one of these.
1738
1739 At the lowest level, the build-time configuration sets none of these options,
1740 thereby assuming an interface of type (1). However, some operating system
1741 configuration files (for example, those for the BSD operating systems and
1742 Linux) assume type (4) by setting USE_DB as their default, and the
1743 configuration files for Cygwin set USE_GDBM. Anything you set in
1744 &_Local/Makefile_&, however, overrides these system defaults.
1745
1746 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1747 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1748 in one of these lines:
1749 .code
1750 DBMLIB = -ldb
1751 DBMLIB = -ltdb
1752 .endd
1753 Settings like that will work if the DBM library is installed in the standard
1754 place. Sometimes it is not, and the library's header file may also not be in
1755 the default path. You may need to set INCLUDE to specify where the header
1756 file is, and to specify the path to the library more fully in DBMLIB, as in
1757 this example:
1758 .code
1759 INCLUDE=-I/usr/local/include/db-4.1
1760 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1761 .endd
1762 There is further detailed discussion about the various DBM libraries in the
1763 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1764
1765
1766
1767 .section "Pre-building configuration" "SECID25"
1768 .cindex "building Exim" "pre-building configuration"
1769 .cindex "configuration for building Exim"
1770 .cindex "&_Local/Makefile_&"
1771 .cindex "&_src/EDITME_&"
1772 Before building Exim, a local configuration file that specifies options
1773 independent of any operating system has to be created with the name
1774 &_Local/Makefile_&. A template for this file is supplied as the file
1775 &_src/EDITME_&, and it contains full descriptions of all the option settings
1776 therein. These descriptions are therefore not repeated here. If you are
1777 building Exim for the first time, the simplest thing to do is to copy
1778 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1779
1780 There are three settings that you must supply, because Exim will not build
1781 without them. They are the location of the run time configuration file
1782 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1783 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1784 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1785 a colon-separated list of file names; Exim uses the first of them that exists.
1786
1787 There are a few other parameters that can be specified either at build time or
1788 at run time, to enable the same binary to be used on a number of different
1789 machines. However, if the locations of Exim's spool directory and log file
1790 directory (if not within the spool directory) are fixed, it is recommended that
1791 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1792 detected early in Exim's execution (such as a malformed configuration file) can
1793 be logged.
1794
1795 .cindex "content scanning" "specifying at build time"
1796 Exim's interfaces for calling virus and spam scanning software directly from
1797 access control lists are not compiled by default. If you want to include these
1798 facilities, you need to set
1799 .code
1800 WITH_CONTENT_SCAN=yes
1801 .endd
1802 in your &_Local/Makefile_&. For details of the facilities themselves, see
1803 chapter &<<CHAPexiscan>>&.
1804
1805
1806 .cindex "&_Local/eximon.conf_&"
1807 .cindex "&_exim_monitor/EDITME_&"
1808 If you are going to build the Exim monitor, a similar configuration process is
1809 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1810 your installation and saved under the name &_Local/eximon.conf_&. If you are
1811 happy with the default settings described in &_exim_monitor/EDITME_&,
1812 &_Local/eximon.conf_& can be empty, but it must exist.
1813
1814 This is all the configuration that is needed in straightforward cases for known
1815 operating systems. However, the building process is set up so that it is easy
1816 to override options that are set by default or by operating-system-specific
1817 configuration files, for example to change the name of the C compiler, which
1818 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1819 do this.
1820
1821
1822
1823 .section "Support for iconv()" "SECID26"
1824 .cindex "&[iconv()]& support"
1825 .cindex "RFC 2047"
1826 The contents of header lines in messages may be encoded according to the rules
1827 described RFC 2047. This makes it possible to transmit characters that are not
1828 in the ASCII character set, and to label them as being in a particular
1829 character set. When Exim is inspecting header lines by means of the &%$h_%&
1830 mechanism, it decodes them, and translates them into a specified character set
1831 (default ISO-8859-1). The translation is possible only if the operating system
1832 supports the &[iconv()]& function.
1833
1834 However, some of the operating systems that supply &[iconv()]& do not support
1835 very many conversions. The GNU &%libiconv%& library (available from
1836 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1837 systems to remedy this deficiency, as well as on systems that do not supply
1838 &[iconv()]& at all. After installing &%libiconv%&, you should add
1839 .code
1840 HAVE_ICONV=yes
1841 .endd
1842 to your &_Local/Makefile_& and rebuild Exim.
1843
1844
1845
1846 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1847 .cindex "TLS" "including support for TLS"
1848 .cindex "encryption" "including support for"
1849 .cindex "SUPPORT_TLS"
1850 .cindex "OpenSSL" "building Exim with"
1851 .cindex "GnuTLS" "building Exim with"
1852 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1853 command as per RFC 2487. It can also support legacy clients that expect to
1854 start a TLS session immediately on connection to a non-standard port (see the
1855 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1856 line option).
1857
1858 If you want to build Exim with TLS support, you must first install either the
1859 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1860 implementing SSL.
1861
1862 If OpenSSL is installed, you should set
1863 .code
1864 SUPPORT_TLS=yes
1865 TLS_LIBS=-lssl -lcrypto
1866 .endd
1867 in &_Local/Makefile_&. You may also need to specify the locations of the
1868 OpenSSL library and include files. For example:
1869 .code
1870 SUPPORT_TLS=yes
1871 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1872 TLS_INCLUDE=-I/usr/local/openssl/include/
1873 .endd
1874 .cindex "pkg-config" "OpenSSL"
1875 If you have &'pkg-config'& available, then instead you can just use:
1876 .code
1877 SUPPORT_TLS=yes
1878 USE_OPENSSL_PC=openssl
1879 .endd
1880 .cindex "USE_GNUTLS"
1881 If GnuTLS is installed, you should set
1882 .code
1883 SUPPORT_TLS=yes
1884 USE_GNUTLS=yes
1885 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1886 .endd
1887 in &_Local/Makefile_&, and again you may need to specify the locations of the
1888 library and include files. For example:
1889 .code
1890 SUPPORT_TLS=yes
1891 USE_GNUTLS=yes
1892 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1893 TLS_INCLUDE=-I/usr/gnu/include
1894 .endd
1895 .cindex "pkg-config" "GnuTLS"
1896 If you have &'pkg-config'& available, then instead you can just use:
1897 .code
1898 SUPPORT_TLS=yes
1899 USE_GNUTLS=yes
1900 USE_GNUTLS_PC=gnutls
1901 .endd
1902
1903 You do not need to set TLS_INCLUDE if the relevant directory is already
1904 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1905 given in chapter &<<CHAPTLS>>&.
1906
1907
1908
1909
1910 .section "Use of tcpwrappers" "SECID27"
1911
1912 .cindex "tcpwrappers, building Exim to support"
1913 .cindex "USE_TCP_WRAPPERS"
1914 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1915 .cindex "tcp_wrappers_daemon_name"
1916 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1917 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1918 alternative to Exim's own checking facilities for installations that are
1919 already making use of &'tcpwrappers'& for other purposes. To do this, you
1920 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1921 &_tcpd.h_& to be available at compile time, and also ensure that the library
1922 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1923 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1924 you might have
1925 .code
1926 USE_TCP_WRAPPERS=yes
1927 CFLAGS=-O -I/usr/local/include
1928 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1929 .endd
1930 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1931 files is &"exim"&. For example, the line
1932 .code
1933 exim : LOCAL  192.168.1.  .friendly.domain.example
1934 .endd
1935 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1936 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1937 All other connections are denied. The daemon name used by &'tcpwrappers'&
1938 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1939 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1940 configure file. Consult the &'tcpwrappers'& documentation for
1941 further details.
1942
1943
1944 .section "Including support for IPv6" "SECID28"
1945 .cindex "IPv6" "including support for"
1946 Exim contains code for use on systems that have IPv6 support. Setting
1947 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1948 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1949 where the IPv6 support is not fully integrated into the normal include and
1950 library files.
1951
1952 Two different types of DNS record for handling IPv6 addresses have been
1953 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1954 currently seen as the mainstream. Another record type called A6 was proposed
1955 as better than AAAA because it had more flexibility. However, it was felt to be
1956 over-complex, and its status was reduced to &"experimental"&. It is not known
1957 if anyone is actually using A6 records. Exim has support for A6 records, but
1958 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1959 support has not been tested for some time.
1960
1961
1962
1963 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1964 .cindex "lookup modules"
1965 .cindex "dynamic modules"
1966 .cindex ".so building"
1967 On some platforms, Exim supports not compiling all lookup types directly into
1968 the main binary, instead putting some into external modules which can be loaded
1969 on demand.
1970 This permits packagers to build Exim with support for lookups with extensive
1971 library dependencies without requiring all users to install all of those
1972 dependencies.
1973 Most, but not all, lookup types can be built this way.
1974
1975 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
1976 installed; Exim will only load modules from that directory, as a security
1977 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
1978 for your OS; see &_OS/Makefile-Linux_& for an example.
1979 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
1980 see &_src/EDITME_& for details.
1981
1982 Then, for each module to be loaded dynamically, define the relevant
1983 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
1984 For example, this will build in lsearch but load sqlite and mysql support
1985 on demand:
1986 .code
1987 LOOKUP_LSEARCH=yes
1988 LOOKUP_SQLITE=2
1989 LOOKUP_MYSQL=2
1990 .endd
1991
1992
1993 .section "The building process" "SECID29"
1994 .cindex "build directory"
1995 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
1996 created, run &'make'& at the top level. It determines the architecture and
1997 operating system types, and creates a build directory if one does not exist.
1998 For example, on a Sun system running Solaris 8, the directory
1999 &_build-SunOS5-5.8-sparc_& is created.
2000 .cindex "symbolic link" "to source files"
2001 Symbolic links to relevant source files are installed in the build directory.
2002
2003 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2004 building process fails if it is set.
2005
2006 If this is the first time &'make'& has been run, it calls a script that builds
2007 a make file inside the build directory, using the configuration files from the
2008 &_Local_& directory. The new make file is then passed to another instance of
2009 &'make'&. This does the real work, building a number of utility scripts, and
2010 then compiling and linking the binaries for the Exim monitor (if configured), a
2011 number of utility programs, and finally Exim itself. The command &`make
2012 makefile`& can be used to force a rebuild of the make file in the build
2013 directory, should this ever be necessary.
2014
2015 If you have problems building Exim, check for any comments there may be in the
2016 &_README_& file concerning your operating system, and also take a look at the
2017 FAQ, where some common problems are covered.
2018
2019
2020
2021 .section 'Output from &"make"&' "SECID283"
2022 The output produced by the &'make'& process for compile lines is often very
2023 unreadable, because these lines can be very long. For this reason, the normal
2024 output is suppressed by default, and instead output similar to that which
2025 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2026 each module that is being compiled or linked. However, it is still possible to
2027 get the full output, by calling &'make'& like this:
2028 .code
2029 FULLECHO='' make -e
2030 .endd
2031 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2032 command reflection in &'make'&. When you ask for the full output, it is
2033 given in addition to the short output.
2034
2035
2036
2037 .section "Overriding build-time options for Exim" "SECToverride"
2038 .cindex "build-time options, overriding"
2039 The main make file that is created at the beginning of the building process
2040 consists of the concatenation of a number of files which set configuration
2041 values, followed by a fixed set of &'make'& instructions. If a value is set
2042 more than once, the last setting overrides any previous ones. This provides a
2043 convenient way of overriding defaults. The files that are concatenated are, in
2044 order:
2045 .display
2046 &_OS/Makefile-Default_&
2047 &_OS/Makefile-_&<&'ostype'&>
2048 &_Local/Makefile_&
2049 &_Local/Makefile-_&<&'ostype'&>
2050 &_Local/Makefile-_&<&'archtype'&>
2051 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2052 &_OS/Makefile-Base_&
2053 .endd
2054 .cindex "&_Local/Makefile_&"
2055 .cindex "building Exim" "operating system type"
2056 .cindex "building Exim" "architecture type"
2057 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2058 architecture type. &_Local/Makefile_& is required to exist, and the building
2059 process fails if it is absent. The other three &_Local_& files are optional,
2060 and are often not needed.
2061
2062 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2063 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2064 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2065 values are used, thereby providing a means of forcing particular settings.
2066 Otherwise, the scripts try to get values from the &%uname%& command. If this
2067 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2068 of &'ad hoc'& transformations are then applied, to produce the standard names
2069 that Exim expects. You can run these scripts directly from the shell in order
2070 to find out what values are being used on your system.
2071
2072
2073 &_OS/Makefile-Default_& contains comments about the variables that are set
2074 therein. Some (but not all) are mentioned below. If there is something that
2075 needs changing, review the contents of this file and the contents of the make
2076 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2077 default values are.
2078
2079
2080 .cindex "building Exim" "overriding default settings"
2081 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2082 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2083 need to change the original files. Instead, you should make the changes by
2084 putting the new values in an appropriate &_Local_& file. For example,
2085 .cindex "Tru64-Unix build-time settings"
2086 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2087 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2088 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2089 called with the option &%-std1%&, to make it recognize some of the features of
2090 Standard C that Exim uses. (Most other compilers recognize Standard C by
2091 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2092 containing the lines
2093 .code
2094 CC=cc
2095 CFLAGS=-std1
2096 .endd
2097 If you are compiling for just one operating system, it may be easier to put
2098 these lines directly into &_Local/Makefile_&.
2099
2100 Keeping all your local configuration settings separate from the distributed
2101 files makes it easy to transfer them to new versions of Exim simply by copying
2102 the contents of the &_Local_& directory.
2103
2104
2105 .cindex "NIS lookup type" "including support for"
2106 .cindex "NIS+ lookup type" "including support for"
2107 .cindex "LDAP" "including support for"
2108 .cindex "lookup" "inclusion in binary"
2109 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2110 lookup, but not all systems have these components installed, so the default is
2111 not to include the relevant code in the binary. All the different kinds of file
2112 and database lookup that Exim supports are implemented as separate code modules
2113 which are included only if the relevant compile-time options are set. In the
2114 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2115 .code
2116 LOOKUP_LDAP=yes
2117 LOOKUP_NIS=yes
2118 LOOKUP_NISPLUS=yes
2119 .endd
2120 and similar settings apply to the other lookup types. They are all listed in
2121 &_src/EDITME_&. In many cases the relevant include files and interface
2122 libraries need to be installed before compiling Exim.
2123 .cindex "cdb" "including support for"
2124 However, there are some optional lookup types (such as cdb) for which
2125 the code is entirely contained within Exim, and no external include
2126 files or libraries are required. When a lookup type is not included in the
2127 binary, attempts to configure Exim to use it cause run time configuration
2128 errors.
2129
2130 .cindex "pkg-config" "lookups"
2131 .cindex "pkg-config" "authenticators"
2132 Many systems now use a tool called &'pkg-config'& to encapsulate information
2133 about how to compile against a library; Exim has some initial support for
2134 being able to use pkg-config for lookups and authenticators.  For any given
2135 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2136 variable with the &`_PC`& suffix in the name and assign as the value the
2137 name of the package to be queried.  The results of querying via the
2138 &'pkg-config'& command will be added to the appropriate Makefile variables
2139 with &`+=`& directives, so your version of &'make'& will need to support that
2140 syntax.  For instance:
2141 .code
2142 LOOKUP_SQLITE=yes
2143 LOOKUP_SQLITE_PC=sqlite3
2144 AUTH_GSASL=yes
2145 AUTH_GSASL_PC=libgsasl
2146 AUTH_HEIMDAL_GSSAPI=yes
2147 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2148 .endd
2149
2150 .cindex "Perl" "including support for"
2151 Exim can be linked with an embedded Perl interpreter, allowing Perl
2152 subroutines to be called during string expansion. To enable this facility,
2153 .code
2154 EXIM_PERL=perl.o
2155 .endd
2156 must be defined in &_Local/Makefile_&. Details of this facility are given in
2157 chapter &<<CHAPperl>>&.
2158
2159 .cindex "X11 libraries, location of"
2160 The location of the X11 libraries is something that varies a lot between
2161 operating systems, and there may be different versions of X11 to cope
2162 with. Exim itself makes no use of X11, but if you are compiling the Exim
2163 monitor, the X11 libraries must be available.
2164 The following three variables are set in &_OS/Makefile-Default_&:
2165 .code
2166 X11=/usr/X11R6
2167 XINCLUDE=-I$(X11)/include
2168 XLFLAGS=-L$(X11)/lib
2169 .endd
2170 These are overridden in some of the operating-system configuration files. For
2171 example, in &_OS/Makefile-SunOS5_& there is
2172 .code
2173 X11=/usr/openwin
2174 XINCLUDE=-I$(X11)/include
2175 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2176 .endd
2177 If you need to override the default setting for your operating system, place a
2178 definition of all three of these variables into your
2179 &_Local/Makefile-<ostype>_& file.
2180
2181 .cindex "EXTRALIBS"
2182 If you need to add any extra libraries to the link steps, these can be put in a
2183 variable called EXTRALIBS, which appears in all the link commands, but by
2184 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2185 command for linking the main Exim binary, and not for any associated utilities.
2186
2187 .cindex "DBM libraries" "configuration for building"
2188 There is also DBMLIB, which appears in the link commands for binaries that
2189 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2190 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2191 binary, and which can be used, for example, to include additional X11
2192 libraries.
2193
2194 .cindex "configuration file" "editing"
2195 The make file copes with rebuilding Exim correctly if any of the configuration
2196 files are edited. However, if an optional configuration file is deleted, it is
2197 necessary to touch the associated non-optional file (that is,
2198 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2199
2200
2201 .section "OS-specific header files" "SECID30"
2202 .cindex "&_os.h_&"
2203 .cindex "building Exim" "OS-specific C header files"
2204 The &_OS_& directory contains a number of files with names of the form
2205 &_os.h-<ostype>_&. These are system-specific C header files that should not
2206 normally need to be changed. There is a list of macro settings that are
2207 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2208 are porting Exim to a new operating system.
2209
2210
2211
2212 .section "Overriding build-time options for the monitor" "SECID31"
2213 .cindex "building Eximon"
2214 A similar process is used for overriding things when building the Exim monitor,
2215 where the files that are involved are
2216 .display
2217 &_OS/eximon.conf-Default_&
2218 &_OS/eximon.conf-_&<&'ostype'&>
2219 &_Local/eximon.conf_&
2220 &_Local/eximon.conf-_&<&'ostype'&>
2221 &_Local/eximon.conf-_&<&'archtype'&>
2222 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2223 .endd
2224 .cindex "&_Local/eximon.conf_&"
2225 As with Exim itself, the final three files need not exist, and in this case the
2226 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2227 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2228 variables of the same name, preceded by EXIMON_. For example, setting
2229 EXIMON_LOG_DEPTH in the environment overrides the value of
2230 LOG_DEPTH at run time.
2231 .ecindex IIDbuex
2232
2233
2234 .section "Installing Exim binaries and scripts" "SECID32"
2235 .cindex "installing Exim"
2236 .cindex "BIN_DIRECTORY"
2237 The command &`make install`& runs the &(exim_install)& script with no
2238 arguments. The script copies binaries and utility scripts into the directory
2239 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2240 .cindex "setuid" "installing Exim with"
2241 The install script copies files only if they are newer than the files they are
2242 going to replace. The Exim binary is required to be owned by root and have the
2243 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2244 install`& as root so that it can set up the Exim binary in this way. However, in
2245 some special situations (for example, if a host is doing no local deliveries)
2246 it may be possible to run Exim without making the binary setuid root (see
2247 chapter &<<CHAPsecurity>>& for details).
2248
2249 .cindex "CONFIGURE_FILE"
2250 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2251 in &_Local/Makefile_&. If this names a single file, and the file does not
2252 exist, the default configuration file &_src/configure.default_& is copied there
2253 by the installation script. If a run time configuration file already exists, it
2254 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2255 alternative files, no default is installed.
2256
2257 .cindex "system aliases file"
2258 .cindex "&_/etc/aliases_&"
2259 One change is made to the default configuration file when it is installed: the
2260 default configuration contains a router that references a system aliases file.
2261 The path to this file is set to the value specified by
2262 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2263 If the system aliases file does not exist, the installation script creates it,
2264 and outputs a comment to the user.
2265
2266 The created file contains no aliases, but it does contain comments about the
2267 aliases a site should normally have. Mail aliases have traditionally been
2268 kept in &_/etc/aliases_&. However, some operating systems are now using
2269 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2270 Exim's configuration if necessary.
2271
2272 The default configuration uses the local host's name as the only local domain,
2273 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2274 running as the local user. System aliases and &_.forward_& files in users' home
2275 directories are supported, but no NIS or NIS+ support is configured. Domains
2276 other than the name of the local host are routed using the DNS, with delivery
2277 over SMTP.
2278
2279 It is possible to install Exim for special purposes (such as building a binary
2280 distribution) in a private part of the file system. You can do this by a
2281 command such as
2282 .code
2283 make DESTDIR=/some/directory/ install
2284 .endd
2285 This has the effect of pre-pending the specified directory to all the file
2286 paths, except the name of the system aliases file that appears in the default
2287 configuration. (If a default alias file is created, its name &'is'& modified.)
2288 For backwards compatibility, ROOT is used if DESTDIR is not set,
2289 but this usage is deprecated.
2290
2291 .cindex "installing Exim" "what is not installed"
2292 Running &'make install'& does not copy the Exim 4 conversion script
2293 &'convert4r4'&. You will probably run this only once if you are
2294 upgrading from Exim 3. None of the documentation files in the &_doc_&
2295 directory are copied, except for the info files when you have set
2296 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2297
2298 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2299 to their names. The Exim binary itself, however, is handled differently. It is
2300 installed under a name that includes the version number and the compile number,
2301 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2302 called &_exim_& to point to the binary. If you are updating a previous version
2303 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2304 from the directory (as seen by other processes).
2305
2306 .cindex "installing Exim" "testing the script"
2307 If you want to see what the &'make install'& will do before running it for
2308 real, you can pass the &%-n%& option to the installation script by this
2309 command:
2310 .code
2311 make INSTALL_ARG=-n install
2312 .endd
2313 The contents of the variable INSTALL_ARG are passed to the installation
2314 script. You do not need to be root to run this test. Alternatively, you can run
2315 the installation script directly, but this must be from within the build
2316 directory. For example, from the top-level Exim directory you could use this
2317 command:
2318 .code
2319 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2320 .endd
2321 .cindex "installing Exim" "install script options"
2322 There are two other options that can be supplied to the installation script.
2323
2324 .ilist
2325 &%-no_chown%& bypasses the call to change the owner of the installed binary
2326 to root, and the call to make it a setuid binary.
2327 .next
2328 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2329 installed binary.
2330 .endlist
2331
2332 INSTALL_ARG can be used to pass these options to the script. For example:
2333 .code
2334 make INSTALL_ARG=-no_symlink install
2335 .endd
2336 The installation script can also be given arguments specifying which files are
2337 to be copied. For example, to install just the Exim binary, and nothing else,
2338 without creating the symbolic link, you could use:
2339 .code
2340 make INSTALL_ARG='-no_symlink exim' install
2341 .endd
2342
2343
2344
2345 .section "Installing info documentation" "SECTinsinfdoc"
2346 .cindex "installing Exim" "&'info'& documentation"
2347 Not all systems use the GNU &'info'& system for documentation, and for this
2348 reason, the Texinfo source of Exim's documentation is not included in the main
2349 distribution. Instead it is available separately from the ftp site (see section
2350 &<<SECTavail>>&).
2351
2352 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2353 source of the documentation is found in the source tree, running &`make
2354 install`& automatically builds the info files and installs them.
2355
2356
2357
2358 .section "Setting up the spool directory" "SECID33"
2359 .cindex "spool directory" "creating"
2360 When it starts up, Exim tries to create its spool directory if it does not
2361 exist. The Exim uid and gid are used for the owner and group of the spool
2362 directory. Sub-directories are automatically created in the spool directory as
2363 necessary.
2364
2365
2366
2367
2368 .section "Testing" "SECID34"
2369 .cindex "testing" "installation"
2370 Having installed Exim, you can check that the run time configuration file is
2371 syntactically valid by running the following command, which assumes that the
2372 Exim binary directory is within your PATH environment variable:
2373 .code
2374 exim -bV
2375 .endd
2376 If there are any errors in the configuration file, Exim outputs error messages.
2377 Otherwise it outputs the version number and build date,
2378 the DBM library that is being used, and information about which drivers and
2379 other optional code modules are included in the binary.
2380 Some simple routing tests can be done by using the address testing option. For
2381 example,
2382 .display
2383 &`exim -bt`& <&'local username'&>
2384 .endd
2385 should verify that it recognizes a local mailbox, and
2386 .display
2387 &`exim -bt`& <&'remote address'&>
2388 .endd
2389 a remote one. Then try getting it to deliver mail, both locally and remotely.
2390 This can be done by passing messages directly to Exim, without going through a
2391 user agent. For example:
2392 .code
2393 exim -v postmaster@your.domain.example
2394 From: user@your.domain.example
2395 To: postmaster@your.domain.example
2396 Subject: Testing Exim
2397
2398 This is a test message.
2399 ^D
2400 .endd
2401 The &%-v%& option causes Exim to output some verification of what it is doing.
2402 In this case you should see copies of three log lines, one for the message's
2403 arrival, one for its delivery, and one containing &"Completed"&.
2404
2405 .cindex "delivery" "problems with"
2406 If you encounter problems, look at Exim's log files (&'mainlog'& and
2407 &'paniclog'&) to see if there is any relevant information there. Another source
2408 of information is running Exim with debugging turned on, by specifying the
2409 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2410 with debugging turned on by a command of the form
2411 .display
2412 &`exim -d -M`& <&'exim-message-id'&>
2413 .endd
2414 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2415 produces rather a lot of output, but you can cut this down to specific areas.
2416 For example, if you use &%-d-all+route%& only the debugging information
2417 relevant to routing is included. (See the &%-d%& option in chapter
2418 &<<CHAPcommandline>>& for more details.)
2419
2420 .cindex '&"sticky"& bit'
2421 .cindex "lock files"
2422 One specific problem that has shown up on some sites is the inability to do
2423 local deliveries into a shared mailbox directory, because it does not have the
2424 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2425 writing to a mailbox file, and if it cannot create the lock file, the delivery
2426 is deferred. You can get round this either by setting the &"sticky bit"& on the
2427 directory, or by setting a specific group for local deliveries and allowing
2428 that group to create files in the directory (see the comments above the
2429 &(local_delivery)& transport in the default configuration file). Another
2430 approach is to configure Exim not to use lock files, but just to rely on
2431 &[fcntl()]& locking instead. However, you should do this only if all user
2432 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2433 see chapter &<<CHAPappendfile>>&.
2434
2435 One thing that cannot be tested on a system that is already running an MTA is
2436 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2437 &%-oX%& option can be used to run an Exim daemon that listens on some other
2438 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2439 &'exim_checkaccess'& utility can be used to check out policy controls on
2440 incoming SMTP mail.
2441
2442 Testing a new version on a system that is already running Exim can most easily
2443 be done by building a binary with a different CONFIGURE_FILE setting. From
2444 within the run time configuration, all other file and directory names
2445 that Exim uses can be altered, in order to keep it entirely clear of the
2446 production version.
2447
2448
2449 .section "Replacing another MTA with Exim" "SECID35"
2450 .cindex "replacing another MTA"
2451 Building and installing Exim for the first time does not of itself put it in
2452 general use. The name by which the system's MTA is called by mail user agents
2453 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2454 operating system), and it is necessary to make this name point to the &'exim'&
2455 binary in order to get the user agents to pass messages to Exim. This is
2456 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2457 or &_/usr/lib/sendmail_&
2458 .cindex "symbolic link" "to &'exim'& binary"
2459 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2460 privilege and executable status from the old MTA. It is then necessary to stop
2461 and restart the mailer daemon, if one is running.
2462
2463 .cindex "FreeBSD, MTA indirection"
2464 .cindex "&_/etc/mail/mailer.conf_&"
2465 Some operating systems have introduced alternative ways of switching MTAs. For
2466 example, if you are running FreeBSD, you need to edit the file
2467 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2468 described. A typical example of the contents of this file for running Exim is
2469 as follows:
2470 .code
2471 sendmail            /usr/exim/bin/exim
2472 send-mail           /usr/exim/bin/exim
2473 mailq               /usr/exim/bin/exim -bp
2474 newaliases          /usr/bin/true
2475 .endd
2476 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2477 your Exim installation is &"live"&. Check it by sending a message from your
2478 favourite user agent.
2479
2480 You should consider what to tell your users about the change of MTA. Exim may
2481 have different capabilities to what was previously running, and there are
2482 various operational differences such as the text of messages produced by
2483 command line options and in bounce messages. If you allow your users to make
2484 use of Exim's filtering capabilities, you should make the document entitled
2485 &'Exim's interface to mail filtering'& available to them.
2486
2487
2488
2489 .section "Upgrading Exim" "SECID36"
2490 .cindex "upgrading Exim"
2491 If you are already running Exim on your host, building and installing a new
2492 version automatically makes it available to MUAs, or any other programs that
2493 call the MTA directly. However, if you are running an Exim daemon, you do need
2494 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2495 new binary. You do not need to stop processing mail in order to install a new
2496 version of Exim. The install script does not modify an existing runtime
2497 configuration file.
2498
2499
2500
2501
2502 .section "Stopping the Exim daemon on Solaris" "SECID37"
2503 .cindex "Solaris" "stopping Exim on"
2504 The standard command for stopping the mailer daemon on Solaris is
2505 .code
2506 /etc/init.d/sendmail stop
2507 .endd
2508 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2509 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2510 for the text &"sendmail"&; this is not present because the actual program name
2511 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2512 solution is to replace the line that finds the process id with something like
2513 .code
2514 pid=`cat /var/spool/exim/exim-daemon.pid`
2515 .endd
2516 to obtain the daemon's pid directly from the file that Exim saves it in.
2517
2518 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2519 still be received from local processes, and if automatic delivery is configured
2520 (the normal case), deliveries will still occur.
2521
2522
2523
2524
2525 . ////////////////////////////////////////////////////////////////////////////
2526 . ////////////////////////////////////////////////////////////////////////////
2527
2528 .chapter "The Exim command line" "CHAPcommandline"
2529 .scindex IIDclo1 "command line" "options"
2530 .scindex IIDclo2 "options" "command line"
2531 Exim's command line takes the standard Unix form of a sequence of options,
2532 each starting with a hyphen character, followed by a number of arguments. The
2533 options are compatible with the main options of Sendmail, and there are also
2534 some additional options, some of which are compatible with Smail 3. Certain
2535 combinations of options do not make sense, and provoke an error if used.
2536 The form of the arguments depends on which options are set.
2537
2538
2539 .section "Setting options by program name" "SECID38"
2540 .cindex "&'mailq'&"
2541 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2542 were present before any other options.
2543 The &%-bp%& option requests a listing of the contents of the mail queue on the
2544 standard output.
2545 This feature is for compatibility with some systems that contain a command of
2546 that name in one of the standard libraries, symbolically linked to
2547 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2548
2549 .cindex "&'rsmtp'&"
2550 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2551 were present before any other options, for compatibility with Smail. The
2552 &%-bS%& option is used for reading in a number of messages in batched SMTP
2553 format.
2554
2555 .cindex "&'rmail'&"
2556 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2557 &%-oee%& options were present before any other options, for compatibility with
2558 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2559
2560 .cindex "&'runq'&"
2561 .cindex "queue runner"
2562 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2563 were present before any other options, for compatibility with Smail. The &%-q%&
2564 option causes a single queue runner process to be started.
2565
2566 .cindex "&'newaliases'&"
2567 .cindex "alias file" "building"
2568 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2569 If Exim is called under the name &'newaliases'& it behaves as if the option
2570 &%-bi%& were present before any other options, for compatibility with Sendmail.
2571 This option is used for rebuilding Sendmail's alias file. Exim does not have
2572 the concept of a single alias file, but can be configured to run a given
2573 command if called with the &%-bi%& option.
2574
2575
2576 .section "Trusted and admin users" "SECTtrustedadmin"
2577 Some Exim options are available only to &'trusted users'& and others are
2578 available only to &'admin users'&. In the description below, the phrases &"Exim
2579 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2580 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2581 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2582
2583 .ilist
2584 .cindex "trusted users" "definition of"
2585 .cindex "user" "trusted definition of"
2586 The trusted users are root, the Exim user, any user listed in the
2587 &%trusted_users%& configuration option, and any user whose current group or any
2588 supplementary group is one of those listed in the &%trusted_groups%&
2589 configuration option. Note that the Exim group is not automatically trusted.
2590
2591 .cindex '&"From"& line'
2592 .cindex "envelope sender"
2593 Trusted users are always permitted to use the &%-f%& option or a leading
2594 &"From&~"& line to specify the envelope sender of a message that is passed to
2595 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2596 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2597 users to set envelope senders.
2598
2599 .cindex "&'From:'& header line"
2600 .cindex "&'Sender:'& header line"
2601 For a trusted user, there is never any check on the contents of the &'From:'&
2602 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2603 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2604
2605 Trusted users may also specify a host name, host address, interface address,
2606 protocol name, ident value, and authentication data when submitting a message
2607 locally. Thus, they are able to insert messages into Exim's queue locally that
2608 have the characteristics of messages received from a remote host. Untrusted
2609 users may in some circumstances use &%-f%&, but can never set the other values
2610 that are available to trusted users.
2611 .next
2612 .cindex "user" "admin definition of"
2613 .cindex "admin user" "definition of"
2614 The admin users are root, the Exim user, and any user that is a member of the
2615 Exim group or of any group listed in the &%admin_groups%& configuration option.
2616 The current group does not have to be one of these groups.
2617
2618 Admin users are permitted to list the queue, and to carry out certain
2619 operations on messages, for example, to force delivery failures. It is also
2620 necessary to be an admin user in order to see the full information provided by
2621 the Exim monitor, and full debugging output.
2622
2623 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2624 Exim to attempt delivery of messages on its queue is restricted to admin users.
2625 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2626 option false (that is, specifying &%no_prod_requires_admin%&).
2627
2628 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2629 is restricted to admin users unless &%queue_list_requires_admin%& is set
2630 false.
2631 .endlist
2632
2633
2634 &*Warning*&: If you configure your system so that admin users are able to
2635 edit Exim's configuration file, you are giving those users an easy way of
2636 getting root. There is further discussion of this issue at the start of chapter
2637 &<<CHAPconf>>&.
2638
2639
2640
2641
2642 .section "Command line options" "SECID39"
2643 Exim's command line options are described in alphabetical order below. If none
2644 of the options that specifies a specific action (such as starting the daemon or
2645 a queue runner, or testing an address, or receiving a message in a specific
2646 format, or listing the queue) are present, and there is at least one argument
2647 on the command line, &%-bm%& (accept a local message on the standard input,
2648 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2649 outputs a brief message about itself and exits.
2650
2651 . ////////////////////////////////////////////////////////////////////////////
2652 . Insert a stylized XML comment here, to identify the start of the command line
2653 . options. This is for the benefit of the Perl script that automatically
2654 . creates a man page for the options.
2655 . ////////////////////////////////////////////////////////////////////////////
2656
2657 .literal xml
2658 <!-- === Start of command line options === -->
2659 .literal off
2660
2661
2662 .vlist
2663 .vitem &%--%&
2664 .oindex "--"
2665 .cindex "options" "command line; terminating"
2666 This is a pseudo-option whose only purpose is to terminate the options and
2667 therefore to cause subsequent command line items to be treated as arguments
2668 rather than options, even if they begin with hyphens.
2669
2670 .vitem &%--help%&
2671 .oindex "&%--help%&"
2672 This option causes Exim to output a few sentences stating what it is.
2673 The same output is generated if the Exim binary is called with no options and
2674 no arguments.
2675
2676 .vitem &%--version%&
2677 .oindex "&%--version%&"
2678 This option is an alias for &%-bV%& and causes version information to be
2679 displayed.
2680
2681 .new
2682 .vitem &%-Ac%& &&&
2683        &%-Am%&
2684 .oindex "&%-Ac%&"
2685 .oindex "&%-Am%&"
2686 These options are used by Sendmail for selecting configuration files and are
2687 ignored by Exim.
2688 .wen
2689
2690 .vitem &%-B%&<&'type'&>
2691 .oindex "&%-B%&"
2692 .cindex "8-bit characters"
2693 .cindex "Sendmail compatibility" "8-bit characters"
2694 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2695 clean; it ignores this option.
2696
2697 .vitem &%-bd%&
2698 .oindex "&%-bd%&"
2699 .cindex "daemon"
2700 .cindex "SMTP" "listener"
2701 .cindex "queue runner"
2702 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2703 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2704 that the daemon should also initiate periodic queue runs.
2705
2706 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2707 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2708 disconnect from the controlling terminal. When running this way, it can be
2709 stopped by pressing ctrl-C.
2710
2711 By default, Exim listens for incoming connections to the standard SMTP port on
2712 all the host's running interfaces. However, it is possible to listen on other
2713 ports, on multiple ports, and only on specific interfaces. Chapter
2714 &<<CHAPinterfaces>>& contains a description of the options that control this.
2715
2716 When a listening daemon
2717 .cindex "daemon" "process id (pid)"
2718 .cindex "pid (process id)" "of daemon"
2719 is started without the use of &%-oX%& (that is, without overriding the normal
2720 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2721 in Exim's spool directory. This location can be overridden by setting
2722 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2723 running as root.
2724
2725 When &%-oX%& is used on the command line to start a listening daemon, the
2726 process id is not written to the normal pid file path. However, &%-oP%& can be
2727 used to specify a path on the command line if a pid file is required.
2728
2729 The SIGHUP signal
2730 .cindex "SIGHUP"
2731 .cindex "daemon" "restarting"
2732 can be used to cause the daemon to re-execute itself. This should be done
2733 whenever Exim's configuration file, or any file that is incorporated into it by
2734 means of the &%.include%& facility, is changed, and also whenever a new version
2735 of Exim is installed. It is not necessary to do this when other files that are
2736 referenced from the configuration (for example, alias files) are changed,
2737 because these are reread each time they are used.
2738
2739 .vitem &%-bdf%&
2740 .oindex "&%-bdf%&"
2741 This option has the same effect as &%-bd%& except that it never disconnects
2742 from the controlling terminal, even when no debugging is specified.
2743
2744 .vitem &%-be%&
2745 .oindex "&%-be%&"
2746 .cindex "testing" "string expansion"
2747 .cindex "expansion" "testing"
2748 Run Exim in expansion testing mode. Exim discards its root privilege, to
2749 prevent ordinary users from using this mode to read otherwise inaccessible
2750 files. If no arguments are given, Exim runs interactively, prompting for lines
2751 of data. Otherwise, it processes each argument in turn.
2752
2753 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2754 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2755 used without command line arguments. If successful, it uses the &[readline()]&
2756 function, which provides extensive line-editing facilities, for reading the
2757 test data. A line history is supported.
2758
2759 Long expansion expressions can be split over several lines by using backslash
2760 continuations. As in Exim's run time configuration, white space at the start of
2761 continuation lines is ignored. Each argument or data line is passed through the
2762 string expansion mechanism, and the result is output. Variable values from the
2763 configuration file (for example, &$qualify_domain$&) are available, but no
2764 message-specific values (such as &$sender_domain$&) are set, because no message
2765 is being processed (but see &%-bem%& and &%-Mset%&).
2766
2767 &*Note*&: If you use this mechanism to test lookups, and you change the data
2768 files or databases you are using, you must exit and restart Exim before trying
2769 the same lookup again. Otherwise, because each Exim process caches the results
2770 of lookups, you will just get the same result as before.
2771
2772 .vitem &%-bem%&&~<&'filename'&>
2773 .oindex "&%-bem%&"
2774 .cindex "testing" "string expansion"
2775 .cindex "expansion" "testing"
2776 This option operates like &%-be%& except that it must be followed by the name
2777 of a file. For example:
2778 .code
2779 exim -bem /tmp/testmessage
2780 .endd
2781 The file is read as a message (as if receiving a locally-submitted non-SMTP
2782 message) before any of the test expansions are done. Thus, message-specific
2783 variables such as &$message_size$& and &$header_from:$& are available. However,
2784 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2785 recipients are read from the headers in the normal way, and are shown in the
2786 &$recipients$& variable. Note that recipients cannot be given on the command
2787 line, because further arguments are taken as strings to expand (just like
2788 &%-be%&).
2789
2790 .vitem &%-bF%&&~<&'filename'&>
2791 .oindex "&%-bF%&"
2792 .cindex "system filter" "testing"
2793 .cindex "testing" "system filter"
2794 This option is the same as &%-bf%& except that it assumes that the filter being
2795 tested is a system filter. The additional commands that are available only in
2796 system filters are recognized.
2797
2798 .vitem &%-bf%&&~<&'filename'&>
2799 .oindex "&%-bf%&"
2800 .cindex "filter" "testing"
2801 .cindex "testing" "filter file"
2802 .cindex "forward file" "testing"
2803 .cindex "testing" "forward file"
2804 .cindex "Sieve filter" "testing"
2805 This option runs Exim in user filter testing mode; the file is the filter file
2806 to be tested, and a test message must be supplied on the standard input. If
2807 there are no message-dependent tests in the filter, an empty file can be
2808 supplied.
2809
2810 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2811 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2812 filter and a user filter in the same run. For example:
2813 .code
2814 exim -bF /system/filter -bf /user/filter </test/message
2815 .endd
2816 This is helpful when the system filter adds header lines or sets filter
2817 variables that are used by the user filter.
2818
2819 If the test filter file does not begin with one of the special lines
2820 .code
2821 # Exim filter
2822 # Sieve filter
2823 .endd
2824 it is taken to be a normal &_.forward_& file, and is tested for validity under
2825 that interpretation. See sections &<<SECTitenonfilred>>& to
2826 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2827 redirection lists.
2828
2829 The result of an Exim command that uses &%-bf%&, provided no errors are
2830 detected, is a list of the actions that Exim would try to take if presented
2831 with the message for real. More details of filter testing are given in the
2832 separate document entitled &'Exim's interfaces to mail filtering'&.
2833
2834 When testing a filter file,
2835 .cindex "&""From""& line"
2836 .cindex "envelope sender"
2837 .oindex "&%-f%&" "for filter testing"
2838 the envelope sender can be set by the &%-f%& option,
2839 or by a &"From&~"& line at the start of the test message. Various parameters
2840 that would normally be taken from the envelope recipient address of the message
2841 can be set by means of additional command line options (see the next four
2842 options).
2843
2844 .vitem &%-bfd%&&~<&'domain'&>
2845 .oindex "&%-bfd%&"
2846 .vindex "&$qualify_domain$&"
2847 This sets the domain of the recipient address when a filter file is being
2848 tested by means of the &%-bf%& option. The default is the value of
2849 &$qualify_domain$&.
2850
2851 .vitem &%-bfl%&&~<&'local&~part'&>
2852 .oindex "&%-bfl%&"
2853 This sets the local part of the recipient address when a filter file is being
2854 tested by means of the &%-bf%& option. The default is the username of the
2855 process that calls Exim. A local part should be specified with any prefix or
2856 suffix stripped, because that is how it appears to the filter when a message is
2857 actually being delivered.
2858
2859 .vitem &%-bfp%&&~<&'prefix'&>
2860 .oindex "&%-bfp%&"
2861 This sets the prefix of the local part of the recipient address when a filter
2862 file is being tested by means of the &%-bf%& option. The default is an empty
2863 prefix.
2864
2865 .vitem &%-bfs%&&~<&'suffix'&>
2866 .oindex "&%-bfs%&"
2867 This sets the suffix of the local part of the recipient address when a filter
2868 file is being tested by means of the &%-bf%& option. The default is an empty
2869 suffix.
2870
2871 .vitem &%-bh%&&~<&'IP&~address'&>
2872 .oindex "&%-bh%&"
2873 .cindex "testing" "incoming SMTP"
2874 .cindex "SMTP" "testing incoming"
2875 .cindex "testing" "relay control"
2876 .cindex "relaying" "testing configuration"
2877 .cindex "policy control" "testing"
2878 .cindex "debugging" "&%-bh%& option"
2879 This option runs a fake SMTP session as if from the given IP address, using the
2880 standard input and output. The IP address may include a port number at the end,
2881 after a full stop. For example:
2882 .code
2883 exim -bh 10.9.8.7.1234
2884 exim -bh fe80::a00:20ff:fe86:a061.5678
2885 .endd
2886 When an IPv6 address is given, it is converted into canonical form. In the case
2887 of the second example above, the value of &$sender_host_address$& after
2888 conversion to the canonical form is
2889 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2890
2891 Comments as to what is going on are written to the standard error file. These
2892 include lines beginning with &"LOG"& for anything that would have been logged.
2893 This facility is provided for testing configuration options for incoming
2894 messages, to make sure they implement the required policy. For example, you can
2895 test your relay controls using &%-bh%&.
2896
2897 &*Warning 1*&:
2898 .cindex "RFC 1413"
2899 You can test features of the configuration that rely on ident (RFC 1413)
2900 information by using the &%-oMt%& option. However, Exim cannot actually perform
2901 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2902 connection.
2903
2904 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2905 are also skipped when testing using &%-bh%&. If you want these callouts to
2906 occur, use &%-bhc%& instead.
2907
2908 Messages supplied during the testing session are discarded, and nothing is
2909 written to any of the real log files. There may be pauses when DNS (and other)
2910 lookups are taking place, and of course these may time out. The &%-oMi%& option
2911 can be used to specify a specific IP interface and port if this is important,
2912 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2913 session were authenticated.
2914
2915 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2916 output just states whether a given recipient address from a given host is
2917 acceptable or not. See section &<<SECTcheckaccess>>&.
2918
2919 Features such as authentication and encryption, where the client input is not
2920 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2921 specialized SMTP test program such as
2922 &url(http://jetmore.org/john/code/#swaks,swaks).
2923
2924 .vitem &%-bhc%&&~<&'IP&~address'&>
2925 .oindex "&%-bhc%&"
2926 This option operates in the same way as &%-bh%&, except that address
2927 verification callouts are performed if required. This includes consulting and
2928 updating the callout cache database.
2929
2930 .vitem &%-bi%&
2931 .oindex "&%-bi%&"
2932 .cindex "alias file" "building"
2933 .cindex "building alias file"
2934 .cindex "Sendmail compatibility" "&%-bi%& option"
2935 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2936 Exim does not have the concept of a single alias file, and so it cannot mimic
2937 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2938 tend to appear in various scripts such as NIS make files, so the option must be
2939 recognized.
2940
2941 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2942 configuration option is run, under the uid and gid of the caller of Exim. If
2943 the &%-oA%& option is used, its value is passed to the command as an argument.
2944 The command set by &%bi_command%& may not contain arguments. The command can
2945 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2946 if this is required. If the &%bi_command%& option is not set, calling Exim with
2947 &%-bi%& is a no-op.
2948
2949 .new
2950 . // Keep :help first, then the rest in alphabetical order
2951 .vitem &%-bI:help%&
2952 .oindex "&%-bI:help%&"
2953 .cindex "querying exim information"
2954 We shall provide various options starting &`-bI:`& for querying Exim for
2955 information.  The output of many of these will be intended for machine
2956 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2957 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2958 options shall cause Exim to exit after producing the requested output.
2959
2960 .vitem &%-bI:dscp%&
2961 .oindex "&%-bI:dscp%&"
2962 .cindex "DSCP" "values"
2963 This option causes Exim to emit an alphabetically sorted list of all
2964 recognised DSCP names.
2965
2966 .vitem &%-bI:sieve%&
2967 .oindex "&%-bI:sieve%&"
2968 .cindex "Sieve filter" "capabilities"
2969 This option causes Exim to emit an alphabetically sorted list of all supported
2970 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2971 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2972 &`SIEVE`& capability response line.  As the precise list may depend upon
2973 compile-time build options, which this option will adapt to, this is the only
2974 way to guarantee a correct response.
2975 .wen
2976
2977 .vitem &%-bm%&
2978 .oindex "&%-bm%&"
2979 .cindex "local message reception"
2980 This option runs an Exim receiving process that accepts an incoming,
2981 locally-generated message on the standard input. The recipients are given as the
2982 command arguments (except when &%-t%& is also present &-- see below). Each
2983 argument can be a comma-separated list of RFC 2822 addresses. This is the
2984 default option for selecting the overall action of an Exim call; it is assumed
2985 if no other conflicting option is present.
2986
2987 If any addresses in the message are unqualified (have no domain), they are
2988 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2989 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2990 suppressing this for special cases.
2991
2992 Policy checks on the contents of local messages can be enforced by means of
2993 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2994
2995 .cindex "return code" "for &%-bm%&"
2996 The return code is zero if the message is successfully accepted. Otherwise, the
2997 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2998
2999 The format
3000 .cindex "message" "format"
3001 .cindex "format" "message"
3002 .cindex "&""From""& line"
3003 .cindex "UUCP" "&""From""& line"
3004 .cindex "Sendmail compatibility" "&""From""& line"
3005 of the message must be as defined in RFC 2822, except that, for
3006 compatibility with Sendmail and Smail, a line in one of the forms
3007 .code
3008 From sender Fri Jan  5 12:55 GMT 1997
3009 From sender Fri, 5 Jan 97 12:55:01
3010 .endd
3011 (with the weekday optional, and possibly with additional text after the date)
3012 is permitted to appear at the start of the message. There appears to be no
3013 authoritative specification of the format of this line. Exim recognizes it by
3014 matching against the regular expression defined by the &%uucp_from_pattern%&
3015 option, which can be changed if necessary.
3016
3017 .oindex "&%-f%&" "overriding &""From""& line"
3018 The specified sender is treated as if it were given as the argument to the
3019 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3020 preference to the address taken from the message. The caller of Exim must be a
3021 trusted user for the sender of a message to be set in this way.
3022
3023 .vitem &%-bmalware%&&~<&'filename'&>
3024 .oindex "&%-bmalware%&"
3025 .cindex "testing", "malware"
3026 .cindex "malware scan test"
3027 This debugging option causes Exim to scan the given file,
3028 using the malware scanning framework.  The option of &%av_scanner%& influences
3029 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3030 the expansion should have defaults which apply to this invocation.  ACLs are
3031 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3032 will never be populated and &%-bmalware%& will fail.
3033
3034 Exim will have changed working directory before resolving the filename, so
3035 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3036 user when it tries to open the file, rather than as the invoking user.
3037 This option requires admin privileges.
3038
3039 The &%-bmalware%& option will not be extended to be more generally useful,
3040 there are better tools for file-scanning.  This option exists to help
3041 administrators verify their Exim and AV scanner configuration.
3042
3043 .vitem &%-bnq%&
3044 .oindex "&%-bnq%&"
3045 .cindex "address qualification, suppressing"
3046 By default, Exim automatically qualifies unqualified addresses (those
3047 without domains) that appear in messages that are submitted locally (that
3048 is, not over TCP/IP). This qualification applies both to addresses in
3049 envelopes, and addresses in header lines. Sender addresses are qualified using
3050 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3051 defaults to the value of &%qualify_domain%&).
3052
3053 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3054 being used to re-submit messages that originally came from remote hosts after
3055 content scanning, you probably do not want to qualify unqualified addresses in
3056 header lines. (Such lines will be present only if you have not enabled a header
3057 syntax check in the appropriate ACL.)
3058
3059 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3060 messages that originate on the local host. When this is used, unqualified
3061 addresses in the envelope provoke errors (causing message rejection) and
3062 unqualified addresses in header lines are left alone.
3063
3064
3065 .vitem &%-bP%&
3066 .oindex "&%-bP%&"
3067 .cindex "configuration options" "extracting"
3068 .cindex "options" "configuration &-- extracting"
3069 If this option is given with no arguments, it causes the values of all Exim's
3070 main configuration options to be written to the standard output. The values
3071 of one or more specific options can be requested by giving their names as
3072 arguments, for example:
3073 .code
3074 exim -bP qualify_domain hold_domains
3075 .endd
3076 .cindex "hiding configuration option values"
3077 .cindex "configuration options" "hiding value of"
3078 .cindex "options" "hiding value of"
3079 However, any option setting that is preceded by the word &"hide"& in the
3080 configuration file is not shown in full, except to an admin user. For other
3081 users, the output is as in this example:
3082 .code
3083 mysql_servers = <value not displayable>
3084 .endd
3085 If &%configure_file%& is given as an argument, the name of the run time
3086 configuration file is output.
3087 If a list of configuration files was supplied, the value that is output here
3088 is the name of the file that was actually used.
3089
3090 .new
3091 .cindex "options" "hiding name of"
3092 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3093 name will not be output.
3094 .wen
3095
3096 .cindex "daemon" "process id (pid)"
3097 .cindex "pid (process id)" "of daemon"
3098 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3099 directories where log files and daemon pid files are written are output,
3100 respectively. If these values are unset, log files are written in a
3101 sub-directory of the spool directory called &%log%&, and the pid file is
3102 written directly into the spool directory.
3103
3104 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3105 .code
3106 exim -bP +local_domains
3107 .endd
3108 it searches for a matching named list of any type (domain, host, address, or
3109 local part) and outputs what it finds.
3110
3111 .cindex "options" "router &-- extracting"
3112 .cindex "options" "transport &-- extracting"
3113 .cindex "options" "authenticator &-- extracting"
3114 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3115 followed by the name of an appropriate driver instance, the option settings for
3116 that driver are output. For example:
3117 .code
3118 exim -bP transport local_delivery
3119 .endd
3120 The generic driver options are output first, followed by the driver's private
3121 options. A list of the names of drivers of a particular type can be obtained by
3122 using one of the words &%router_list%&, &%transport_list%&, or
3123 &%authenticator_list%&, and a complete list of all drivers with their option
3124 settings can be obtained by using &%routers%&, &%transports%&, or
3125 &%authenticators%&.
3126
3127 .cindex "options" "macro &-- extracting"
3128 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3129 are available, similarly to the drivers.  Because macros are sometimes used
3130 for storing passwords, this option is restricted.
3131 The output format is one item per line.
3132
3133 .vitem &%-bp%&
3134 .oindex "&%-bp%&"
3135 .cindex "queue" "listing messages on"
3136 .cindex "listing" "messages on the queue"
3137 This option requests a listing of the contents of the mail queue on the
3138 standard output. If the &%-bp%& option is followed by a list of message ids,
3139 just those messages are listed. By default, this option can be used only by an
3140 admin user. However, the &%queue_list_requires_admin%& option can be set false
3141 to allow any user to see the queue.
3142
3143 Each message on the queue is displayed as in the following example:
3144 .code
3145 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3146           red.king@looking-glass.fict.example
3147           <other addresses>
3148 .endd
3149 .cindex "message" "size in queue listing"
3150 .cindex "size" "of message"
3151 The first line contains the length of time the message has been on the queue
3152 (in this case 25 minutes), the size of the message (2.9K), the unique local
3153 identifier for the message, and the message sender, as contained in the
3154 envelope. For bounce messages, the sender address is empty, and appears as
3155 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3156 the default sender address, the user's login name is shown in parentheses
3157 before the sender address.
3158
3159 .cindex "frozen messages" "in queue listing"
3160 If the message is frozen (attempts to deliver it are suspended) then the text
3161 &"*** frozen ***"& is displayed at the end of this line.
3162
3163 The recipients of the message (taken from the envelope, not the headers) are
3164 displayed on subsequent lines. Those addresses to which the message has already
3165 been delivered are marked with the letter D. If an original address gets
3166 expanded into several addresses via an alias or forward file, the original is
3167 displayed with a D only when deliveries for all of its child addresses are
3168 complete.
3169
3170
3171 .vitem &%-bpa%&
3172 .oindex "&%-bpa%&"
3173 This option operates like &%-bp%&, but in addition it shows delivered addresses
3174 that were generated from the original top level address(es) in each message by
3175 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3176 of just &"D"&.
3177
3178
3179 .vitem &%-bpc%&
3180 .oindex "&%-bpc%&"
3181 .cindex "queue" "count of messages on"
3182 This option counts the number of messages on the queue, and writes the total
3183 to the standard output. It is restricted to admin users, unless
3184 &%queue_list_requires_admin%& is set false.
3185
3186
3187 .vitem &%-bpr%&
3188 .oindex "&%-bpr%&"
3189 This option operates like &%-bp%&, but the output is not sorted into
3190 chronological order of message arrival. This can speed it up when there are
3191 lots of messages on the queue, and is particularly useful if the output is
3192 going to be post-processed in a way that doesn't need the sorting.
3193
3194 .vitem &%-bpra%&
3195 .oindex "&%-bpra%&"
3196 This option is a combination of &%-bpr%& and &%-bpa%&.
3197
3198 .vitem &%-bpru%&
3199 .oindex "&%-bpru%&"
3200 This option is a combination of &%-bpr%& and &%-bpu%&.
3201
3202
3203 .vitem &%-bpu%&
3204 .oindex "&%-bpu%&"
3205 This option operates like &%-bp%& but shows only undelivered top-level
3206 addresses for each message displayed. Addresses generated by aliasing or
3207 forwarding are not shown, unless the message was deferred after processing by a
3208 router with the &%one_time%& option set.
3209
3210
3211 .vitem &%-brt%&
3212 .oindex "&%-brt%&"
3213 .cindex "testing" "retry configuration"
3214 .cindex "retry" "configuration testing"
3215 This option is for testing retry rules, and it must be followed by up to three
3216 arguments. It causes Exim to look for a retry rule that matches the values
3217 and to write it to the standard output. For example:
3218 .code
3219 exim -brt bach.comp.mus.example
3220 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3221 .endd
3222 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3223 argument, which is required, can be a complete address in the form
3224 &'local_part@domain'&, or it can be just a domain name. If the second argument
3225 contains a dot, it is interpreted as an optional second domain name; if no
3226 retry rule is found for the first argument, the second is tried. This ties in
3227 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3228 rule is found that matches the host, one that matches the mail domain is
3229 sought. Finally, an argument that is the name of a specific delivery error, as
3230 used in setting up retry rules, can be given. For example:
3231 .code
3232 exim -brt haydn.comp.mus.example quota_3d
3233 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3234 .endd
3235
3236 .vitem &%-brw%&
3237 .oindex "&%-brw%&"
3238 .cindex "testing" "rewriting"
3239 .cindex "rewriting" "testing"
3240 This option is for testing address rewriting rules, and it must be followed by
3241 a single argument, consisting of either a local part without a domain, or a
3242 complete address with a fully qualified domain. Exim outputs how this address
3243 would be rewritten for each possible place it might appear. See chapter
3244 &<<CHAPrewrite>>& for further details.
3245
3246 .vitem &%-bS%&
3247 .oindex "&%-bS%&"
3248 .cindex "SMTP" "batched incoming"
3249 .cindex "batched SMTP input"
3250 This option is used for batched SMTP input, which is an alternative interface
3251 for non-interactive local message submission. A number of messages can be
3252 submitted in a single run. However, despite its name, this is not really SMTP
3253 input. Exim reads each message's envelope from SMTP commands on the standard
3254 input, but generates no responses. If the caller is trusted, or
3255 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3256 believed; otherwise the sender is always the caller of Exim.
3257
3258 The message itself is read from the standard input, in SMTP format (leading
3259 dots doubled), terminated by a line containing just a single dot. An error is
3260 provoked if the terminating dot is missing. A further message may then follow.
3261
3262 As for other local message submissions, the contents of incoming batch SMTP
3263 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3264 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3265 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3266
3267 Some other SMTP commands are recognized in the input. HELO and EHLO act
3268 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3269 QUIT quits, ignoring the rest of the standard input.
3270
3271 .cindex "return code" "for &%-bS%&"
3272 If any error is encountered, reports are written to the standard output and
3273 error streams, and Exim gives up immediately. The return code is 0 if no error
3274 was detected; it is 1 if one or more messages were accepted before the error
3275 was detected; otherwise it is 2.
3276
3277 More details of input using batched SMTP are given in section
3278 &<<SECTincomingbatchedSMTP>>&.
3279
3280 .vitem &%-bs%&
3281 .oindex "&%-bs%&"
3282 .cindex "SMTP" "local input"
3283 .cindex "local SMTP input"
3284 This option causes Exim to accept one or more messages by reading SMTP commands
3285 on the standard input, and producing SMTP replies on the standard output. SMTP
3286 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3287 Some user agents use this interface as a way of passing locally-generated
3288 messages to the MTA.
3289
3290 In
3291 .cindex "sender" "source of"
3292 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3293 set, the senders of messages are taken from the SMTP MAIL commands.
3294 Otherwise the content of these commands is ignored and the sender is set up as
3295 the calling user. Unqualified addresses are automatically qualified using
3296 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3297 &%-bnq%& option is used.
3298
3299 .cindex "inetd"
3300 The
3301 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3302 using a listening daemon. Exim can distinguish the two cases by checking
3303 whether the standard input is a TCP/IP socket. When Exim is called from
3304 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3305 above concerning senders and qualification do not apply. In this situation,
3306 Exim behaves in exactly the same way as it does when receiving a message via
3307 the listening daemon.
3308
3309 .vitem &%-bt%&
3310 .oindex "&%-bt%&"
3311 .cindex "testing" "addresses"
3312 .cindex "address" "testing"
3313 This option runs Exim in address testing mode, in which each argument is taken
3314 as a recipient address to be tested for deliverability. The results are
3315 written to the standard output. If a test fails, and the caller is not an admin
3316 user, no details of the failure are output, because these might contain
3317 sensitive information such as usernames and passwords for database lookups.
3318
3319 If no arguments are given, Exim runs in an interactive manner, prompting with a
3320 right angle bracket for addresses to be tested.
3321
3322 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3323 &[readline()]& function, because it is running as &'root'& and there are
3324 security issues.
3325
3326 Each address is handled as if it were the recipient address of a message
3327 (compare the &%-bv%& option). It is passed to the routers and the result is
3328 written to the standard output. However, any router that has
3329 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3330 genuine routing tests if your first router passes everything to a scanner
3331 program.
3332
3333 .cindex "return code" "for &%-bt%&"
3334 The return code is 2 if any address failed outright; it is 1 if no address
3335 failed outright but at least one could not be resolved for some reason. Return
3336 code 0 is given only when all addresses succeed.
3337
3338 .cindex "duplicate addresses"
3339 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3340 addresses after routing is complete, so that only one delivery takes place.
3341 This does not happen when testing with &%-bt%&; the full results of routing are
3342 always shown.
3343
3344 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3345 routers in the configuration makes any tests on the sender address of a
3346 message,
3347 .oindex "&%-f%&" "for address testing"
3348 you can use the &%-f%& option to set an appropriate sender when running
3349 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3350 default qualifying domain. However, if you have set up (for example) routers
3351 whose behaviour depends on the contents of an incoming message, you cannot test
3352 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3353 doing such tests.
3354
3355 .vitem &%-bV%&
3356 .oindex "&%-bV%&"
3357 .cindex "version number of Exim"
3358 This option causes Exim to write the current version number, compilation
3359 number, and compilation date of the &'exim'& binary to the standard output.
3360 It also lists the DBM library that is being used, the optional modules (such as
3361 specific lookup types), the drivers that are included in the binary, and the
3362 name of the run time configuration file that is in use.
3363
3364 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3365 configuration file. However, this is a static check only. It cannot check
3366 values that are to be expanded. For example, although a misspelt ACL verb is
3367 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3368 alone to discover (for example) all the typos in the configuration; some
3369 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3370 dynamic testing facilities.
3371
3372 .vitem &%-bv%&
3373 .oindex "&%-bv%&"
3374 .cindex "verifying address" "using &%-bv%&"
3375 .cindex "address" "verification"
3376 This option runs Exim in address verification mode, in which each argument is
3377 taken as a recipient address to be verified by the routers. (This does
3378 not involve any verification callouts). During normal operation, verification
3379 happens mostly as a consequence processing a &%verify%& condition in an ACL
3380 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3381 including callouts, see the &%-bh%& and &%-bhc%& options.
3382
3383 If verification fails, and the caller is not an admin user, no details of the
3384 failure are output, because these might contain sensitive information such as
3385 usernames and passwords for database lookups.
3386
3387 If no arguments are given, Exim runs in an interactive manner, prompting with a
3388 right angle bracket for addresses to be verified.
3389
3390 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3391 &[readline()]& function, because it is running as &'exim'& and there are
3392 security issues.
3393
3394 Verification differs from address testing (the &%-bt%& option) in that routers
3395 that have &%no_verify%& set are skipped, and if the address is accepted by a
3396 router that has &%fail_verify%& set, verification fails. The address is
3397 verified as a recipient if &%-bv%& is used; to test verification for a sender
3398 address, &%-bvs%& should be used.
3399
3400 If the &%-v%& option is not set, the output consists of a single line for each
3401 address, stating whether it was verified or not, and giving a reason in the
3402 latter case. Without &%-v%&, generating more than one address by redirection
3403 causes verification to end successfully, without considering the generated
3404 addresses. However, if just one address is generated, processing continues,
3405 and the generated address must verify successfully for the overall verification
3406 to succeed.
3407
3408 When &%-v%& is set, more details are given of how the address has been handled,
3409 and in the case of address redirection, all the generated addresses are also
3410 considered. Verification may succeed for some and fail for others.
3411
3412 The
3413 .cindex "return code" "for &%-bv%&"
3414 return code is 2 if any address failed outright; it is 1 if no address
3415 failed outright but at least one could not be resolved for some reason. Return
3416 code 0 is given only when all addresses succeed.
3417
3418 If any of the routers in the configuration makes any tests on the sender
3419 address of a message, you should use the &%-f%& option to set an appropriate
3420 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3421 calling user at the default qualifying domain.
3422
3423 .vitem &%-bvs%&
3424 .oindex "&%-bvs%&"
3425 This option acts like &%-bv%&, but verifies the address as a sender rather
3426 than a recipient address. This affects any rewriting and qualification that
3427 might happen.
3428
3429 .vitem &%-bw%&
3430 .oindex "&%-bw%&"
3431 .cindex "daemon"
3432 .cindex "inetd"
3433 .cindex "inetd" "wait mode"
3434 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3435 similarly to the &%-bd%& option.  All port specifications on the command-line
3436 and in the configuration file are ignored.  Queue-running may not be specified.
3437
3438 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3439 listening for connections.  This permits the system to start up and have
3440 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3441 each port only when the first connection is received.
3442
3443 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3444 which the daemon will exit, which should cause inetd to listen once more.
3445
3446 .vitem &%-C%&&~<&'filelist'&>
3447 .oindex "&%-C%&"
3448 .cindex "configuration file" "alternate"
3449 .cindex "CONFIGURE_FILE"
3450 .cindex "alternate configuration file"
3451 This option causes Exim to find the run time configuration file from the given
3452 list instead of from the list specified by the CONFIGURE_FILE
3453 compile-time setting. Usually, the list will consist of just a single file
3454 name, but it can be a colon-separated list of names. In this case, the first
3455 file that exists is used. Failure to open an existing file stops Exim from
3456 proceeding any further along the list, and an error is generated.
3457
3458 When this option is used by a caller other than root, and the list is different
3459 from the compiled-in list, Exim gives up its root privilege immediately, and
3460 runs with the real and effective uid and gid set to those of the caller.
3461 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3462 file contains a list of full pathnames, one per line, for configuration files
3463 which are trusted. Root privilege is retained for any configuration file so
3464 listed, as long as the caller is the Exim user (or the user specified in the
3465 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3466 not writeable by inappropriate users or groups.
3467
3468 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3469 configuration using &%-C%& right through message reception and delivery,
3470 even if the caller is root. The reception works, but by that time, Exim is
3471 running as the Exim user, so when it re-executes to regain privilege for the
3472 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3473 test reception and delivery using two separate commands (one to put a message
3474 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3475
3476 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3477 prefix string with which any file named in a &%-C%& command line option
3478 must start. In addition, the file name must not contain the sequence &`/../`&.
3479 However, if the value of the &%-C%& option is identical to the value of
3480 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3481 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3482 unset, any file name can be used with &%-C%&.
3483
3484 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3485 to a directory to which only root has access. This prevents someone who has
3486 broken into the Exim account from running a privileged Exim with an arbitrary
3487 configuration file.
3488
3489 The &%-C%& facility is useful for ensuring that configuration files are
3490 syntactically correct, but cannot be used for test deliveries, unless the
3491 caller is privileged, or unless it is an exotic configuration that does not
3492 require privilege. No check is made on the owner or group of the files
3493 specified by this option.
3494
3495
3496 .vitem &%-D%&<&'macro'&>=<&'value'&>
3497 .oindex "&%-D%&"
3498 .cindex "macro" "setting on command line"
3499 This option can be used to override macro definitions in the configuration file
3500 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3501 unprivileged caller, it causes Exim to give up its root privilege.
3502 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3503 completely disabled, and its use causes an immediate error exit.
3504
3505 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3506 colon-separated list of macros which are considered safe and, if &%-D%& only
3507 supplies macros from this list, and the values are acceptable, then Exim will
3508 not give up root privilege if the caller is root, the Exim run-time user, or
3509 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3510 to be removed in the future.  Acceptable values for the macros satisfy the
3511 regexp: &`^[A-Za-z0-9_/.-]*$`&
3512
3513 The entire option (including equals sign if present) must all be within one
3514 command line item. &%-D%& can be used to set the value of a macro to the empty
3515 string, in which case the equals sign is optional. These two commands are
3516 synonymous:
3517 .code
3518 exim -DABC  ...
3519 exim -DABC= ...
3520 .endd
3521 To include spaces in a macro definition item, quotes must be used. If you use
3522 quotes, spaces are permitted around the macro name and the equals sign. For
3523 example:
3524 .code
3525 exim '-D ABC = something' ...
3526 .endd
3527 &%-D%& may be repeated up to 10 times on a command line.
3528
3529
3530 .vitem &%-d%&<&'debug&~options'&>
3531 .oindex "&%-d%&"
3532 .cindex "debugging" "list of selectors"
3533 .cindex "debugging" "&%-d%& option"
3534 This option causes debugging information to be written to the standard
3535 error stream. It is restricted to admin users because debugging output may show
3536 database queries that contain password information. Also, the details of users'
3537 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3538 writes an error message to the standard error stream and exits with a non-zero
3539 return code.
3540
3541 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3542 standard debugging data is output. This can be reduced, or increased to include
3543 some more rarely needed information, by directly following &%-d%& with a string
3544 made up of names preceded by plus or minus characters. These add or remove sets
3545 of debugging data, respectively. For example, &%-d+filter%& adds filter
3546 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3547 no spaces are allowed in the debug setting. The available debugging categories
3548 are:
3549 .display
3550 &`acl            `& ACL interpretation
3551 &`auth           `& authenticators
3552 &`deliver        `& general delivery logic
3553 &`dns            `& DNS lookups (see also resolver)
3554 &`dnsbl          `& DNS black list (aka RBL) code
3555 &`exec           `& arguments for &[execv()]& calls
3556 &`expand         `& detailed debugging for string expansions
3557 &`filter         `& filter handling
3558 &`hints_lookup   `& hints data lookups
3559 &`host_lookup    `& all types of name-to-IP address handling
3560 &`ident          `& ident lookup
3561 &`interface      `& lists of local interfaces
3562 &`lists          `& matching things in lists
3563 &`load           `& system load checks
3564 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3565                     &<<CHAPlocalscan>>&)
3566 &`lookup         `& general lookup code and all lookups
3567 &`memory         `& memory handling
3568 &`pid            `& add pid to debug output lines
3569 &`process_info   `& setting info for the process log
3570 &`queue_run      `& queue runs
3571 &`receive        `& general message reception logic
3572 &`resolver       `& turn on the DNS resolver's debugging output
3573 &`retry          `& retry handling
3574 &`rewrite        `& address rewriting
3575 &`route          `& address routing
3576 &`timestamp      `& add timestamp to debug output lines
3577 &`tls            `& TLS logic
3578 &`transport      `& transports
3579 &`uid            `& changes of uid/gid and looking up uid/gid
3580 &`verify         `& address verification logic
3581 &`all            `& almost all of the above (see below), and also &%-v%&
3582 .endd
3583 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3584 for &`-all`&. The reason for this is that &`+all`& is something that people
3585 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3586 is included, an awful lot of output that is very rarely of interest is
3587 generated, so it now has to be explicitly requested. However, &`-all`& does
3588 turn everything off.
3589
3590 .cindex "resolver, debugging output"
3591 .cindex "DNS resolver, debugging output"
3592 The &`resolver`& option produces output only if the DNS resolver was compiled
3593 with DEBUG enabled. This is not the case in some operating systems. Also,
3594 unfortunately, debugging output from the DNS resolver is written to stdout
3595 rather than stderr.
3596
3597 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3598 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3599 However, the &`pid`& selector is forced when debugging is turned on for a
3600 daemon, which then passes it on to any re-executed Exims. Exim also
3601 automatically adds the pid to debug lines when several remote deliveries are
3602 run in parallel.
3603
3604 The &`timestamp`& selector causes the current time to be inserted at the start
3605 of all debug output lines. This can be useful when trying to track down delays
3606 in processing.
3607
3608 If the &%debug_print%& option is set in any driver, it produces output whenever
3609 any debugging is selected, or if &%-v%& is used.
3610
3611 .vitem &%-dd%&<&'debug&~options'&>
3612 .oindex "&%-dd%&"
3613 This option behaves exactly like &%-d%& except when used on a command that
3614 starts a daemon process. In that case, debugging is turned off for the
3615 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3616 behaviour of the daemon without creating as much output as full debugging does.
3617
3618 .vitem &%-dropcr%&
3619 .oindex "&%-dropcr%&"
3620 This is an obsolete option that is now a no-op. It used to affect the way Exim
3621 handled CR and LF characters in incoming messages. What happens now is
3622 described in section &<<SECTlineendings>>&.
3623
3624 .vitem &%-E%&
3625 .oindex "&%-E%&"
3626 .cindex "bounce message" "generating"
3627 This option specifies that an incoming message is a locally-generated delivery
3628 failure report. It is used internally by Exim when handling delivery failures
3629 and is not intended for external use. Its only effect is to stop Exim
3630 generating certain messages to the postmaster, as otherwise message cascades
3631 could occur in some situations. As part of the same option, a message id may
3632 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3633 new message contains the id, following &"R="&, as a cross-reference.
3634
3635 .vitem &%-e%&&'x'&
3636 .oindex "&%-e%&&'x'&"
3637 There are a number of Sendmail options starting with &%-oe%& which seem to be
3638 called by various programs without the leading &%o%& in the option. For
3639 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3640 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3641
3642 .vitem &%-F%&&~<&'string'&>
3643 .oindex "&%-F%&"
3644 .cindex "sender" "name"
3645 .cindex "name" "of sender"
3646 This option sets the sender's full name for use when a locally-generated
3647 message is being accepted. In the absence of this option, the user's &'gecos'&
3648 entry from the password data is used. As users are generally permitted to alter
3649 their &'gecos'& entries, no security considerations are involved. White space
3650 between &%-F%& and the <&'string'&> is optional.
3651
3652 .vitem &%-f%&&~<&'address'&>
3653 .oindex "&%-f%&"
3654 .cindex "sender" "address"
3655 .cindex "address" "sender"
3656 .cindex "trusted users"
3657 .cindex "envelope sender"
3658 .cindex "user" "trusted"
3659 This option sets the address of the envelope sender of a locally-generated
3660 message (also known as the return path). The option can normally be used only
3661 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3662 users to use it.
3663
3664 Processes running as root or the Exim user are always trusted. Other
3665 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3666 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3667 of a local message is set to the caller's login name at the default qualify
3668 domain.
3669
3670 There is one exception to the restriction on the use of &%-f%&: an empty sender
3671 can be specified by any user, trusted or not, to create a message that can
3672 never provoke a bounce. An empty sender can be specified either as an empty
3673 string, or as a pair of angle brackets with nothing between them, as in these
3674 examples of shell commands:
3675 .code
3676 exim -f '<>' user@domain
3677 exim -f "" user@domain
3678 .endd
3679 In addition, the use of &%-f%& is not restricted when testing a filter file
3680 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3681 &%-bv%& options.
3682
3683 Allowing untrusted users to change the sender address does not of itself make
3684 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3685 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3686 though this can be overridden by setting &%no_local_from_check%&.
3687
3688 White
3689 .cindex "&""From""& line"
3690 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3691 given as two arguments or one combined argument). The sender of a
3692 locally-generated message can also be set (when permitted) by an initial
3693 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3694 if &%-f%& is also present, it overrides &"From&~"&.
3695
3696 .vitem &%-G%&
3697 .oindex "&%-G%&"
3698 .cindex "submission fixups, suppressing (command-line)"
3699 .new
3700 This option is equivalent to an ACL applying:
3701 .code
3702 control = suppress_local_fixups
3703 .endd
3704 for every message received.  Note that Sendmail will complain about such
3705 bad formatting, where Exim silently just does not fix it up.  This may change
3706 in future.
3707
3708 As this affects audit information, the caller must be a trusted user to use
3709 this option.
3710 .wen
3711
3712 .vitem &%-h%&&~<&'number'&>
3713 .oindex "&%-h%&"
3714 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3715 This option is accepted for compatibility with Sendmail, but has no effect. (In
3716 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3717 headers.)
3718
3719 .vitem &%-i%&
3720 .oindex "&%-i%&"
3721 .cindex "Solaris" "&'mail'& command"
3722 .cindex "dot" "in incoming non-SMTP message"
3723 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3724 line by itself should not terminate an incoming, non-SMTP message. I can find
3725 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3726 command in Solaris 2.4 uses it. See also &%-ti%&.
3727
3728 .new
3729 .vitem &%-L%&&~<&'tag'&>
3730 .oindex "&%-L%&"
3731 .cindex "syslog" "process name; set with flag"
3732 This option is equivalent to setting &%syslog_processname%& in the config
3733 file and setting &%log_file_path%& to &`syslog`&.
3734 Its use is restricted to administrators.  The configuration file has to be
3735 read and parsed, to determine access rights, before this is set and takes
3736 effect, so early configuration file errors will not honour this flag.
3737
3738 The tag should not be longer than 32 characters.
3739 .wen
3740
3741 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3742 .oindex "&%-M%&"
3743 .cindex "forcing delivery"
3744 .cindex "delivery" "forcing attempt"
3745 .cindex "frozen messages" "forcing delivery"
3746 This option requests Exim to run a delivery attempt on each message in turn. If
3747 any of the messages are frozen, they are automatically thawed before the
3748 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3749 and &%hold_domains%& are ignored.
3750
3751 Retry
3752 .cindex "hints database" "overriding retry hints"
3753 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3754 the normal retry time has not yet been reached. This option requires the caller
3755 to be an admin user. However, there is an option called &%prod_requires_admin%&
3756 which can be set false to relax this restriction (and also the same requirement
3757 for the &%-q%&, &%-R%&, and &%-S%& options).
3758
3759 The deliveries happen synchronously, that is, the original Exim process does
3760 not terminate until all the delivery attempts have finished. No output is
3761 produced unless there is a serious error. If you want to see what is happening,
3762 use the &%-v%& option as well, or inspect Exim's main log.
3763
3764 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3765 .oindex "&%-Mar%&"
3766 .cindex "message" "adding recipients"
3767 .cindex "recipient" "adding"
3768 This option requests Exim to add the addresses to the list of recipients of the
3769 message (&"ar"& for &"add recipients"&). The first argument must be a message
3770 id, and the remaining ones must be email addresses. However, if the message is
3771 active (in the middle of a delivery attempt), it is not altered. This option
3772 can be used only by an admin user.
3773
3774 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3775         &~<&'message&~id'&>"
3776 .oindex "&%-MC%&"
3777 .cindex "SMTP" "passed connection"
3778 .cindex "SMTP" "multiple deliveries"
3779 .cindex "multiple SMTP deliveries"
3780 This option is not intended for use by external callers. It is used internally
3781 by Exim to invoke another instance of itself to deliver a waiting message using
3782 an existing SMTP connection, which is passed as the standard input. Details are
3783 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3784 must be root or the Exim user in order to use it.
3785
3786 .vitem &%-MCA%&
3787 .oindex "&%-MCA%&"
3788 This option is not intended for use by external callers. It is used internally
3789 by Exim in conjunction with the &%-MC%& option. It signifies that the
3790 connection to the remote host has been authenticated.
3791
3792 .vitem &%-MCP%&
3793 .oindex "&%-MCP%&"
3794 This option is not intended for use by external callers. It is used internally
3795 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3796 which Exim is connected supports pipelining.
3797
3798 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3799 .oindex "&%-MCQ%&"
3800 This option is not intended for use by external callers. It is used internally
3801 by Exim in conjunction with the &%-MC%& option when the original delivery was
3802 started by a queue runner. It passes on the process id of the queue runner,
3803 together with the file descriptor number of an open pipe. Closure of the pipe
3804 signals the final completion of the sequence of processes that are passing
3805 messages through the same SMTP connection.
3806
3807 .vitem &%-MCS%&
3808 .oindex "&%-MCS%&"
3809 This option is not intended for use by external callers. It is used internally
3810 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3811 SMTP SIZE option should be used on messages delivered down the existing
3812 connection.
3813
3814 .vitem &%-MCT%&
3815 .oindex "&%-MCT%&"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3818 host to which Exim is connected supports TLS encryption.
3819
3820 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3821 .oindex "&%-Mc%&"
3822 .cindex "hints database" "not overridden by &%-Mc%&"
3823 .cindex "delivery" "manually started &-- not forced"
3824 This option requests Exim to run a delivery attempt on each message in turn,
3825 but unlike the &%-M%& option, it does check for retry hints, and respects any
3826 that are found. This option is not very useful to external callers. It is
3827 provided mainly for internal use by Exim when it needs to re-invoke itself in
3828 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3829 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3830 respects retry times and other options such as &%hold_domains%& that are
3831 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3832 If you want to run a specific delivery as if in a queue run, you should use
3833 &%-q%& with a message id argument. A distinction between queue run deliveries
3834 and other deliveries is made in one or two places.
3835
3836 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3837 .oindex "&%-Mes%&"
3838 .cindex "message" "changing sender"
3839 .cindex "sender" "changing"
3840 This option requests Exim to change the sender address in the message to the
3841 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3842 &"edit sender"&). There must be exactly two arguments. The first argument must
3843 be a message id, and the second one an email address. However, if the message
3844 is active (in the middle of a delivery attempt), its status is not altered.
3845 This option can be used only by an admin user.
3846
3847 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3848 .oindex "&%-Mf%&"
3849 .cindex "freezing messages"
3850 .cindex "message" "manually freezing"
3851 This option requests Exim to mark each listed message as &"frozen"&. This
3852 prevents any delivery attempts taking place until the message is &"thawed"&,
3853 either manually or as a result of the &%auto_thaw%& configuration option.
3854 However, if any of the messages are active (in the middle of a delivery
3855 attempt), their status is not altered. This option can be used only by an admin
3856 user.
3857
3858 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3859 .oindex "&%-Mg%&"
3860 .cindex "giving up on messages"
3861 .cindex "message" "abandoning delivery attempts"
3862 .cindex "delivery" "abandoning further attempts"
3863 This option requests Exim to give up trying to deliver the listed messages,
3864 including any that are frozen. However, if any of the messages are active,
3865 their status is not altered. For non-bounce messages, a delivery error message
3866 is sent to the sender, containing the text &"cancelled by administrator"&.
3867 Bounce messages are just discarded. This option can be used only by an admin
3868 user.
3869
3870 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3871 .oindex "&%-Mmad%&"
3872 .cindex "delivery" "cancelling all"
3873 This option requests Exim to mark all the recipient addresses in the messages
3874 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3875 message is active (in the middle of a delivery attempt), its status is not
3876 altered. This option can be used only by an admin user.
3877
3878 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3879 .oindex "&%-Mmd%&"
3880 .cindex "delivery" "cancelling by address"
3881 .cindex "recipient" "removing"
3882 .cindex "removing recipients"
3883 This option requests Exim to mark the given addresses as already delivered
3884 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3885 the remaining ones must be email addresses. These are matched to recipient
3886 addresses in the message in a case-sensitive manner. If the message is active
3887 (in the middle of a delivery attempt), its status is not altered. This option
3888 can be used only by an admin user.
3889
3890 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3891 .oindex "&%-Mrm%&"
3892 .cindex "removing messages"
3893 .cindex "abandoning mail"
3894 .cindex "message" "manually discarding"
3895 This option requests Exim to remove the given messages from the queue. No
3896 bounce messages are sent; each message is simply forgotten. However, if any of
3897 the messages are active, their status is not altered. This option can be used
3898 only by an admin user or by the user who originally caused the message to be
3899 placed on the queue.
3900
3901 .vitem &%-Mset%&&~<&'message&~id'&>
3902 .oindex "&%-Mset%&
3903 .cindex "testing" "string expansion"
3904 .cindex "expansion" "testing"
3905 This option is useful only in conjunction with &%-be%& (that is, when testing
3906 string expansions). Exim loads the given message from its spool before doing
3907 the test expansions, thus setting message-specific variables such as
3908 &$message_size$& and the header variables. The &$recipients$& variable is made
3909 available. This feature is provided to make it easier to test expansions that
3910 make use of these variables. However, this option can be used only by an admin
3911 user. See also &%-bem%&.
3912
3913 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3914 .oindex "&%-Mt%&"
3915 .cindex "thawing messages"
3916 .cindex "unfreezing messages"
3917 .cindex "frozen messages" "thawing"
3918 .cindex "message" "thawing frozen"
3919 This option requests Exim to &"thaw"& any of the listed messages that are
3920 &"frozen"&, so that delivery attempts can resume. However, if any of the
3921 messages are active, their status is not altered. This option can be used only
3922 by an admin user.
3923
3924 .vitem &%-Mvb%&&~<&'message&~id'&>
3925 .oindex "&%-Mvb%&"
3926 .cindex "listing" "message body"
3927 .cindex "message" "listing body of"
3928 This option causes the contents of the message body (-D) spool file to be
3929 written to the standard output. This option can be used only by an admin user.
3930
3931 .vitem &%-Mvc%&&~<&'message&~id'&>
3932 .oindex "&%-Mvc%&"
3933 .cindex "message" "listing in RFC 2822 format"
3934 .cindex "listing" "message in RFC 2822 format"
3935 This option causes a copy of the complete message (header lines plus body) to
3936 be written to the standard output in RFC 2822 format. This option can be used
3937 only by an admin user.
3938
3939 .vitem &%-Mvh%&&~<&'message&~id'&>
3940 .oindex "&%-Mvh%&"
3941 .cindex "listing" "message headers"
3942 .cindex "header lines" "listing"
3943 .cindex "message" "listing header lines"
3944 This option causes the contents of the message headers (-H) spool file to be
3945 written to the standard output. This option can be used only by an admin user.
3946
3947 .vitem &%-Mvl%&&~<&'message&~id'&>
3948 .oindex "&%-Mvl%&"
3949 .cindex "listing" "message log"
3950 .cindex "message" "listing message log"
3951 This option causes the contents of the message log spool file to be written to
3952 the standard output. This option can be used only by an admin user.
3953
3954 .vitem &%-m%&
3955 .oindex "&%-m%&"
3956 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3957 treats it that way too.
3958
3959 .vitem &%-N%&
3960 .oindex "&%-N%&"
3961 .cindex "debugging" "&%-N%& option"
3962 .cindex "debugging" "suppressing delivery"
3963 This is a debugging option that inhibits delivery of a message at the transport
3964 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3965 it just doesn't actually transport the message, but instead behaves as if it
3966 had successfully done so. However, it does not make any updates to the retry
3967 database, and the log entries for deliveries are flagged with &"*>"& rather
3968 than &"=>"&.
3969
3970 Because &%-N%& discards any message to which it applies, only root or the Exim
3971 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3972 words, an ordinary user can use it only when supplying an incoming message to
3973 which it will apply. Although transportation never fails when &%-N%& is set, an
3974 address may be deferred because of a configuration problem on a transport, or a
3975 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3976 the message, and applies to any subsequent delivery attempts that may happen
3977 for that message.
3978
3979 .vitem &%-n%&
3980 .oindex "&%-n%&"
3981 This option is interpreted by Sendmail to mean &"no aliasing"&.
3982 For normal modes of operation, it is ignored by Exim.
3983 When combined with &%-bP%& it suppresses the name of an option from being output.
3984
3985 .vitem &%-O%&&~<&'data'&>
3986 .oindex "&%-O%&"
3987 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3988 Exim.
3989
3990 .vitem &%-oA%&&~<&'file&~name'&>
3991 .oindex "&%-oA%&"
3992 .cindex "Sendmail compatibility" "&%-oA%& option"
3993 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3994 alternative alias file name. Exim handles &%-bi%& differently; see the
3995 description above.
3996
3997 .vitem &%-oB%&&~<&'n'&>
3998 .oindex "&%-oB%&"
3999 .cindex "SMTP" "passed connection"
4000 .cindex "SMTP" "multiple deliveries"
4001 .cindex "multiple SMTP deliveries"
4002 This is a debugging option which limits the maximum number of messages that can
4003 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4004 transport. If <&'n'&> is omitted, the limit is set to 1.
4005
4006 .vitem &%-odb%&
4007 .oindex "&%-odb%&"
4008 .cindex "background delivery"
4009 .cindex "delivery" "in the background"
4010 This option applies to all modes in which Exim accepts incoming messages,
4011 including the listening daemon. It requests &"background"& delivery of such
4012 messages, which means that the accepting process automatically starts a
4013 delivery process for each message received, but does not wait for the delivery
4014 processes to finish.
4015
4016 When all the messages have been received, the reception process exits,
4017 leaving the delivery processes to finish in their own time. The standard output
4018 and error streams are closed at the start of each delivery process.
4019 This is the default action if none of the &%-od%& options are present.
4020
4021 If one of the queueing options in the configuration file
4022 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4023 overrides it if &%queue_only_override%& is set true, which is the default
4024 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4025
4026 .vitem &%-odf%&
4027 .oindex "&%-odf%&"
4028 .cindex "foreground delivery"
4029 .cindex "delivery" "in the foreground"
4030 This option requests &"foreground"& (synchronous) delivery when Exim has
4031 accepted a locally-generated message. (For the daemon it is exactly the same as
4032 &%-odb%&.) A delivery process is automatically started to deliver the message,
4033 and Exim waits for it to complete before proceeding.
4034
4035 The original Exim reception process does not finish until the delivery
4036 process for the final message has ended. The standard error stream is left open
4037 during deliveries.
4038
4039 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4040 false and one of the queueing options in the configuration file is in effect.
4041
4042 If there is a temporary delivery error during foreground delivery, the
4043 message is left on the queue for later delivery, and the original reception
4044 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4045 restricted configuration that never queues messages.
4046
4047
4048 .vitem &%-odi%&
4049 .oindex "&%-odi%&"
4050 This option is synonymous with &%-odf%&. It is provided for compatibility with
4051 Sendmail.
4052
4053 .vitem &%-odq%&
4054 .oindex "&%-odq%&"
4055 .cindex "non-immediate delivery"
4056 .cindex "delivery" "suppressing immediate"
4057 .cindex "queueing incoming messages"
4058 This option applies to all modes in which Exim accepts incoming messages,
4059 including the listening daemon. It specifies that the accepting process should
4060 not automatically start a delivery process for each message received. Messages
4061 are placed on the queue, and remain there until a subsequent queue runner
4062 process encounters them. There are several configuration options (such as
4063 &%queue_only%&) that can be used to queue incoming messages under certain
4064 conditions. This option overrides all of them and also &%-odqs%&. It always
4065 forces queueing.
4066
4067 .vitem &%-odqs%&
4068 .oindex "&%-odqs%&"
4069 .cindex "SMTP" "delaying delivery"
4070 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4071 However, like &%-odb%& and &%-odi%&, this option has no effect if
4072 &%queue_only_override%& is false and one of the queueing options in the
4073 configuration file is in effect.
4074
4075 When &%-odqs%& does operate, a delivery process is started for each incoming
4076 message, in the background by default, but in the foreground if &%-odi%& is
4077 also present. The recipient addresses are routed, and local deliveries are done
4078 in the normal way. However, if any SMTP deliveries are required, they are not
4079 done at this time, so the message remains on the queue until a subsequent queue
4080 runner process encounters it. Because routing was done, Exim knows which
4081 messages are waiting for which hosts, and so a number of messages for the same
4082 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4083 configuration option has the same effect for specific domains. See also the
4084 &%-qq%& option.
4085
4086 .vitem &%-oee%&
4087 .oindex "&%-oee%&"
4088 .cindex "error" "reporting"
4089 If an error is detected while a non-SMTP message is being received (for
4090 example, a malformed address), the error is reported to the sender in a mail
4091 message.
4092
4093 .cindex "return code" "for &%-oee%&"
4094 Provided
4095 this error message is successfully sent, the Exim receiving process
4096 exits with a return code of zero. If not, the return code is 2 if the problem
4097 is that the original message has no recipients, or 1 for any other error.
4098 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4099
4100 .vitem &%-oem%&
4101 .oindex "&%-oem%&"
4102 .cindex "error" "reporting"
4103 .cindex "return code" "for &%-oem%&"
4104 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4105 return code, whether or not the error message was successfully sent.
4106 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4107
4108 .vitem &%-oep%&
4109 .oindex "&%-oep%&"
4110 .cindex "error" "reporting"
4111 If an error is detected while a non-SMTP message is being received, the
4112 error is reported by writing a message to the standard error file (stderr).
4113 .cindex "return code" "for &%-oep%&"
4114 The return code is 1 for all errors.
4115
4116 .vitem &%-oeq%&
4117 .oindex "&%-oeq%&"
4118 .cindex "error" "reporting"
4119 This option is supported for compatibility with Sendmail, but has the same
4120 effect as &%-oep%&.
4121
4122 .vitem &%-oew%&
4123 .oindex "&%-oew%&"
4124 .cindex "error" "reporting"
4125 This option is supported for compatibility with Sendmail, but has the same
4126 effect as &%-oem%&.
4127
4128 .vitem &%-oi%&
4129 .oindex "&%-oi%&"
4130 .cindex "dot" "in incoming non-SMTP message"
4131 This option, which has the same effect as &%-i%&, specifies that a dot on a
4132 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4133 single dot does terminate, though Exim does no special processing for other
4134 lines that start with a dot. This option is set by default if Exim is called as
4135 &'rmail'&. See also &%-ti%&.
4136
4137 .vitem &%-oitrue%&
4138 .oindex "&%-oitrue%&"
4139 This option is treated as synonymous with &%-oi%&.
4140
4141 .vitem &%-oMa%&&~<&'host&~address'&>
4142 .oindex "&%-oMa%&"
4143 .cindex "sender" "host address, specifying for local message"
4144 A number of options starting with &%-oM%& can be used to set values associated
4145 with remote hosts on locally-submitted messages (that is, messages not received
4146 over TCP/IP). These options can be used by any caller in conjunction with the
4147 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4148 other circumstances, they are ignored unless the caller is trusted.
4149
4150 The &%-oMa%& option sets the sender host address. This may include a port
4151 number at the end, after a full stop (period). For example:
4152 .code
4153 exim -bs -oMa 10.9.8.7.1234
4154 .endd
4155 An alternative syntax is to enclose the IP address in square brackets,
4156 followed by a colon and the port number:
4157 .code
4158 exim -bs -oMa [10.9.8.7]:1234
4159 .endd
4160 The IP address is placed in the &$sender_host_address$& variable, and the
4161 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4162 are present on the command line, the sender host IP address is taken from
4163 whichever one is last.
4164
4165 .vitem &%-oMaa%&&~<&'name'&>
4166 .oindex "&%-oMaa%&"
4167 .cindex "authentication" "name, specifying for local message"
4168 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4169 option sets the value of &$sender_host_authenticated$& (the authenticator
4170 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4171 This option can be used with &%-bh%& and &%-bs%& to set up an
4172 authenticated SMTP session without actually using the SMTP AUTH command.
4173
4174 .vitem &%-oMai%&&~<&'string'&>
4175 .oindex "&%-oMai%&"
4176 .cindex "authentication" "id, specifying for local message"
4177 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4178 option sets the value of &$authenticated_id$& (the id that was authenticated).
4179 This overrides the default value (the caller's login id, except with &%-bh%&,
4180 where there is no default) for messages from local sources. See chapter
4181 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4182
4183 .vitem &%-oMas%&&~<&'address'&>
4184 .oindex "&%-oMas%&"
4185 .cindex "authentication" "sender, specifying for local message"
4186 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4187 option sets the authenticated sender value in &$authenticated_sender$&. It
4188 overrides the sender address that is created from the caller's login id for
4189 messages from local sources, except when &%-bh%& is used, when there is no
4190 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4191 specified on a MAIL command overrides this value. See chapter
4192 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4193
4194 .vitem &%-oMi%&&~<&'interface&~address'&>
4195 .oindex "&%-oMi%&"
4196 .cindex "interface" "address, specifying for local message"
4197 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4198 option sets the IP interface address value. A port number may be included,
4199 using the same syntax as for &%-oMa%&. The interface address is placed in
4200 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4201
4202 .vitem &%-oMr%&&~<&'protocol&~name'&>
4203 .oindex "&%-oMr%&"
4204 .cindex "protocol, specifying for local message"
4205 .vindex "&$received_protocol$&"
4206 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4207 option sets the received protocol value that is stored in
4208 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4209 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4210 SMTP protocol names (see the description of &$received_protocol$& in section
4211 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4212 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4213 be set by &%-oMr%&.
4214
4215 .vitem &%-oMs%&&~<&'host&~name'&>
4216 .oindex "&%-oMs%&"
4217 .cindex "sender" "host name, specifying for local message"
4218 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4219 option sets the sender host name in &$sender_host_name$&. When this option is
4220 present, Exim does not attempt to look up a host name from an IP address; it
4221 uses the name it is given.
4222
4223 .vitem &%-oMt%&&~<&'ident&~string'&>
4224 .oindex "&%-oMt%&"
4225 .cindex "sender" "ident string, specifying for local message"
4226 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4227 option sets the sender ident value in &$sender_ident$&. The default setting for
4228 local callers is the login id of the calling process, except when &%-bh%& is
4229 used, when there is no default.
4230
4231 .vitem &%-om%&
4232 .oindex "&%-om%&"
4233 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4234 In Sendmail, this option means &"me too"&, indicating that the sender of a
4235 message should receive a copy of the message if the sender appears in an alias
4236 expansion. Exim always does this, so the option does nothing.
4237
4238 .vitem &%-oo%&
4239 .oindex "&%-oo%&"
4240 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4241 This option is ignored. In Sendmail it specifies &"old style headers"&,
4242 whatever that means.
4243
4244 .vitem &%-oP%&&~<&'path'&>
4245 .oindex "&%-oP%&"
4246 .cindex "pid (process id)" "of daemon"
4247 .cindex "daemon" "process id (pid)"
4248 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4249 value. The option specifies the file to which the process id of the daemon is
4250 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4251 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4252 because in those cases, the normal pid file is not used.
4253
4254 .vitem &%-or%&&~<&'time'&>
4255 .oindex "&%-or%&"
4256 .cindex "timeout" "for non-SMTP input"
4257 This option sets a timeout value for incoming non-SMTP messages. If it is not
4258 set, Exim will wait forever for the standard input. The value can also be set
4259 by the &%receive_timeout%& option. The format used for specifying times is
4260 described in section &<<SECTtimeformat>>&.
4261
4262 .vitem &%-os%&&~<&'time'&>
4263 .oindex "&%-os%&"
4264 .cindex "timeout" "for SMTP input"
4265 .cindex "SMTP" "input timeout"
4266 This option sets a timeout value for incoming SMTP messages. The timeout
4267 applies to each SMTP command and block of data. The value can also be set by
4268 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4269 for specifying times is described in section &<<SECTtimeformat>>&.
4270
4271 .vitem &%-ov%&
4272 .oindex "&%-ov%&"
4273 This option has exactly the same effect as &%-v%&.
4274
4275 .vitem &%-oX%&&~<&'number&~or&~string'&>
4276 .oindex "&%-oX%&"
4277 .cindex "TCP/IP" "setting listening ports"
4278 .cindex "TCP/IP" "setting listening interfaces"
4279 .cindex "port" "receiving TCP/IP"
4280 This option is relevant only when the &%-bd%& (start listening daemon) option
4281 is also given. It controls which ports and interfaces the daemon uses. Details
4282 of the syntax, and how it interacts with configuration file options, are given
4283 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4284 file is written unless &%-oP%& is also present to specify a pid file name.
4285
4286 .vitem &%-pd%&
4287 .oindex "&%-pd%&"
4288 .cindex "Perl" "starting the interpreter"
4289 This option applies when an embedded Perl interpreter is linked with Exim (see
4290 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4291 option, forcing the starting of the interpreter to be delayed until it is
4292 needed.
4293
4294 .vitem &%-ps%&
4295 .oindex "&%-ps%&"
4296 .cindex "Perl" "starting the interpreter"
4297 This option applies when an embedded Perl interpreter is linked with Exim (see
4298 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4299 option, forcing the starting of the interpreter to occur as soon as Exim is
4300 started.
4301
4302 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4303 .oindex "&%-p%&"
4304 For compatibility with Sendmail, this option is equivalent to
4305 .display
4306 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4307 .endd
4308 It sets the incoming protocol and host name (for trusted callers). The
4309 host name and its colon can be omitted when only the protocol is to be set.
4310 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4311 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4312 or &`s`& using this option (but that does not seem a real limitation).
4313
4314 .vitem &%-q%&
4315 .oindex "&%-q%&"
4316 .cindex "queue runner" "starting manually"
4317 This option is normally restricted to admin users. However, there is a
4318 configuration option called &%prod_requires_admin%& which can be set false to
4319 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4320 and &%-S%& options).
4321
4322 .cindex "queue runner" "description of operation"
4323 The &%-q%& option starts one queue runner process. This scans the queue of
4324 waiting messages, and runs a delivery process for each one in turn. It waits
4325 for each delivery process to finish before starting the next one. A delivery
4326 process may not actually do any deliveries if the retry times for the addresses
4327 have not been reached. Use &%-qf%& (see below) if you want to override this.
4328
4329 If
4330 .cindex "SMTP" "passed connection"
4331 .cindex "SMTP" "multiple deliveries"
4332 .cindex "multiple SMTP deliveries"
4333 the delivery process spawns other processes to deliver other messages down
4334 passed SMTP connections, the queue runner waits for these to finish before
4335 proceeding.
4336
4337 When all the queued messages have been considered, the original queue runner
4338 process terminates. In other words, a single pass is made over the waiting
4339 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4340 this to be repeated periodically.
4341
4342 Exim processes the waiting messages in an unpredictable order. It isn't very
4343 random, but it is likely to be different each time, which is all that matters.
4344 If one particular message screws up a remote MTA, other messages to the same
4345 MTA have a chance of getting through if they get tried first.
4346
4347 It is possible to cause the messages to be processed in lexical message id
4348 order, which is essentially the order in which they arrived, by setting the
4349 &%queue_run_in_order%& option, but this is not recommended for normal use.
4350
4351 .vitem &%-q%&<&'qflags'&>
4352 The &%-q%& option may be followed by one or more flag letters that change its
4353 behaviour. They are all optional, but if more than one is present, they must
4354 appear in the correct order. Each flag is described in a separate item below.
4355
4356 .vitem &%-qq...%&
4357 .oindex "&%-qq%&"
4358 .cindex "queue" "double scanning"
4359 .cindex "queue" "routing"
4360 .cindex "routing" "whole queue before delivery"
4361 An option starting with &%-qq%& requests a two-stage queue run. In the first
4362 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4363 every domain. Addresses are routed, local deliveries happen, but no remote
4364 transports are run.
4365
4366 .cindex "hints database" "remembering routing"
4367 The hints database that remembers which messages are waiting for specific hosts
4368 is updated, as if delivery to those hosts had been deferred. After this is
4369 complete, a second, normal queue scan happens, with routing and delivery taking
4370 place as normal. Messages that are routed to the same host should mostly be
4371 delivered down a single SMTP
4372 .cindex "SMTP" "passed connection"
4373 .cindex "SMTP" "multiple deliveries"
4374 .cindex "multiple SMTP deliveries"
4375 connection because of the hints that were set up during the first queue scan.
4376 This option may be useful for hosts that are connected to the Internet
4377 intermittently.
4378
4379 .vitem &%-q[q]i...%&
4380 .oindex "&%-qi%&"
4381 .cindex "queue" "initial delivery"
4382 If the &'i'& flag is present, the queue runner runs delivery processes only for
4383 those messages that haven't previously been tried. (&'i'& stands for &"initial
4384 delivery"&.) This can be helpful if you are putting messages on the queue using
4385 &%-odq%& and want a queue runner just to process the new messages.
4386
4387 .vitem &%-q[q][i]f...%&
4388 .oindex "&%-qf%&"
4389 .cindex "queue" "forcing delivery"
4390 .cindex "delivery" "forcing in queue run"
4391 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4392 message, whereas without &'f'& only those non-frozen addresses that have passed
4393 their retry times are tried.
4394
4395 .vitem &%-q[q][i]ff...%&
4396 .oindex "&%-qff%&"
4397 .cindex "frozen messages" "forcing delivery"
4398 If &'ff'& is present, a delivery attempt is forced for every message, whether
4399 frozen or not.
4400
4401 .vitem &%-q[q][i][f[f]]l%&
4402 .oindex "&%-ql%&"
4403 .cindex "queue" "local deliveries only"
4404 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4405 be done. If a message requires any remote deliveries, it remains on the queue
4406 for later delivery.
4407
4408 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4409 .cindex "queue" "delivering specific messages"
4410 When scanning the queue, Exim can be made to skip over messages whose ids are
4411 lexically less than a given value by following the &%-q%& option with a
4412 starting message id. For example:
4413 .code
4414 exim -q 0t5C6f-0000c8-00
4415 .endd
4416 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4417 second message id is given, messages whose ids are lexically greater than it
4418 are also skipped. If the same id is given twice, for example,
4419 .code
4420 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4421 .endd
4422 just one delivery process is started, for that message. This differs from
4423 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4424 that it counts as a delivery from a queue run. Note that the selection
4425 mechanism does not affect the order in which the messages are scanned. There
4426 are also other ways of selecting specific sets of messages for delivery in a
4427 queue run &-- see &%-R%& and &%-S%&.
4428
4429 .vitem &%-q%&<&'qflags'&><&'time'&>
4430 .cindex "queue runner" "starting periodically"
4431 .cindex "periodic queue running"
4432 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4433 starting a queue runner process at intervals specified by the given time value
4434 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4435 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4436 single daemon process handles both functions. A common way of starting up a
4437 combined daemon at system boot time is to use a command such as
4438 .code
4439 /usr/exim/bin/exim -bd -q30m
4440 .endd
4441 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4442 process every 30 minutes.
4443
4444 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4445 pid file is written unless one is explicitly requested by the &%-oP%& option.
4446
4447 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4448 .oindex "&%-qR%&"
4449 This option is synonymous with &%-R%&. It is provided for Sendmail
4450 compatibility.
4451
4452 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4453 .oindex "&%-qS%&"
4454 This option is synonymous with &%-S%&.
4455
4456 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4457 .oindex "&%-R%&"
4458 .cindex "queue runner" "for specific recipients"
4459 .cindex "delivery" "to given domain"
4460 .cindex "domain" "delivery to"
4461 The <&'rsflags'&> may be empty, in which case the white space before the string
4462 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4463 which are the possible values for <&'rsflags'&>. White space is required if
4464 <&'rsflags'&> is not empty.
4465
4466 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4467 perform a single queue run, except that, when scanning the messages on the
4468 queue, Exim processes only those that have at least one undelivered recipient
4469 address containing the given string, which is checked in a case-independent
4470 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4471 regular expression; otherwise it is a literal string.
4472
4473 If you want to do periodic queue runs for messages with specific recipients,
4474 you can combine &%-R%& with &%-q%& and a time value. For example:
4475 .code
4476 exim -q25m -R @special.domain.example
4477 .endd
4478 This example does a queue run for messages with recipients in the given domain
4479 every 25 minutes. Any additional flags that are specified with &%-q%& are
4480 applied to each queue run.
4481
4482 Once a message is selected for delivery by this mechanism, all its addresses
4483 are processed. For the first selected message, Exim overrides any retry
4484 information and forces a delivery attempt for each undelivered address. This
4485 means that if delivery of any address in the first message is successful, any
4486 existing retry information is deleted, and so delivery attempts for that
4487 address in subsequently selected messages (which are processed without forcing)
4488 will run. However, if delivery of any address does not succeed, the retry
4489 information is updated, and in subsequently selected messages, the failing
4490 address will be skipped.
4491
4492 .cindex "frozen messages" "forcing delivery"
4493 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4494 all selected messages, not just the first; frozen messages are included when
4495 &'ff'& is present.
4496
4497 The &%-R%& option makes it straightforward to initiate delivery of all messages
4498 to a given domain after a host has been down for some time. When the SMTP
4499 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4500 effect is to run Exim with the &%-R%& option, but it can be configured to run
4501 an arbitrary command instead.
4502
4503 .vitem &%-r%&
4504 .oindex "&%-r%&"
4505 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4506
4507 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4508 .oindex "&%-S%&"
4509 .cindex "delivery" "from given sender"
4510 .cindex "queue runner" "for specific senders"
4511 This option acts like &%-R%& except that it checks the string against each
4512 message's sender instead of against the recipients. If &%-R%& is also set, both
4513 conditions must be met for a message to be selected. If either of the options
4514 has &'f'& or &'ff'& in its flags, the associated action is taken.
4515
4516 .vitem &%-Tqt%&&~<&'times'&>
4517 .oindex "&%-Tqt%&"
4518 This is an option that is exclusively for use by the Exim testing suite. It is not
4519 recognized when Exim is run normally. It allows for the setting up of explicit
4520 &"queue times"& so that various warning/retry features can be tested.
4521
4522 .vitem &%-t%&
4523 .oindex "&%-t%&"
4524 .cindex "recipient" "extracting from header lines"
4525 .cindex "&'Bcc:'& header line"
4526 .cindex "&'Cc:'& header line"
4527 .cindex "&'To:'& header line"
4528 When Exim is receiving a locally-generated, non-SMTP message on its standard
4529 input, the &%-t%& option causes the recipients of the message to be obtained
4530 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4531 from the command arguments. The addresses are extracted before any rewriting
4532 takes place and the &'Bcc:'& header line, if present, is then removed.
4533
4534 .cindex "Sendmail compatibility" "&%-t%& option"
4535 If the command has any arguments, they specify addresses to which the message
4536 is &'not'& to be delivered. That is, the argument addresses are removed from
4537 the recipients list obtained from the headers. This is compatible with Smail 3
4538 and in accordance with the documented behaviour of several versions of
4539 Sendmail, as described in man pages on a number of operating systems (e.g.
4540 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4541 argument addresses to those obtained from the headers, and the O'Reilly
4542 Sendmail book documents it that way. Exim can be made to add argument addresses
4543 instead of subtracting them by setting the option
4544 &%extract_addresses_remove_arguments%& false.
4545
4546 .cindex "&%Resent-%& header lines" "with &%-t%&"
4547 If there are any &%Resent-%& header lines in the message, Exim extracts
4548 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4549 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4550 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4551 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4552
4553 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4554 message is resent several times). The RFC also specifies that they should be
4555 added at the front of the message, and separated by &'Received:'& lines. It is
4556 not at all clear how &%-t%& should operate in the present of multiple sets,
4557 nor indeed exactly what constitutes a &"set"&.
4558 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4559 are often added at the end of the header, and if a message is resent more than
4560 once, it is common for the original set of &%Resent-%& headers to be renamed as
4561 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4562
4563 .vitem &%-ti%&
4564 .oindex "&%-ti%&"
4565 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4566 compatibility with Sendmail.
4567
4568 .vitem &%-tls-on-connect%&
4569 .oindex "&%-tls-on-connect%&"
4570 .cindex "TLS" "use without STARTTLS"
4571 .cindex "TLS" "automatic start"
4572 This option is available when Exim is compiled with TLS support. It forces all
4573 incoming SMTP connections to behave as if the incoming port is listed in the
4574 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4575 &<<CHAPTLS>>& for further details.
4576
4577
4578 .vitem &%-U%&
4579 .oindex "&%-U%&"
4580 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4581 Sendmail uses this option for &"initial message submission"&, and its
4582 documentation states that in future releases, it may complain about
4583 syntactically invalid messages rather than fixing them when this flag is not
4584 set. Exim ignores this option.
4585
4586 .vitem &%-v%&
4587 .oindex "&%-v%&"
4588 This option causes Exim to write information to the standard error stream,
4589 describing what it is doing. In particular, it shows the log lines for
4590 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4591 dialogue is shown. Some of the log lines shown may not actually be written to
4592 the log if the setting of &%log_selector%& discards them. Any relevant
4593 selectors are shown with each log line. If none are shown, the logging is
4594 unconditional.
4595
4596 .vitem &%-x%&
4597 .oindex "&%-x%&"
4598 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4599 National Language Support extended characters in the body of the mail item"&).
4600 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4601 this option.
4602
4603 .new
4604 .vitem &%-X%&&~<&'logfile'&>
4605 .oindex "&%-X%&"
4606 This option is interpreted by Sendmail to cause debug information to be sent
4607 to the named file.  It is ignored by Exim.
4608 .wen
4609 .endlist
4610
4611 .ecindex IIDclo1
4612 .ecindex IIDclo2
4613
4614
4615 . ////////////////////////////////////////////////////////////////////////////
4616 . Insert a stylized DocBook comment here, to identify the end of the command
4617 . line options. This is for the benefit of the Perl script that automatically
4618 . creates a man page for the options.
4619 . ////////////////////////////////////////////////////////////////////////////
4620
4621 .literal xml
4622 <!-- === End of command line options === -->
4623 .literal off
4624
4625
4626
4627
4628
4629 . ////////////////////////////////////////////////////////////////////////////
4630 . ////////////////////////////////////////////////////////////////////////////
4631
4632
4633 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4634          "The runtime configuration file"
4635
4636 .cindex "run time configuration"
4637 .cindex "configuration file" "general description"
4638 .cindex "CONFIGURE_FILE"
4639 .cindex "configuration file" "errors in"
4640 .cindex "error" "in configuration file"
4641 .cindex "return code" "for bad configuration"
4642 Exim uses a single run time configuration file that is read whenever an Exim
4643 binary is executed. Note that in normal operation, this happens frequently,
4644 because Exim is designed to operate in a distributed manner, without central
4645 control.
4646
4647 If a syntax error is detected while reading the configuration file, Exim
4648 writes a message on the standard error, and exits with a non-zero return code.
4649 The message is also written to the panic log. &*Note*&: Only simple syntax
4650 errors can be detected at this time. The values of any expanded options are
4651 not checked until the expansion happens, even when the expansion does not
4652 actually alter the string.
4653
4654 The name of the configuration file is compiled into the binary for security
4655 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4656 most configurations, this specifies a single file. However, it is permitted to
4657 give a colon-separated list of file names, in which case Exim uses the first
4658 existing file in the list.
4659
4660 .cindex "EXIM_USER"
4661 .cindex "EXIM_GROUP"
4662 .cindex "CONFIGURE_OWNER"
4663 .cindex "CONFIGURE_GROUP"
4664 .cindex "configuration file" "ownership"
4665 .cindex "ownership" "configuration file"
4666 The run time configuration file must be owned by root or by the user that is
4667 specified at compile time by the CONFIGURE_OWNER option (if set). The
4668 configuration file must not be world-writeable, or group-writeable unless its
4669 group is the root group or the one specified at compile time by the
4670 CONFIGURE_GROUP option.
4671
4672 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4673 to root, anybody who is able to edit the run time configuration file has an
4674 easy way to run commands as root. If you specify a user or group in the
4675 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4676 who are members of that group will trivially be able to obtain root privileges.
4677
4678 Up to Exim version 4.72, the run time configuration file was also permitted to
4679 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4680 since it offered a simple privilege escalation for any attacker who managed to
4681 compromise the Exim user account.
4682
4683 A default configuration file, which will work correctly in simple situations,
4684 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4685 defines just one file name, the installation process copies the default
4686 configuration to a new file of that name if it did not previously exist. If
4687 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4688 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4689 configuration.
4690
4691
4692
4693 .section "Using a different configuration file" "SECID40"
4694 .cindex "configuration file" "alternate"
4695 A one-off alternate configuration can be specified by the &%-C%& command line
4696 option, which may specify a single file or a list of files. However, when
4697 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4698 unless the argument for &%-C%& is identical to the built-in value from
4699 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4700 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4701 is useful mainly for checking the syntax of configuration files before
4702 installing them. No owner or group checks are done on a configuration file
4703 specified by &%-C%&, if root privilege has been dropped.
4704
4705 Even the Exim user is not trusted to specify an arbitrary configuration file
4706 with the &%-C%& option to be used with root privileges, unless that file is
4707 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4708 testing a configuration using &%-C%& right through message reception and
4709 delivery, even if the caller is root. The reception works, but by that time,
4710 Exim is running as the Exim user, so when it re-execs to regain privilege for
4711 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4712 can test reception and delivery using two separate commands (one to put a
4713 message on the queue, using &%-odq%&, and another to do the delivery, using
4714 &%-M%&).
4715
4716 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4717 prefix string with which any file named in a &%-C%& command line option must
4718 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4719 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4720 name can be used with &%-C%&.
4721
4722 One-off changes to a configuration can be specified by the &%-D%& command line
4723 option, which defines and overrides values for macros used inside the
4724 configuration file. However, like &%-C%&, the use of this option by a
4725 non-privileged user causes Exim to discard its root privilege.
4726 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4727 completely disabled, and its use causes an immediate error exit.
4728
4729 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4730 to declare certain macro names trusted, such that root privilege will not
4731 necessarily be discarded.
4732 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4733 considered safe and, if &%-D%& only supplies macros from this list, and the
4734 values are acceptable, then Exim will not give up root privilege if the caller
4735 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4736 transition mechanism and is expected to be removed in the future.  Acceptable
4737 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4738
4739 Some sites may wish to use the same Exim binary on different machines that
4740 share a file system, but to use different configuration files on each machine.
4741 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4742 looks for a file whose name is the configuration file name followed by a dot
4743 and the machine's node name, as obtained from the &[uname()]& function. If this
4744 file does not exist, the standard name is tried. This processing occurs for
4745 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4746
4747 In some esoteric situations different versions of Exim may be run under
4748 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4749 help with this. See the comments in &_src/EDITME_& for details.
4750
4751
4752
4753 .section "Configuration file format" "SECTconffilfor"
4754 .cindex "configuration file" "format of"
4755 .cindex "format" "configuration file"
4756 Exim's configuration file is divided into a number of different parts. General
4757 option settings must always appear at the start of the file. The other parts
4758 are all optional, and may appear in any order. Each part other than the first
4759 is introduced by the word &"begin"& followed by the name of the part. The
4760 optional parts are:
4761
4762 .ilist
4763 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4764 &<<CHAPACL>>&).
4765 .next
4766 .cindex "AUTH" "configuration"
4767 &'authenticators'&: Configuration settings for the authenticator drivers. These
4768 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4769 .next
4770 &'routers'&: Configuration settings for the router drivers. Routers process
4771 addresses and determine how the message is to be delivered (see chapters
4772 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4773 .next
4774 &'transports'&: Configuration settings for the transport drivers. Transports
4775 define mechanisms for copying messages to destinations (see chapters
4776 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4777 .next
4778 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4779 If there is no retry section, or if it is empty (that is, no retry rules are
4780 defined), Exim will not retry deliveries. In this situation, temporary errors
4781 are treated the same as permanent errors. Retry rules are discussed in chapter
4782 &<<CHAPretry>>&.
4783 .next
4784 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4785 when new addresses are generated during delivery. Rewriting is discussed in
4786 chapter &<<CHAPrewrite>>&.
4787 .next
4788 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4789 want to use this feature, you must set
4790 .code
4791 LOCAL_SCAN_HAS_OPTIONS=yes
4792 .endd
4793 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4794 facility are given in chapter &<<CHAPlocalscan>>&.
4795 .endlist
4796
4797 .cindex "configuration file" "leading white space in"
4798 .cindex "configuration file" "trailing white space in"
4799 .cindex "white space" "in configuration file"
4800 Leading and trailing white space in configuration lines is always ignored.
4801
4802 Blank lines in the file, and lines starting with a # character (ignoring
4803 leading white space) are treated as comments and are ignored. &*Note*&: A
4804 # character other than at the beginning of a line is not treated specially,
4805 and does not introduce a comment.
4806
4807 Any non-comment line can be continued by ending it with a backslash. Note that
4808 the general rule for white space means that trailing white space after the
4809 backslash and leading white space at the start of continuation
4810 lines is ignored. Comment lines beginning with # (but not empty lines) may
4811 appear in the middle of a sequence of continuation lines.
4812
4813 A convenient way to create a configuration file is to start from the
4814 default, which is supplied in &_src/configure.default_&, and add, delete, or
4815 change settings as required.
4816
4817 The ACLs, retry rules, and rewriting rules have their own syntax which is
4818 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4819 respectively. The other parts of the configuration file have some syntactic
4820 items in common, and these are described below, from section &<<SECTcos>>&
4821 onwards. Before that, the inclusion, macro, and conditional facilities are
4822 described.
4823
4824
4825
4826 .section "File inclusions in the configuration file" "SECID41"
4827 .cindex "inclusions in configuration file"
4828 .cindex "configuration file" "including other files"
4829 .cindex "&`.include`& in configuration file"
4830 .cindex "&`.include_if_exists`& in configuration file"
4831 You can include other files inside Exim's run time configuration file by
4832 using this syntax:
4833 .display
4834 &`.include`& <&'file name'&>
4835 &`.include_if_exists`& <&'file name'&>
4836 .endd
4837 on a line by itself. Double quotes round the file name are optional. If you use
4838 the first form, a configuration error occurs if the file does not exist; the
4839 second form does nothing for non-existent files. In all cases, an absolute file
4840 name is required.
4841
4842 Includes may be nested to any depth, but remember that Exim reads its
4843 configuration file often, so it is a good idea to keep them to a minimum.
4844 If you change the contents of an included file, you must HUP the daemon,
4845 because an included file is read only when the configuration itself is read.
4846
4847 The processing of inclusions happens early, at a physical line level, so, like
4848 comment lines, an inclusion can be used in the middle of an option setting,
4849 for example:
4850 .code
4851 hosts_lookup = a.b.c \
4852                .include /some/file
4853 .endd
4854 Include processing happens after macro processing (see below). Its effect is to
4855 process the lines of the included file as if they occurred inline where the
4856 inclusion appears.
4857
4858
4859
4860 .section "Macros in the configuration file" "SECTmacrodefs"
4861 .cindex "macro" "description of"
4862 .cindex "configuration file" "macros"
4863 If a line in the main part of the configuration (that is, before the first
4864 &"begin"& line) begins with an upper case letter, it is taken as a macro
4865 definition, and must be of the form
4866 .display
4867 <&'name'&> = <&'rest of line'&>
4868 .endd
4869 The name must consist of letters, digits, and underscores, and need not all be
4870 in upper case, though that is recommended. The rest of the line, including any
4871 continuations, is the replacement text, and has leading and trailing white
4872 space removed. Quotes are not removed. The replacement text can never end with
4873 a backslash character, but this doesn't seem to be a serious limitation.
4874
4875 Macros may also be defined between router, transport, authenticator, or ACL
4876 definitions. They may not, however, be defined within an individual driver or
4877 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4878
4879 .section "Macro substitution" "SECID42"
4880 Once a macro is defined, all subsequent lines in the file (and any included
4881 files) are scanned for the macro name; if there are several macros, the line is
4882 scanned for each in turn, in the order in which the macros are defined. The
4883 replacement text is not re-scanned for the current macro, though it is scanned
4884 for subsequently defined macros. For this reason, a macro name may not contain
4885 the name of a previously defined macro as a substring. You could, for example,
4886 define
4887 .display
4888 &`ABCD_XYZ = `&<&'something'&>
4889 &`ABCD = `&<&'something else'&>
4890 .endd
4891 but putting the definitions in the opposite order would provoke a configuration
4892 error. Macro expansion is applied to individual physical lines from the file,
4893 before checking for line continuation or file inclusion (see above). If a line
4894 consists solely of a macro name, and the expansion of the macro is empty, the
4895 line is ignored. A macro at the start of a line may turn the line into a
4896 comment line or a &`.include`& line.
4897
4898
4899 .section "Redefining macros" "SECID43"
4900 Once defined, the value of a macro can be redefined later in the configuration
4901 (or in an included file). Redefinition is specified by using &'=='& instead of
4902 &'='&. For example:
4903 .code
4904 MAC =  initial value
4905 ...
4906 MAC == updated value
4907 .endd
4908 Redefinition does not alter the order in which the macros are applied to the
4909 subsequent lines of the configuration file. It is still the same order in which
4910 the macros were originally defined. All that changes is the macro's value.
4911 Redefinition makes it possible to accumulate values. For example:
4912 .code
4913 MAC =  initial value
4914 ...
4915 MAC == MAC and something added
4916 .endd
4917 This can be helpful in situations where the configuration file is built
4918 from a number of other files.
4919
4920 .section "Overriding macro values" "SECID44"
4921 The values set for macros in the configuration file can be overridden by the
4922 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4923 used, unless called by root or the Exim user. A definition on the command line
4924 using the &%-D%& option causes all definitions and redefinitions within the
4925 file to be ignored.
4926
4927
4928
4929 .section "Example of macro usage" "SECID45"
4930 As an example of macro usage, consider a configuration where aliases are looked
4931 up in a MySQL database. It helps to keep the file less cluttered if long
4932 strings such as SQL statements are defined separately as macros, for example:
4933 .code
4934 ALIAS_QUERY = select mailbox from user where \
4935               login='${quote_mysql:$local_part}';
4936 .endd
4937 This can then be used in a &(redirect)& router setting like this:
4938 .code
4939 data = ${lookup mysql{ALIAS_QUERY}}
4940 .endd
4941 In earlier versions of Exim macros were sometimes used for domain, host, or
4942 address lists. In Exim 4 these are handled better by named lists &-- see
4943 section &<<SECTnamedlists>>&.
4944
4945
4946 .section "Conditional skips in the configuration file" "SECID46"
4947 .cindex "configuration file" "conditional skips"
4948 .cindex "&`.ifdef`&"
4949 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4950 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4951 portions of the configuration file. The processing happens whenever the file is
4952 read (that is, when an Exim binary starts to run).
4953
4954 The implementation is very simple. Instances of the first four directives must
4955 be followed by text that includes the names of one or macros. The condition
4956 that is tested is whether or not any macro substitution has taken place in the
4957 line. Thus:
4958 .code
4959 .ifdef AAA
4960 message_size_limit = 50M
4961 .else
4962 message_size_limit = 100M
4963 .endif
4964 .endd
4965 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4966 otherwise. If there is more than one macro named on the line, the condition
4967 is true if any of them are defined. That is, it is an &"or"& condition. To
4968 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4969
4970 Although you can use a macro expansion to generate one of these directives,
4971 it is not very useful, because the condition &"there was a macro substitution
4972 in this line"& will always be true.
4973
4974 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4975 to clarify complicated nestings.
4976
4977
4978
4979 .section "Common option syntax" "SECTcos"
4980 .cindex "common option syntax"
4981 .cindex "syntax of common options"
4982 .cindex "configuration file" "common option syntax"
4983 For the main set of options, driver options, and &[local_scan()]& options,
4984 each setting is on a line by itself, and starts with a name consisting of
4985 lower-case letters and underscores. Many options require a data value, and in
4986 these cases the name must be followed by an equals sign (with optional white
4987 space) and then the value. For example:
4988 .code
4989 qualify_domain = mydomain.example.com
4990 .endd
4991 .cindex "hiding configuration option values"
4992 .cindex "configuration options" "hiding value of"
4993 .cindex "options" "hiding value of"
4994 Some option settings may contain sensitive data, for example, passwords for
4995 accessing databases. To stop non-admin users from using the &%-bP%& command
4996 line option to read these values, you can precede the option settings with the
4997 word &"hide"&. For example:
4998 .code
4999 hide mysql_servers = localhost/users/admin/secret-password
5000 .endd
5001 For non-admin users, such options are displayed like this:
5002 .code
5003 mysql_servers = <value not displayable>
5004 .endd
5005 If &"hide"& is used on a driver option, it hides the value of that option on
5006 all instances of the same driver.
5007
5008 The following sections describe the syntax used for the different data types
5009 that are found in option settings.
5010
5011
5012 .section "Boolean options" "SECID47"
5013 .cindex "format" "boolean"
5014 .cindex "boolean configuration values"
5015 .oindex "&%no_%&&'xxx'&"
5016 .oindex "&%not_%&&'xxx'&"
5017 Options whose type is given as boolean are on/off switches. There are two
5018 different ways of specifying such options: with and without a data value. If
5019 the option name is specified on its own without data, the switch is turned on;
5020 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5021 boolean options may be followed by an equals sign and one of the words
5022 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5023 the following two settings have exactly the same effect:
5024 .code
5025 queue_only
5026 queue_only = true
5027 .endd
5028 The following two lines also have the same (opposite) effect:
5029 .code
5030 no_queue_only
5031 queue_only = false
5032 .endd
5033 You can use whichever syntax you prefer.
5034
5035
5036
5037
5038 .section "Integer values" "SECID48"
5039 .cindex "integer configuration values"
5040 .cindex "format" "integer"
5041 If an option's type is given as &"integer"&, the value can be given in decimal,
5042 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5043 number is assumed. Otherwise, it is treated as an octal number unless it starts
5044 with the characters &"0x"&, in which case the remainder is interpreted as a
5045 hexadecimal number.
5046
5047 If an integer value is followed by the letter K, it is multiplied by 1024; if
5048 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5049 of integer option settings are output, values which are an exact multiple of
5050 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5051 and M. The printing style is independent of the actual input format that was
5052 used.
5053
5054
5055 .section "Octal integer values" "SECID49"
5056 .cindex "integer format"
5057 .cindex "format" "octal integer"
5058 If an option's type is given as &"octal integer"&, its value is always
5059 interpreted as an octal number, whether or not it starts with the digit zero.
5060 Such options are always output in octal.
5061
5062
5063 .section "Fixed point numbers" "SECID50"
5064 .cindex "fixed point configuration values"
5065 .cindex "format" "fixed point"
5066 If an option's type is given as &"fixed-point"&, its value must be a decimal
5067 integer, optionally followed by a decimal point and up to three further digits.
5068
5069
5070
5071 .section "Time intervals" "SECTtimeformat"
5072 .cindex "time interval" "specifying in configuration"
5073 .cindex "format" "time interval"
5074 A time interval is specified as a sequence of numbers, each followed by one of
5075 the following letters, with no intervening white space:
5076
5077 .table2 30pt
5078 .irow &%s%& seconds
5079 .irow &%m%& minutes
5080 .irow &%h%& hours
5081 .irow &%d%& days
5082 .irow &%w%& weeks
5083 .endtable
5084
5085 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5086 intervals are output in the same format. Exim does not restrict the values; it
5087 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5088
5089
5090
5091 .section "String values" "SECTstrings"
5092 .cindex "string" "format of configuration values"
5093 .cindex "format" "string"
5094 If an option's type is specified as &"string"&, the value can be specified with
5095 or without double-quotes. If it does not start with a double-quote, the value
5096 consists of the remainder of the line plus any continuation lines, starting at
5097 the first character after any leading white space, with trailing white space
5098 removed, and with no interpretation of the characters in the string. Because
5099 Exim removes comment lines (those beginning with #) at an early stage, they can
5100 appear in the middle of a multi-line string. The following two settings are
5101 therefore equivalent:
5102 .code
5103 trusted_users = uucp:mail
5104 trusted_users = uucp:\
5105                 # This comment line is ignored
5106                 mail
5107 .endd
5108 .cindex "string" "quoted"
5109 .cindex "escape characters in quoted strings"
5110 If a string does start with a double-quote, it must end with a closing
5111 double-quote, and any backslash characters other than those used for line
5112 continuation are interpreted as escape characters, as follows:
5113
5114 .table2 100pt
5115 .irow &`\\`&                     "single backslash"
5116 .irow &`\n`&                     "newline"
5117 .irow &`\r`&                     "carriage return"
5118 .irow &`\t`&                     "tab"
5119 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5120 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5121                                    character"
5122 .endtable
5123
5124 If a backslash is followed by some other character, including a double-quote
5125 character, that character replaces the pair.
5126
5127 Quoting is necessary only if you want to make use of the backslash escapes to
5128 insert special characters, or if you need to specify a value with leading or
5129 trailing spaces. These cases are rare, so quoting is almost never needed in
5130 current versions of Exim. In versions of Exim before 3.14, quoting was required
5131 in order to continue lines, so you may come across older configuration files
5132 and examples that apparently quote unnecessarily.
5133
5134
5135 .section "Expanded strings" "SECID51"
5136 .cindex "expansion" "definition of"
5137 Some strings in the configuration file are subjected to &'string expansion'&,
5138 by which means various parts of the string may be changed according to the
5139 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5140 is as just described; in particular, the handling of backslashes in quoted
5141 strings is done as part of the input process, before expansion takes place.
5142 However, backslash is also an escape character for the expander, so any
5143 backslashes that are required for that reason must be doubled if they are
5144 within a quoted configuration string.
5145
5146
5147 .section "User and group names" "SECID52"
5148 .cindex "user name" "format of"
5149 .cindex "format" "user name"
5150 .cindex "groups" "name format"
5151 .cindex "format" "group name"
5152 User and group names are specified as strings, using the syntax described
5153 above, but the strings are interpreted specially. A user or group name must
5154 either consist entirely of digits, or be a name that can be looked up using the
5155 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5156
5157
5158 .section "List construction" "SECTlistconstruct"
5159 .cindex "list" "syntax of in configuration"
5160 .cindex "format" "list item in configuration"
5161 .cindex "string" "list, definition of"
5162 The data for some configuration options is a list of items, with colon as the
5163 default separator. Many of these options are shown with type &"string list"& in
5164 the descriptions later in this document. Others are listed as &"domain list"&,
5165 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5166 are all the same; however, those other than &"string list"& are subject to
5167 particular kinds of interpretation, as described in chapter
5168 &<<CHAPdomhosaddlists>>&.
5169
5170 In all these cases, the entire list is treated as a single string as far as the
5171 input syntax is concerned. The &%trusted_users%& setting in section
5172 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5173 in a list, it must be entered as two colons. Leading and trailing white space
5174 on each item in a list is ignored. This makes it possible to include items that
5175 start with a colon, and in particular, certain forms of IPv6 address. For
5176 example, the list
5177 .code
5178 local_interfaces = 127.0.0.1 : ::::1
5179 .endd
5180 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5181
5182 &*Note*&: Although leading and trailing white space is ignored in individual
5183 list items, it is not ignored when parsing the list. The space after the first
5184 colon in the example above is necessary. If it were not there, the list would
5185 be interpreted as the two items 127.0.0.1:: and 1.
5186
5187 .section "Changing list separators" "SECID53"
5188 .cindex "list separator" "changing"
5189 .cindex "IPv6" "addresses in lists"
5190 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5191 introduced to allow the separator character to be changed. If a list begins
5192 with a left angle bracket, followed by any punctuation character, that
5193 character is used instead of colon as the list separator. For example, the list
5194 above can be rewritten to use a semicolon separator like this:
5195 .code
5196 local_interfaces = <; 127.0.0.1 ; ::1
5197 .endd
5198 This facility applies to all lists, with the exception of the list in
5199 &%log_file_path%&. It is recommended that the use of non-colon separators be
5200 confined to circumstances where they really are needed.
5201
5202 .cindex "list separator" "newline as"
5203 .cindex "newline" "as list separator"
5204 It is also possible to use newline and other control characters (those with
5205 code values less than 32, plus DEL) as separators in lists. Such separators
5206 must be provided literally at the time the list is processed. For options that
5207 are string-expanded, you can write the separator using a normal escape
5208 sequence. This will be processed by the expander before the string is
5209 interpreted as a list. For example, if a newline-separated list of domains is
5210 generated by a lookup, you can process it directly by a line such as this:
5211 .code
5212 domains = <\n ${lookup mysql{.....}}
5213 .endd
5214 This avoids having to change the list separator in such data. You are unlikely
5215 to want to use a control character as a separator in an option that is not
5216 expanded, because the value is literal text. However, it can be done by giving
5217 the value in quotes. For example:
5218 .code
5219 local_interfaces = "<\n 127.0.0.1 \n ::1"
5220 .endd
5221 Unlike printing character separators, which can be included in list items by
5222 doubling, it is not possible to include a control character as data when it is
5223 set as the separator. Two such characters in succession are interpreted as
5224 enclosing an empty list item.
5225
5226
5227
5228 .section "Empty items in lists" "SECTempitelis"
5229 .cindex "list" "empty item in"
5230 An empty item at the end of a list is always ignored. In other words, trailing
5231 separator characters are ignored. Thus, the list in
5232 .code
5233 senders = user@domain :
5234 .endd
5235 contains only a single item. If you want to include an empty string as one item
5236 in a list, it must not be the last item. For example, this list contains three
5237 items, the second of which is empty:
5238 .code
5239 senders = user1@domain : : user2@domain
5240 .endd
5241 &*Note*&: There must be white space between the two colons, as otherwise they
5242 are interpreted as representing a single colon data character (and the list
5243 would then contain just one item). If you want to specify a list that contains
5244 just one, empty item, you can do it as in this example:
5245 .code
5246 senders = :
5247 .endd
5248 In this case, the first item is empty, and the second is discarded because it
5249 is at the end of the list.
5250
5251
5252
5253
5254 .section "Format of driver configurations" "SECTfordricon"
5255 .cindex "drivers" "configuration format"
5256 There are separate parts in the configuration for defining routers, transports,
5257 and authenticators. In each part, you are defining a number of driver
5258 instances, each with its own set of options. Each driver instance is defined by
5259 a sequence of lines like this:
5260 .display
5261 <&'instance name'&>:
5262   <&'option'&>
5263   ...
5264   <&'option'&>
5265 .endd
5266 In the following example, the instance name is &(localuser)&, and it is
5267 followed by three options settings:
5268 .code
5269 localuser:
5270   driver = accept
5271   check_local_user
5272   transport = local_delivery
5273 .endd
5274 For each driver instance, you specify which Exim code module it uses &-- by the
5275 setting of the &%driver%& option &-- and (optionally) some configuration
5276 settings. For example, in the case of transports, if you want a transport to
5277 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5278 a local file you would use the &(appendfile)& driver. Each of the drivers is
5279 described in detail in its own separate chapter later in this manual.
5280
5281 You can have several routers, transports, or authenticators that are based on
5282 the same underlying driver (each must have a different instance name).
5283
5284 The order in which routers are defined is important, because addresses are
5285 passed to individual routers one by one, in order. The order in which
5286 transports are defined does not matter at all. The order in which
5287 authenticators are defined is used only when Exim, as a client, is searching
5288 them to find one that matches an authentication mechanism offered by the
5289 server.
5290
5291 .cindex "generic options"
5292 .cindex "options" "generic &-- definition of"
5293 Within a driver instance definition, there are two kinds of option: &'generic'&
5294 and &'private'&. The generic options are those that apply to all drivers of the
5295 same type (that is, all routers, all transports or all authenticators). The
5296 &%driver%& option is a generic option that must appear in every definition.
5297 .cindex "private options"
5298 The private options are special for each driver, and none need appear, because
5299 they all have default values.
5300
5301 The options may appear in any order, except that the &%driver%& option must
5302 precede any private options, since these depend on the particular driver. For
5303 this reason, it is recommended that &%driver%& always be the first option.
5304
5305 Driver instance names, which are used for reference in log entries and
5306 elsewhere, can be any sequence of letters, digits, and underscores (starting
5307 with a letter) and must be unique among drivers of the same type. A router and
5308 a transport (for example) can each have the same name, but no two router
5309 instances can have the same name. The name of a driver instance should not be
5310 confused with the name of the underlying driver module. For example, the
5311 configuration lines:
5312 .code
5313 remote_smtp:
5314   driver = smtp
5315 .endd
5316 create an instance of the &(smtp)& transport driver whose name is
5317 &(remote_smtp)&. The same driver code can be used more than once, with
5318 different instance names and different option settings each time. A second
5319 instance of the &(smtp)& transport, with different options, might be defined
5320 thus:
5321 .code
5322 special_smtp:
5323   driver = smtp
5324   port = 1234
5325   command_timeout = 10s
5326 .endd
5327 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5328 these transport instances from routers, and these names would appear in log
5329 lines.
5330
5331 Comment lines may be present in the middle of driver specifications. The full
5332 list of option settings for any particular driver instance, including all the
5333 defaulted values, can be extracted by making use of the &%-bP%& command line
5334 option.
5335
5336
5337
5338
5339
5340
5341 . ////////////////////////////////////////////////////////////////////////////
5342 . ////////////////////////////////////////////////////////////////////////////
5343
5344 .chapter "The default configuration file" "CHAPdefconfil"
5345 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5346 .cindex "default" "configuration file &""walk through""&"
5347 The default configuration file supplied with Exim as &_src/configure.default_&
5348 is sufficient for a host with simple mail requirements. As an introduction to
5349 the way Exim is configured, this chapter &"walks through"& the default
5350 configuration, giving brief explanations of the settings. Detailed descriptions
5351 of the options are given in subsequent chapters. The default configuration file
5352 itself contains extensive comments about ways you might want to modify the
5353 initial settings. However, note that there are many options that are not
5354 mentioned at all in the default configuration.
5355
5356
5357
5358 .section "Main configuration settings" "SECTdefconfmain"
5359 The main (global) configuration option settings must always come first in the
5360 file. The first thing you'll see in the file, after some initial comments, is
5361 the line
5362 .code
5363 # primary_hostname =
5364 .endd
5365 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5366 to know the official, fully qualified name of your host, and this is where you
5367 can specify it. However, in most cases you do not need to set this option. When
5368 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5369
5370 The first three non-comment configuration lines are as follows:
5371 .code
5372 domainlist local_domains    = @
5373 domainlist relay_to_domains =
5374 hostlist   relay_from_hosts = 127.0.0.1
5375 .endd
5376 These are not, in fact, option settings. They are definitions of two named
5377 domain lists and one named host list. Exim allows you to give names to lists of
5378 domains, hosts, and email addresses, in order to make it easier to manage the
5379 configuration file (see section &<<SECTnamedlists>>&).
5380
5381 The first line defines a domain list called &'local_domains'&; this is used
5382 later in the configuration to identify domains that are to be delivered
5383 on the local host.
5384
5385 .cindex "@ in a domain list"
5386 There is just one item in this list, the string &"@"&. This is a special form
5387 of entry which means &"the name of the local host"&. Thus, if the local host is
5388 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5389 be delivered locally. Because the local host's name is referenced indirectly,
5390 the same configuration file can be used on different hosts.
5391
5392 The second line defines a domain list called &'relay_to_domains'&, but the
5393 list itself is empty. Later in the configuration we will come to the part that
5394 controls mail relaying through the local host; it allows relaying to any
5395 domains in this list. By default, therefore, no relaying on the basis of a mail
5396 domain is permitted.
5397
5398 The third line defines a host list called &'relay_from_hosts'&. This list is
5399 used later in the configuration to permit relaying from any host or IP address
5400 that matches the list. The default contains just the IP address of the IPv4
5401 loopback interface, which means that processes on the local host are able to
5402 submit mail for relaying by sending it over TCP/IP to that interface. No other
5403 hosts are permitted to submit messages for relaying.
5404
5405 Just to be sure there's no misunderstanding: at this point in the configuration
5406 we aren't actually setting up any controls. We are just defining some domains
5407 and hosts that will be used in the controls that are specified later.
5408
5409 The next two configuration lines are genuine option settings:
5410 .code
5411 acl_smtp_rcpt = acl_check_rcpt
5412 acl_smtp_data = acl_check_data
5413 .endd
5414 These options specify &'Access Control Lists'& (ACLs) that are to be used
5415 during an incoming SMTP session for every recipient of a message (every RCPT
5416 command), and after the contents of the message have been received,
5417 respectively. The names of the lists are &'acl_check_rcpt'& and
5418 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5419 section of the configuration. The RCPT ACL controls which recipients are
5420 accepted for an incoming message &-- if a configuration does not provide an ACL
5421 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5422 contents of a message to be checked.
5423
5424 Two commented-out option settings are next:
5425 .code
5426 # av_scanner = clamd:/tmp/clamd
5427 # spamd_address = 127.0.0.1 783
5428 .endd
5429 These are example settings that can be used when Exim is compiled with the
5430 content-scanning extension. The first specifies the interface to the virus
5431 scanner, and the second specifies the interface to SpamAssassin. Further
5432 details are given in chapter &<<CHAPexiscan>>&.
5433
5434 Three more commented-out option settings follow:
5435 .code
5436 # tls_advertise_hosts = *
5437 # tls_certificate = /etc/ssl/exim.crt
5438 # tls_privatekey = /etc/ssl/exim.pem
5439 .endd
5440 These are example settings that can be used when Exim is compiled with
5441 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5442 first one specifies the list of clients that are allowed to use TLS when
5443 connecting to this server; in this case the wildcard means all clients. The
5444 other options specify where Exim should find its TLS certificate and private
5445 key, which together prove the server's identity to any clients that connect.
5446 More details are given in chapter &<<CHAPTLS>>&.
5447
5448 Another two commented-out option settings follow:
5449 .code
5450 # daemon_smtp_ports = 25 : 465 : 587
5451 # tls_on_connect_ports = 465
5452 .endd
5453 .cindex "port" "465 and 587"
5454 .cindex "port" "for message submission"
5455 .cindex "message" "submission, ports for"
5456 .cindex "ssmtp protocol"
5457 .cindex "smtps protocol"
5458 .cindex "SMTP" "ssmtp protocol"
5459 .cindex "SMTP" "smtps protocol"
5460 These options provide better support for roaming users who wish to use this
5461 server for message submission. They are not much use unless you have turned on
5462 TLS (as described in the previous paragraph) and authentication (about which
5463 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5464 on end-user networks, so RFC 4409 specifies that message submission should use
5465 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5466 configured to use port 587 correctly, so these settings also enable the
5467 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5468 &<<SECTsupobssmt>>&).
5469
5470 Two more commented-out options settings follow:
5471 .code
5472 # qualify_domain =
5473 # qualify_recipient =
5474 .endd
5475 The first of these specifies a domain that Exim uses when it constructs a
5476 complete email address from a local login name. This is often needed when Exim
5477 receives a message from a local process. If you do not set &%qualify_domain%&,
5478 the value of &%primary_hostname%& is used. If you set both of these options,
5479 you can have different qualification domains for sender and recipient
5480 addresses. If you set only the first one, its value is used in both cases.
5481
5482 .cindex "domain literal" "recognizing format"
5483 The following line must be uncommented if you want Exim to recognize
5484 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5485 (an IP address within square brackets) instead of a named domain.
5486 .code
5487 # allow_domain_literals
5488 .endd
5489 The RFCs still require this form, but many people think that in the modern
5490 Internet it makes little sense to permit mail to be sent to specific hosts by
5491 quoting their IP addresses. This ancient format has been used by people who
5492 try to abuse hosts by using them for unwanted relaying. However, some
5493 people believe there are circumstances (for example, messages addressed to
5494 &'postmaster'&) where domain literals are still useful.
5495
5496 The next configuration line is a kind of trigger guard:
5497 .code
5498 never_users = root
5499 .endd
5500 It specifies that no delivery must ever be run as the root user. The normal
5501 convention is to set up &'root'& as an alias for the system administrator. This
5502 setting is a guard against slips in the configuration.
5503 The list of users specified by &%never_users%& is not, however, the complete
5504 list; the build-time configuration in &_Local/Makefile_& has an option called
5505 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5506 contents of &%never_users%& are added to this list. By default
5507 FIXED_NEVER_USERS also specifies root.
5508
5509 When a remote host connects to Exim in order to send mail, the only information
5510 Exim has about the host's identity is its IP address. The next configuration
5511 line,
5512 .code
5513 host_lookup = *
5514 .endd
5515 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5516 in order to get a host name. This improves the quality of the logging
5517 information, but if you feel it is too expensive, you can remove it entirely,
5518 or restrict the lookup to hosts on &"nearby"& networks.
5519 Note that it is not always possible to find a host name from an IP address,
5520 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5521 unreachable.
5522
5523 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5524 1413 (hence their names):
5525 .code
5526 rfc1413_hosts = *
5527 rfc1413_query_timeout = 5s
5528 .endd
5529 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5530 You can limit the hosts to which these calls are made, or change the timeout
5531 that is used. If you set the timeout to zero, all ident calls are disabled.
5532 Although they are cheap and can provide useful information for tracing problem
5533 messages, some hosts and firewalls have problems with ident calls. This can
5534 result in a timeout instead of an immediate refused connection, leading to
5535 delays on starting up an incoming SMTP session.
5536
5537 When Exim receives messages over SMTP connections, it expects all addresses to
5538 be fully qualified with a domain, as required by the SMTP definition. However,
5539 if you are running a server to which simple clients submit messages, you may
5540 find that they send unqualified addresses. The two commented-out options:
5541 .code
5542 # sender_unqualified_hosts =
5543 # recipient_unqualified_hosts =
5544 .endd
5545 show how you can specify hosts that are permitted to send unqualified sender
5546 and recipient addresses, respectively.
5547
5548 The &%percent_hack_domains%& option is also commented out:
5549 .code
5550 # percent_hack_domains =
5551 .endd
5552 It provides a list of domains for which the &"percent hack"& is to operate.
5553 This is an almost obsolete form of explicit email routing. If you do not know
5554 anything about it, you can safely ignore this topic.
5555
5556 The last two settings in the main part of the default configuration are
5557 concerned with messages that have been &"frozen"& on Exim's queue. When a
5558 message is frozen, Exim no longer continues to try to deliver it. Freezing
5559 occurs when a bounce message encounters a permanent failure because the sender
5560 address of the original message that caused the bounce is invalid, so the
5561 bounce cannot be delivered. This is probably the most common case, but there
5562 are also other conditions that cause freezing, and frozen messages are not
5563 always bounce messages.
5564 .code
5565 ignore_bounce_errors_after = 2d
5566 timeout_frozen_after = 7d
5567 .endd
5568 The first of these options specifies that failing bounce messages are to be
5569 discarded after 2 days on the queue. The second specifies that any frozen
5570 message (whether a bounce message or not) is to be timed out (and discarded)
5571 after a week. In this configuration, the first setting ensures that no failing
5572 bounce message ever lasts a week.
5573
5574
5575
5576 .section "ACL configuration" "SECID54"
5577 .cindex "default" "ACLs"
5578 .cindex "&ACL;" "default configuration"
5579 In the default configuration, the ACL section follows the main configuration.
5580 It starts with the line
5581 .code
5582 begin acl
5583 .endd
5584 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5585 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5586 and &%acl_smtp_data%& above.
5587
5588 .cindex "RCPT" "ACL for"
5589 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5590 RCPT command specifies one of the message's recipients. The ACL statements
5591 are considered in order, until the recipient address is either accepted or
5592 rejected. The RCPT command is then accepted or rejected, according to the
5593 result of the ACL processing.
5594 .code
5595 acl_check_rcpt:
5596 .endd
5597 This line, consisting of a name terminated by a colon, marks the start of the
5598 ACL, and names it.
5599 .code
5600 accept  hosts = :
5601 .endd
5602 This ACL statement accepts the recipient if the sending host matches the list.
5603 But what does that strange list mean? It doesn't actually contain any host
5604 names or IP addresses. The presence of the colon puts an empty item in the
5605 list; Exim matches this only if the incoming message did not come from a remote
5606 host, because in that case, the remote hostname is empty. The colon is
5607 important. Without it, the list itself is empty, and can never match anything.
5608
5609 What this statement is doing is to accept unconditionally all recipients in
5610 messages that are submitted by SMTP from local processes using the standard
5611 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5612 manner.
5613 .code
5614 deny    message       = Restricted characters in address
5615         domains       = +local_domains
5616         local_parts   = ^[.] : ^.*[@%!/|]
5617
5618 deny    message       = Restricted characters in address
5619         domains       = !+local_domains
5620         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5621 .endd
5622 These statements are concerned with local parts that contain any of the
5623 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5624 Although these characters are entirely legal in local parts (in the case of
5625 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5626 in Internet mail addresses.
5627
5628 The first three have in the past been associated with explicitly routed
5629 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5630 option). Addresses containing these characters are regularly tried by spammers
5631 in an attempt to bypass relaying restrictions, and also by open relay testing
5632 programs. Unless you really need them it is safest to reject these characters
5633 at this early stage. This configuration is heavy-handed in rejecting these
5634 characters for all messages it accepts from remote hosts. This is a deliberate
5635 policy of being as safe as possible.
5636
5637 The first rule above is stricter, and is applied to messages that are addressed
5638 to one of the local domains handled by this host. This is implemented by the
5639 first condition, which restricts it to domains that are listed in the
5640 &'local_domains'& domain list. The &"+"& character is used to indicate a
5641 reference to a named list. In this configuration, there is just one domain in
5642 &'local_domains'&, but in general there may be many.
5643
5644 The second condition on the first statement uses two regular expressions to
5645 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5646 or &"|"&. If you have local accounts that include these characters, you will
5647 have to modify this rule.
5648
5649 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5650 allows them because they have been encountered in practice. (Consider the
5651 common convention of local parts constructed as
5652 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5653 the author of Exim, who has no second initial.) However, a local part starting
5654 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5655 file name (for example, for a mailing list). This is also true for local parts
5656 that contain slashes. A pipe symbol can also be troublesome if the local part
5657 is incorporated unthinkingly into a shell command line.
5658
5659 The second rule above applies to all other domains, and is less strict. This
5660 allows your own users to send outgoing messages to sites that use slashes
5661 and vertical bars in their local parts. It blocks local parts that begin
5662 with a dot, slash, or vertical bar, but allows these characters within the
5663 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5664 and &"!"& is blocked, as before. The motivation here is to prevent your users
5665 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5666 .code
5667 accept  local_parts   = postmaster
5668         domains       = +local_domains
5669 .endd
5670 This statement, which has two conditions, accepts an incoming address if the
5671 local part is &'postmaster'& and the domain is one of those listed in the
5672 &'local_domains'& domain list. The &"+"& character is used to indicate a
5673 reference to a named list. In this configuration, there is just one domain in
5674 &'local_domains'&, but in general there may be many.
5675
5676 The presence of this statement means that mail to postmaster is never blocked
5677 by any of the subsequent tests. This can be helpful while sorting out problems
5678 in cases where the subsequent tests are incorrectly denying access.
5679 .code
5680 require verify        = sender
5681 .endd
5682 This statement requires the sender address to be verified before any subsequent
5683 ACL statement can be used. If verification fails, the incoming recipient
5684 address is refused. Verification consists of trying to route the address, to
5685 see if a bounce message could be delivered to it. In the case of remote
5686 addresses, basic verification checks only the domain, but &'callouts'& can be
5687 used for more verification if required. Section &<<SECTaddressverification>>&
5688 discusses the details of address verification.
5689 .code
5690 accept  hosts         = +relay_from_hosts
5691         control       = submission
5692 .endd
5693 This statement accepts the address if the message is coming from one of the
5694 hosts that are defined as being allowed to relay through this host. Recipient
5695 verification is omitted here, because in many cases the clients are dumb MUAs
5696 that do not cope well with SMTP error responses. For the same reason, the
5697 second line specifies &"submission mode"& for messages that are accepted. This
5698 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5699 messages that are deficient in some way, for example, because they lack a
5700 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5701 probably add recipient verification here, and disable submission mode.
5702 .code
5703 accept  authenticated = *
5704         control       = submission
5705 .endd
5706 This statement accepts the address if the client host has authenticated itself.
5707 Submission mode is again specified, on the grounds that such messages are most
5708 likely to come from MUAs. The default configuration does not define any
5709 authenticators, though it does include some nearly complete commented-out
5710 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5711 fact authenticate until you complete the authenticator definitions.
5712 .code
5713 require message = relay not permitted
5714         domains = +local_domains : +relay_to_domains
5715 .endd
5716 This statement rejects the address if its domain is neither a local domain nor
5717 one of the domains for which this host is a relay.
5718 .code
5719 require verify = recipient
5720 .endd
5721 This statement requires the recipient address to be verified; if verification
5722 fails, the address is rejected.
5723 .code
5724 # deny    message     = rejected because $sender_host_address \
5725 #                       is in a black list at $dnslist_domain\n\
5726 #                       $dnslist_text
5727 #         dnslists    = black.list.example
5728 #
5729 # warn    dnslists    = black.list.example
5730 #         add_header  = X-Warning: $sender_host_address is in \
5731 #                       a black list at $dnslist_domain
5732 #         log_message = found in $dnslist_domain
5733 .endd
5734 These commented-out lines are examples of how you could configure Exim to check
5735 sending hosts against a DNS black list. The first statement rejects messages
5736 from blacklisted hosts, whereas the second just inserts a warning header
5737 line.
5738 .code
5739 # require verify = csa
5740 .endd
5741 This commented-out line is an example of how you could turn on client SMTP
5742 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5743 records.
5744 .code
5745 accept
5746 .endd
5747 The final statement in the first ACL unconditionally accepts any recipient
5748 address that has successfully passed all the previous tests.
5749 .code
5750 acl_check_data:
5751 .endd
5752 This line marks the start of the second ACL, and names it. Most of the contents
5753 of this ACL are commented out:
5754 .code
5755 # deny    malware   = *
5756 #         message   = This message contains a virus \
5757 #                     ($malware_name).
5758 .endd
5759 These lines are examples of how to arrange for messages to be scanned for
5760 viruses when Exim has been compiled with the content-scanning extension, and a
5761 suitable virus scanner is installed. If the message is found to contain a
5762 virus, it is rejected with the given custom error message.
5763 .code
5764 # warn    spam      = nobody
5765 #         message   = X-Spam_score: $spam_score\n\
5766 #                     X-Spam_score_int: $spam_score_int\n\
5767 #                     X-Spam_bar: $spam_bar\n\
5768 #                     X-Spam_report: $spam_report
5769 .endd
5770 These lines are an example of how to arrange for messages to be scanned by
5771 SpamAssassin when Exim has been compiled with the content-scanning extension,
5772 and SpamAssassin has been installed. The SpamAssassin check is run with
5773 &`nobody`& as its user parameter, and the results are added to the message as a
5774 series of extra header line. In this case, the message is not rejected,
5775 whatever the spam score.
5776 .code
5777 accept
5778 .endd
5779 This final line in the DATA ACL accepts the message unconditionally.
5780
5781
5782 .section "Router configuration" "SECID55"
5783 .cindex "default" "routers"
5784 .cindex "routers" "default"
5785 The router configuration comes next in the default configuration, introduced
5786 by the line
5787 .code
5788 begin routers
5789 .endd
5790 Routers are the modules in Exim that make decisions about where to send
5791 messages. An address is passed to each router in turn, until it is either
5792 accepted, or failed. This means that the order in which you define the routers
5793 matters. Each router is fully described in its own chapter later in this
5794 manual. Here we give only brief overviews.
5795 .code
5796 # domain_literal:
5797 #   driver = ipliteral
5798 #   domains = !+local_domains
5799 #   transport = remote_smtp
5800 .endd
5801 .cindex "domain literal" "default router"
5802 This router is commented out because the majority of sites do not want to
5803 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5804 you uncomment this router, you also need to uncomment the setting of
5805 &%allow_domain_literals%& in the main part of the configuration.
5806 .code
5807 dnslookup:
5808   driver = dnslookup
5809   domains = ! +local_domains
5810   transport = remote_smtp
5811   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5812   no_more
5813 .endd
5814 The first uncommented router handles addresses that do not involve any local
5815 domains. This is specified by the line
5816 .code
5817 domains = ! +local_domains
5818 .endd
5819 The &%domains%& option lists the domains to which this router applies, but the
5820 exclamation mark is a negation sign, so the router is used only for domains
5821 that are not in the domain list called &'local_domains'& (which was defined at
5822 the start of the configuration). The plus sign before &'local_domains'&
5823 indicates that it is referring to a named list. Addresses in other domains are
5824 passed on to the following routers.
5825
5826 The name of the router driver is &(dnslookup)&,
5827 and is specified by the &%driver%& option. Do not be confused by the fact that
5828 the name of this router instance is the same as the name of the driver. The
5829 instance name is arbitrary, but the name set in the &%driver%& option must be
5830 one of the driver modules that is in the Exim binary.
5831
5832 The &(dnslookup)& router routes addresses by looking up their domains in the
5833 DNS in order to obtain a list of hosts to which the address is routed. If the
5834 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5835 specified by the &%transport%& option. If the router does not find the domain
5836 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5837 the address fails and is bounced.
5838
5839 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5840 be entirely ignored. This option is present because a number of cases have been
5841 encountered where MX records in the DNS point to host names
5842 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5843 Completely ignoring these IP addresses causes Exim to fail to route the
5844 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5845 continue to try to deliver the message periodically until the address timed
5846 out.
5847 .code
5848 system_aliases:
5849   driver = redirect
5850   allow_fail
5851   allow_defer
5852   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5853 # user = exim
5854   file_transport = address_file
5855   pipe_transport = address_pipe
5856 .endd
5857 Control reaches this and subsequent routers only for addresses in the local
5858 domains. This router checks to see whether the local part is defined as an
5859 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5860 data that it looks up from that file. If no data is found for the local part,
5861 the value of the &%data%& option is empty, causing the address to be passed to
5862 the next router.
5863
5864 &_/etc/aliases_& is a conventional name for the system aliases file that is
5865 often used. That is why it is referenced by from the default configuration
5866 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5867 &_Local/Makefile_& before building Exim.
5868 .code
5869 userforward:
5870   driver = redirect
5871   check_local_user
5872 # local_part_suffix = +* : -*
5873 # local_part_suffix_optional
5874   file = $home/.forward
5875 # allow_filter
5876   no_verify
5877   no_expn
5878   check_ancestor
5879   file_transport = address_file
5880   pipe_transport = address_pipe
5881   reply_transport = address_reply
5882 .endd
5883 This is the most complicated router in the default configuration. It is another
5884 redirection router, but this time it is looking for forwarding data set up by
5885 individual users. The &%check_local_user%& setting specifies a check that the
5886 local part of the address is the login name of a local user. If it is not, the
5887 router is skipped. The two commented options that follow &%check_local_user%&,
5888 namely:
5889 .code
5890 # local_part_suffix = +* : -*
5891 # local_part_suffix_optional
5892 .endd
5893 .vindex "&$local_part_suffix$&"
5894 show how you can specify the recognition of local part suffixes. If the first
5895 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5896 by any sequence of characters, is removed from the local part and placed in the
5897 variable &$local_part_suffix$&. The second suffix option specifies that the
5898 presence of a suffix in the local part is optional. When a suffix is present,
5899 the check for a local login uses the local part with the suffix removed.
5900
5901 When a local user account is found, the file called &_.forward_& in the user's
5902 home directory is consulted. If it does not exist, or is empty, the router
5903 declines. Otherwise, the contents of &_.forward_& are interpreted as
5904 redirection data (see chapter &<<CHAPredirect>>& for more details).
5905
5906 .cindex "Sieve filter" "enabling in default router"
5907 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5908 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5909 is commented out by default), the contents of the file are interpreted as a set
5910 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5911 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5912 separate document entitled &'Exim's interfaces to mail filtering'&.
5913
5914 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5915 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5916 There are two reasons for doing this:
5917
5918 .olist
5919 Whether or not a local user has a &_.forward_& file is not really relevant when
5920 checking an address for validity; it makes sense not to waste resources doing
5921 unnecessary work.
5922 .next
5923 More importantly, when Exim is verifying addresses or handling an EXPN
5924 command during an SMTP session, it is running as the Exim user, not as root.
5925 The group is the Exim group, and no additional groups are set up.
5926 It may therefore not be possible for Exim to read users' &_.forward_& files at
5927 this time.
5928 .endlist
5929
5930 The setting of &%check_ancestor%& prevents the router from generating a new
5931 address that is the same as any previous address that was redirected. (This
5932 works round a problem concerning a bad interaction between aliasing and
5933 forwarding &-- see section &<<SECTredlocmai>>&).
5934
5935 The final three option settings specify the transports that are to be used when
5936 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5937 auto-reply, respectively. For example, if a &_.forward_& file contains
5938 .code
5939 a.nother@elsewhere.example, /home/spqr/archive
5940 .endd
5941 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5942 transport.
5943 .code
5944 localuser:
5945   driver = accept
5946   check_local_user
5947 # local_part_suffix = +* : -*
5948 # local_part_suffix_optional
5949   transport = local_delivery
5950 .endd
5951 The final router sets up delivery into local mailboxes, provided that the local
5952 part is the name of a local login, by accepting the address and assigning it to
5953 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5954 routers, so the address is bounced. The commented suffix settings fulfil the
5955 same purpose as they do for the &(userforward)& router.
5956
5957
5958 .section "Transport configuration" "SECID56"
5959 .cindex "default" "transports"
5960 .cindex "transports" "default"
5961 Transports define mechanisms for actually delivering messages. They operate
5962 only when referenced from routers, so the order in which they are defined does
5963 not matter. The transports section of the configuration starts with
5964 .code
5965 begin transports
5966 .endd
5967 One remote transport and four local transports are defined.
5968 .code
5969 remote_smtp:
5970   driver = smtp
5971 .endd
5972 This transport is used for delivering messages over SMTP connections. All its
5973 options are defaulted. The list of remote hosts comes from the router.
5974 .code
5975 local_delivery:
5976   driver = appendfile
5977   file = /var/mail/$local_part
5978   delivery_date_add
5979   envelope_to_add
5980   return_path_add
5981 # group = mail
5982 # mode = 0660
5983 .endd
5984 This &(appendfile)& transport is used for local delivery to user mailboxes in
5985 traditional BSD mailbox format. By default it runs under the uid and gid of the
5986 local user, which requires the sticky bit to be set on the &_/var/mail_&
5987 directory. Some systems use the alternative approach of running mail deliveries
5988 under a particular group instead of using the sticky bit. The commented options
5989 show how this can be done.
5990
5991 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5992 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5993 similarly-named options above.
5994 .code
5995 address_pipe:
5996   driver = pipe
5997   return_output
5998 .endd
5999 This transport is used for handling deliveries to pipes that are generated by
6000 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6001 option specifies that any output generated by the pipe is to be returned to the
6002 sender.
6003 .code
6004 address_file:
6005   driver = appendfile
6006   delivery_date_add
6007   envelope_to_add
6008   return_path_add
6009 .endd
6010 This transport is used for handling deliveries to files that are generated by
6011 redirection. The name of the file is not specified in this instance of
6012 &(appendfile)&, because it comes from the &(redirect)& router.
6013 .code
6014 address_reply:
6015   driver = autoreply
6016 .endd
6017 This transport is used for handling automatic replies generated by users'
6018 filter files.
6019
6020
6021
6022 .section "Default retry rule" "SECID57"
6023 .cindex "retry" "default rule"
6024 .cindex "default" "retry rule"
6025 The retry section of the configuration file contains rules which affect the way
6026 Exim retries deliveries that cannot be completed at the first attempt. It is
6027 introduced by the line
6028 .code
6029 begin retry
6030 .endd
6031 In the default configuration, there is just one rule, which applies to all
6032 errors:
6033 .code
6034 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6035 .endd
6036 This causes any temporarily failing address to be retried every 15 minutes for
6037 2 hours, then at intervals starting at one hour and increasing by a factor of
6038 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6039 is not delivered after 4 days of temporary failure, it is bounced.
6040
6041 If the retry section is removed from the configuration, or is empty (that is,
6042 if no retry rules are defined), Exim will not retry deliveries. This turns
6043 temporary errors into permanent errors.
6044
6045
6046 .section "Rewriting configuration" "SECID58"
6047 The rewriting section of the configuration, introduced by
6048 .code
6049 begin rewrite
6050 .endd
6051 contains rules for rewriting addresses in messages as they arrive. There are no
6052 rewriting rules in the default configuration file.
6053
6054
6055
6056 .section "Authenticators configuration" "SECTdefconfauth"
6057 .cindex "AUTH" "configuration"
6058 The authenticators section of the configuration, introduced by
6059 .code
6060 begin authenticators
6061 .endd
6062 defines mechanisms for the use of the SMTP AUTH command. The default
6063 configuration file contains two commented-out example authenticators
6064 which support plaintext username/password authentication using the
6065 standard PLAIN mechanism and the traditional but non-standard LOGIN
6066 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6067 to support most MUA software.
6068
6069 The example PLAIN authenticator looks like this:
6070 .code
6071 #PLAIN:
6072 #  driver                  = plaintext
6073 #  server_set_id           = $auth2
6074 #  server_prompts          = :
6075 #  server_condition        = Authentication is not yet configured
6076 #  server_advertise_condition = ${if def:tls_in_cipher }
6077 .endd
6078 And the example LOGIN authenticator looks like this:
6079 .code
6080 #LOGIN:
6081 #  driver                  = plaintext
6082 #  server_set_id           = $auth1
6083 #  server_prompts          = <| Username: | Password:
6084 #  server_condition        = Authentication is not yet configured
6085 #  server_advertise_condition = ${if def:tls_in_cipher }
6086 .endd
6087
6088 The &%server_set_id%& option makes Exim remember the authenticated username
6089 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6090 &%server_prompts%& option configures the &(plaintext)& authenticator so
6091 that it implements the details of the specific authentication mechanism,
6092 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6093 when Exim offers authentication to clients; in the examples, this is only
6094 when TLS or SSL has been started, so to enable the authenticators you also
6095 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6096
6097 The &%server_condition%& setting defines how to verify that the username and
6098 password are correct. In the examples it just produces an error message.
6099 To make the authenticators work, you can use a string expansion
6100 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6101
6102 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6103 usercode and password are in different positions.
6104 Chapter &<<CHAPplaintext>>& covers both.
6105
6106 .ecindex IIDconfiwal
6107
6108
6109
6110 . ////////////////////////////////////////////////////////////////////////////
6111 . ////////////////////////////////////////////////////////////////////////////
6112
6113 .chapter "Regular expressions" "CHAPregexp"
6114
6115 .cindex "regular expressions" "library"
6116 .cindex "PCRE"
6117 Exim supports the use of regular expressions in many of its options. It
6118 uses the PCRE regular expression library; this provides regular expression
6119 matching that is compatible with Perl 5. The syntax and semantics of
6120 regular expressions is discussed in many Perl reference books, and also in
6121 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6122 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6123
6124 The documentation for the syntax and semantics of the regular expressions that
6125 are supported by PCRE is included in the PCRE distribution, and no further
6126 description is included here. The PCRE functions are called from Exim using
6127 the default option settings (that is, with no PCRE options set), except that
6128 the PCRE_CASELESS option is set when the matching is required to be
6129 case-insensitive.
6130
6131 In most cases, when a regular expression is required in an Exim configuration,
6132 it has to start with a circumflex, in order to distinguish it from plain text
6133 or an &"ends with"& wildcard. In this example of a configuration setting, the
6134 second item in the colon-separated list is a regular expression.
6135 .code
6136 domains = a.b.c : ^\\d{3} : *.y.z : ...
6137 .endd
6138 The doubling of the backslash is required because of string expansion that
6139 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6140 of this issue, and a way of avoiding the need for doubling backslashes. The
6141 regular expression that is eventually used in this example contains just one
6142 backslash. The circumflex is included in the regular expression, and has the
6143 normal effect of &"anchoring"& it to the start of the string that is being
6144 matched.
6145
6146 There are, however, two cases where a circumflex is not required for the
6147 recognition of a regular expression: these are the &%match%& condition in a
6148 string expansion, and the &%matches%& condition in an Exim filter file. In
6149 these cases, the relevant string is always treated as a regular expression; if
6150 it does not start with a circumflex, the expression is not anchored, and can
6151 match anywhere in the subject string.
6152
6153 In all cases, if you want a regular expression to match at the end of a string,
6154 you must code the $ metacharacter to indicate this. For example:
6155 .code
6156 domains = ^\\d{3}\\.example
6157 .endd
6158 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6159 You need to use:
6160 .code
6161 domains = ^\\d{3}\\.example\$
6162 .endd
6163 if you want &'example'& to be the top-level domain. The backslash before the
6164 $ is needed because string expansion also interprets dollar characters.
6165
6166
6167
6168 . ////////////////////////////////////////////////////////////////////////////
6169 . ////////////////////////////////////////////////////////////////////////////
6170
6171 .chapter "File and database lookups" "CHAPfdlookup"
6172 .scindex IIDfidalo1 "file" "lookups"
6173 .scindex IIDfidalo2 "database" "lookups"
6174 .cindex "lookup" "description of"
6175 Exim can be configured to look up data in files or databases as it processes
6176 messages. Two different kinds of syntax are used:
6177
6178 .olist
6179 A string that is to be expanded may contain explicit lookup requests. These
6180 cause parts of the string to be replaced by data that is obtained from the
6181 lookup. Lookups of this type are conditional expansion items. Different results
6182 can be defined for the cases of lookup success and failure. See chapter
6183 &<<CHAPexpand>>&, where string expansions are described in detail.
6184 .next
6185 Lists of domains, hosts, and email addresses can contain lookup requests as a
6186 way of avoiding excessively long linear lists. In this case, the data that is
6187 returned by the lookup is often (but not always) discarded; whether the lookup
6188 succeeds or fails is what really counts. These kinds of list are described in
6189 chapter &<<CHAPdomhosaddlists>>&.
6190 .endlist
6191
6192 String expansions, lists, and lookups interact with each other in such a way
6193 that there is no order in which to describe any one of them that does not
6194 involve references to the others. Each of these three chapters makes more sense
6195 if you have read the other two first. If you are reading this for the first
6196 time, be aware that some of it will make a lot more sense after you have read
6197 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6198
6199 .section "Examples of different lookup syntax" "SECID60"
6200 It is easy to confuse the two different kinds of lookup, especially as the
6201 lists that may contain the second kind are always expanded before being
6202 processed as lists. Therefore, they may also contain lookups of the first kind.
6203 Be careful to distinguish between the following two examples:
6204 .code
6205 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6206 domains = lsearch;/some/file
6207 .endd
6208 The first uses a string expansion, the result of which must be a domain list.
6209 No strings have been specified for a successful or a failing lookup; the
6210 defaults in this case are the looked-up data and an empty string, respectively.
6211 The expansion takes place before the string is processed as a list, and the
6212 file that is searched could contain lines like this:
6213 .code
6214 192.168.3.4: domain1:domain2:...
6215 192.168.1.9: domain3:domain4:...
6216 .endd
6217 When the lookup succeeds, the result of the expansion is a list of domains (and
6218 possibly other types of item that are allowed in domain lists).
6219
6220 In the second example, the lookup is a single item in a domain list. It causes
6221 Exim to use a lookup to see if the domain that is being processed can be found
6222 in the file. The file could contains lines like this:
6223 .code
6224 domain1:
6225 domain2:
6226 .endd
6227 Any data that follows the keys is not relevant when checking that the domain
6228 matches the list item.
6229
6230 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6231 Consider a file containing lines like this:
6232 .code
6233 192.168.5.6: lsearch;/another/file
6234 .endd
6235 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6236 first &%domains%& setting above generates the second setting, which therefore
6237 causes a second lookup to occur.
6238
6239 The rest of this chapter describes the different lookup types that are
6240 available. Any of them can be used in any part of the configuration where a
6241 lookup is permitted.
6242
6243
6244 .section "Lookup types" "SECID61"
6245 .cindex "lookup" "types of"
6246 .cindex "single-key lookup" "definition of"
6247 Two different types of data lookup are implemented:
6248
6249 .ilist
6250 The &'single-key'& type requires the specification of a file in which to look,
6251 and a single key to search for. The key must be a non-empty string for the
6252 lookup to succeed. The lookup type determines how the file is searched.
6253 .next
6254 .cindex "query-style lookup" "definition of"
6255 The &'query-style'& type accepts a generalized database query. No particular
6256 key value is assumed by Exim for query-style lookups. You can use whichever
6257 Exim variables you need to construct the database query.
6258 .endlist
6259
6260 The code for each lookup type is in a separate source file that is included in
6261 the binary of Exim only if the corresponding compile-time option is set. The
6262 default settings in &_src/EDITME_& are:
6263 .code
6264 LOOKUP_DBM=yes
6265 LOOKUP_LSEARCH=yes
6266 .endd
6267 which means that only linear searching and DBM lookups are included by default.
6268 For some types of lookup (e.g. SQL databases), you need to install appropriate
6269 libraries and header files before building Exim.
6270
6271
6272
6273
6274 .section "Single-key lookup types" "SECTsinglekeylookups"
6275 .cindex "lookup" "single-key types"
6276 .cindex "single-key lookup" "list of types"
6277 The following single-key lookup types are implemented:
6278
6279 .ilist
6280 .cindex "cdb" "description of"
6281 .cindex "lookup" "cdb"
6282 .cindex "binary zero" "in lookup key"
6283 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6284 string without a terminating binary zero. The cdb format is designed for
6285 indexed files that are read frequently and never updated, except by total
6286 re-creation. As such, it is particularly suitable for large files containing
6287 aliases or other indexed data referenced by an MTA. Information about cdb can
6288 be found in several places:
6289 .display
6290 &url(http://www.pobox.com/~djb/cdb.html)
6291 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6292 &url(http://packages.debian.org/stable/utils/freecdb.html)
6293 .endd
6294 A cdb distribution is not needed in order to build Exim with cdb support,
6295 because the code for reading cdb files is included directly in Exim itself.
6296 However, no means of building or testing cdb files is provided with Exim, so
6297 you need to obtain a cdb distribution in order to do this.
6298 .next
6299 .cindex "DBM" "lookup type"
6300 .cindex "lookup" "dbm"
6301 .cindex "binary zero" "in lookup key"
6302 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6303 DBM file by looking up the record with the given key. A terminating binary
6304 zero is included in the key that is passed to the DBM library. See section
6305 &<<SECTdb>>& for a discussion of DBM libraries.
6306
6307 .cindex "Berkeley DB library" "file format"
6308 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6309 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6310 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6311 the DB_UNKNOWN option. This enables it to handle any of the types of database
6312 that the library supports, and can be useful for accessing DBM files created by
6313 other applications. (For earlier DB versions, DB_HASH is always used.)
6314 .next
6315 .cindex "lookup" "dbmjz"
6316 .cindex "lookup" "dbm &-- embedded NULs"
6317 .cindex "sasldb2"
6318 .cindex "dbmjz lookup type"
6319 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6320 interpreted as an Exim list; the elements of the list are joined together with
6321 ASCII NUL characters to form the lookup key.  An example usage would be to
6322 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6323 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6324 &(cram_md5)& authenticator.
6325 .next
6326 .cindex "lookup" "dbmnz"
6327 .cindex "lookup" "dbm &-- terminating zero"
6328 .cindex "binary zero" "in lookup key"
6329 .cindex "Courier"
6330 .cindex "&_/etc/userdbshadow.dat_&"
6331 .cindex "dbmnz lookup type"
6332 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6333 is not included in the key that is passed to the DBM library. You may need this
6334 if you want to look up data in files that are created by or shared with some
6335 other application that does not use terminating zeros. For example, you need to
6336 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6337 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6338 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6339 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6340 .next
6341 .cindex "lookup" "dsearch"
6342 .cindex "dsearch lookup type"
6343 &(dsearch)&: The given file must be a directory; this is searched for an entry
6344 whose name is the key by calling the &[lstat()]& function. The key may not
6345 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6346 the lookup is the name of the entry, which may be a file, directory,
6347 symbolic link, or any other kind of directory entry. An example of how this
6348 lookup can be used to support virtual domains is given in section
6349 &<<SECTvirtualdomains>>&.
6350 .next
6351 .cindex "lookup" "iplsearch"
6352 .cindex "iplsearch lookup type"
6353 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6354 terminated by a colon or white space or the end of the line. The keys in the
6355 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6356 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6357 being interpreted as a key terminator. For example:
6358 .code
6359 1.2.3.4:           data for 1.2.3.4
6360 192.168.0.0/16:    data for 192.168.0.0/16
6361 "abcd::cdab":      data for abcd::cdab
6362 "abcd:abcd::/32"   data for abcd:abcd::/32
6363 .endd
6364 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6365 file is searched linearly, using the CIDR masks where present, until a matching
6366 key is found. The first key that matches is used; there is no attempt to find a
6367 &"best"& match. Apart from the way the keys are matched, the processing for
6368 &(iplsearch)& is the same as for &(lsearch)&.
6369
6370 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6371 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6372 lookup types support only literal keys.
6373
6374 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6375 the implicit key is the host's IP address rather than its name (see section
6376 &<<SECThoslispatsikey>>&).
6377 .next
6378 .cindex "linear search"
6379 .cindex "lookup" "lsearch"
6380 .cindex "lsearch lookup type"
6381 .cindex "case sensitivity" "in lsearch lookup"
6382 &(lsearch)&: The given file is a text file that is searched linearly for a
6383 line beginning with the search key, terminated by a colon or white space or the
6384 end of the line. The search is case-insensitive; that is, upper and lower case
6385 letters are treated as the same. The first occurrence of the key that is found
6386 in the file is used.
6387
6388 White space between the key and the colon is permitted. The remainder of the
6389 line, with leading and trailing white space removed, is the data. This can be
6390 continued onto subsequent lines by starting them with any amount of white
6391 space, but only a single space character is included in the data at such a
6392 junction. If the data begins with a colon, the key must be terminated by a
6393 colon, for example:
6394 .code
6395 baduser:  :fail:
6396 .endd
6397 Empty lines and lines beginning with # are ignored, even if they occur in the
6398 middle of an item. This is the traditional textual format of alias files. Note
6399 that the keys in an &(lsearch)& file are literal strings. There is no
6400 wildcarding of any kind.
6401
6402 .cindex "lookup" "lsearch &-- colons in keys"
6403 .cindex "white space" "in lsearch key"
6404 In most &(lsearch)& files, keys are not required to contain colons or #
6405 characters, or white space. However, if you need this feature, it is available.
6406 If a key begins with a doublequote character, it is terminated only by a
6407 matching quote (or end of line), and the normal escaping rules apply to its
6408 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6409 quoted keys (exactly as for unquoted keys). There is no special handling of
6410 quotes for the data part of an &(lsearch)& line.
6411
6412 .next
6413 .cindex "NIS lookup type"
6414 .cindex "lookup" "NIS"
6415 .cindex "binary zero" "in lookup key"
6416 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6417 the given key, without a terminating binary zero. There is a variant called
6418 &(nis0)& which does include the terminating binary zero in the key. This is
6419 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6420 aliases; the full map names must be used.
6421
6422 .next
6423 .cindex "wildlsearch lookup type"
6424 .cindex "lookup" "wildlsearch"
6425 .cindex "nwildlsearch lookup type"
6426 .cindex "lookup" "nwildlsearch"
6427 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6428 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6429 the file may be wildcarded. The difference between these two lookup types is
6430 that for &(wildlsearch)&, each key in the file is string-expanded before being
6431 used, whereas for &(nwildlsearch)&, no expansion takes place.
6432
6433 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6434 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6435 file that are regular expressions can be made case-sensitive by the use of
6436 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6437
6438 . ==== As this is a nested list, any displays it contains must be indented
6439 . ==== as otherwise they are too far to the left.
6440
6441 .olist
6442 The string may begin with an asterisk to mean &"ends with"&. For example:
6443 .code
6444     *.a.b.c       data for anything.a.b.c
6445     *fish         data for anythingfish
6446 .endd
6447 .next
6448 The string may begin with a circumflex to indicate a regular expression. For
6449 example, for &(wildlsearch)&:
6450 .code
6451     ^\N\d+\.a\.b\N    data for <digits>.a.b
6452 .endd
6453 Note the use of &`\N`& to disable expansion of the contents of the regular
6454 expression. If you are using &(nwildlsearch)&, where the keys are not
6455 string-expanded, the equivalent entry is:
6456 .code
6457     ^\d+\.a\.b        data for <digits>.a.b
6458 .endd
6459 The case-insensitive flag is set at the start of compiling the regular
6460 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6461 For example, to make the entire pattern case-sensitive:
6462 .code
6463     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6464 .endd
6465
6466 If the regular expression contains white space or colon characters, you must
6467 either quote it (see &(lsearch)& above), or represent these characters in other
6468 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6469 colon. This may be easier than quoting, because if you quote, you have to
6470 escape all the backslashes inside the quotes.
6471
6472 &*Note*&: It is not possible to capture substrings in a regular expression
6473 match for later use, because the results of all lookups are cached. If a lookup
6474 is repeated, the result is taken from the cache, and no actual pattern matching
6475 takes place. The values of all the numeric variables are unset after a
6476 &((n)wildlsearch)& match.
6477
6478 .next
6479 Although I cannot see it being of much use, the general matching function that
6480 is used to implement &((n)wildlsearch)& means that the string may begin with a
6481 lookup name terminated by a semicolon, and followed by lookup data. For
6482 example:
6483 .code
6484     cdb;/some/file  data for keys that match the file
6485 .endd
6486 The data that is obtained from the nested lookup is discarded.
6487 .endlist olist
6488
6489 Keys that do not match any of these patterns are interpreted literally. The
6490 continuation rules for the data are the same as for &(lsearch)&, and keys may
6491 be followed by optional colons.
6492
6493 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6494 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6495 lookup types support only literal keys.
6496 .endlist ilist
6497
6498
6499 .section "Query-style lookup types" "SECID62"
6500 .cindex "lookup" "query-style types"
6501 .cindex "query-style lookup" "list of types"
6502 The supported query-style lookup types are listed below. Further details about
6503 many of them are given in later sections.
6504
6505 .ilist
6506 .cindex "DNS" "as a lookup type"
6507 .cindex "lookup" "DNS"
6508 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6509 are given in the supplied query. The resulting data is the contents of the
6510 records. See section &<<SECTdnsdb>>&.
6511 .next
6512 .cindex "InterBase lookup type"
6513 .cindex "lookup" "InterBase"
6514 &(ibase)&: This does a lookup in an InterBase database.
6515 .next
6516 .cindex "LDAP" "lookup type"
6517 .cindex "lookup" "LDAP"
6518 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6519 returns attributes from a single entry. There is a variant called &(ldapm)&
6520 that permits values from multiple entries to be returned. A third variant
6521 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6522 any attribute values. See section &<<SECTldap>>&.
6523 .next
6524 .cindex "MySQL" "lookup type"
6525 .cindex "lookup" "MySQL"
6526 &(mysql)&: The format of the query is an SQL statement that is passed to a
6527 MySQL database. See section &<<SECTsql>>&.
6528 .next
6529 .cindex "NIS+ lookup type"
6530 .cindex "lookup" "NIS+"
6531 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6532 the field to be returned. See section &<<SECTnisplus>>&.
6533 .next
6534 .cindex "Oracle" "lookup type"
6535 .cindex "lookup" "Oracle"
6536 &(oracle)&: The format of the query is an SQL statement that is passed to an
6537 Oracle database. See section &<<SECTsql>>&.
6538 .next
6539 .cindex "lookup" "passwd"
6540 .cindex "passwd lookup type"
6541 .cindex "&_/etc/passwd_&"
6542 &(passwd)& is a query-style lookup with queries that are just user names. The
6543 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6544 success, the result string is the same as you would get from an &(lsearch)&
6545 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6546 password value. For example:
6547 .code
6548 *:42:42:King Rat:/home/kr:/bin/bash
6549 .endd
6550 .next
6551 .cindex "PostgreSQL lookup type"
6552 .cindex "lookup" "PostgreSQL"
6553 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6554 PostgreSQL database. See section &<<SECTsql>>&.
6555
6556 .next
6557 .cindex "sqlite lookup type"
6558 .cindex "lookup" "sqlite"
6559 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6560 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6561
6562 .next
6563 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6564 not likely to be useful in normal operation.
6565 .next
6566 .cindex "whoson lookup type"
6567 .cindex "lookup" "whoson"
6568 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6569 allows a server to check whether a particular (dynamically allocated) IP
6570 address is currently allocated to a known (trusted) user and, optionally, to
6571 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6572 at one time for &"POP before SMTP"& authentication, but that approach has been
6573 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6574 &"POP before SMTP"& checking using ACL statements such as
6575 .code
6576 require condition = \
6577   ${lookup whoson {$sender_host_address}{yes}{no}}
6578 .endd
6579 The query consists of a single IP address. The value returned is the name of
6580 the authenticated user, which is stored in the variable &$value$&. However, in
6581 this example, the data in &$value$& is not used; the result of the lookup is
6582 one of the fixed strings &"yes"& or &"no"&.
6583 .endlist
6584
6585
6586
6587 .section "Temporary errors in lookups" "SECID63"
6588 .cindex "lookup" "temporary error in"
6589 Lookup functions can return temporary error codes if the lookup cannot be
6590 completed. For example, an SQL or LDAP database might be unavailable. For this
6591 reason, it is not advisable to use a lookup that might do this for critical
6592 options such as a list of local domains.
6593
6594 When a lookup cannot be completed in a router or transport, delivery
6595 of the message (to the relevant address) is deferred, as for any other
6596 temporary error. In other circumstances Exim may assume the lookup has failed,
6597 or may give up altogether.
6598
6599
6600
6601 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6602 .cindex "wildcard lookups"
6603 .cindex "lookup" "default values"
6604 .cindex "lookup" "wildcard"
6605 .cindex "lookup" "* added to type"
6606 .cindex "default" "in single-key lookups"
6607 In this context, a &"default value"& is a value specified by the administrator
6608 that is to be used if a lookup fails.
6609
6610 &*Note:*& This section applies only to single-key lookups. For query-style
6611 lookups, the facilities of the query language must be used. An attempt to
6612 specify a default for a query-style lookup provokes an error.
6613
6614 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6615 and the initial lookup fails, the key &"*"& is looked up in the file to
6616 provide a default value. See also the section on partial matching below.
6617
6618 .cindex "*@ with single-key lookup"
6619 .cindex "lookup" "*@ added to type"
6620 .cindex "alias file" "per-domain default"
6621 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6622 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6623 character, a second lookup is done with everything before the last @ replaced
6624 by *. This makes it possible to provide per-domain defaults in alias files
6625 that include the domains in the keys. If the second lookup fails (or doesn't
6626 take place because there is no @ in the key), &"*"& is looked up.
6627 For example, a &(redirect)& router might contain:
6628 .code
6629 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6630 .endd
6631 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6632 looks up these keys, in this order:
6633 .code
6634 jane@eyre.example
6635 *@eyre.example
6636 *
6637 .endd
6638 The data is taken from whichever key it finds first. &*Note*&: In an
6639 &(lsearch)& file, this does not mean the first of these keys in the file. A
6640 complete scan is done for each key, and only if it is not found at all does
6641 Exim move on to try the next key.
6642
6643
6644
6645 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6646 .cindex "partial matching"
6647 .cindex "wildcard lookups"
6648 .cindex "lookup" "partial matching"
6649 .cindex "lookup" "wildcard"
6650 .cindex "asterisk" "in search type"
6651 The normal operation of a single-key lookup is to search the file for an exact
6652 match with the given key. However, in a number of situations where domains are
6653 being looked up, it is useful to be able to do partial matching. In this case,
6654 information in the file that has a key starting with &"*."& is matched by any
6655 domain that ends with the components that follow the full stop. For example, if
6656 a key in a DBM file is
6657 .code
6658 *.dates.fict.example
6659 .endd
6660 then when partial matching is enabled this is matched by (amongst others)
6661 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6662 by &'dates.fict.example'&, if that does not appear as a separate key in the
6663 file.
6664
6665 &*Note*&: Partial matching is not available for query-style lookups. It is
6666 also not available for any lookup items in address lists (see section
6667 &<<SECTaddresslist>>&).
6668
6669 Partial matching is implemented by doing a series of separate lookups using
6670 keys constructed by modifying the original subject key. This means that it can
6671 be used with any of the single-key lookup types, provided that
6672 partial matching keys
6673 beginning with a special prefix (default &"*."&) are included in the data file.
6674 Keys in the file that do not begin with the prefix are matched only by
6675 unmodified subject keys when partial matching is in use.
6676
6677 Partial matching is requested by adding the string &"partial-"& to the front of
6678 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6679 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6680 is added at the start of the subject key, and it is looked up again. If that
6681 fails, further lookups are tried with dot-separated components removed from the
6682 start of the subject key, one-by-one, and &"*."& added on the front of what
6683 remains.
6684
6685 A minimum number of two non-* components are required. This can be adjusted
6686 by including a number before the hyphen in the search type. For example,
6687 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6688 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6689 subject key is &'2250.dates.fict.example'& then the following keys are looked
6690 up when the minimum number of non-* components is two:
6691 .code
6692 2250.dates.fict.example
6693 *.2250.dates.fict.example
6694 *.dates.fict.example
6695 *.fict.example
6696 .endd
6697 As soon as one key in the sequence is successfully looked up, the lookup
6698 finishes.
6699
6700 .cindex "lookup" "partial matching &-- changing prefix"
6701 .cindex "prefix" "for partial matching"
6702 The use of &"*."& as the partial matching prefix is a default that can be
6703 changed. The motivation for this feature is to allow Exim to operate with file
6704 formats that are used by other MTAs. A different prefix can be supplied in
6705 parentheses instead of the hyphen after &"partial"&. For example:
6706 .code
6707 domains = partial(.)lsearch;/some/file
6708 .endd
6709 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6710 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6711 components is unchanged). The prefix may consist of any punctuation characters
6712 other than a closing parenthesis. It may be empty, for example:
6713 .code
6714 domains = partial1()cdb;/some/file
6715 .endd
6716 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6717 &`a.b.c`&, &`b.c`&, and &`c`&.
6718
6719 If &"partial0"& is specified, what happens at the end (when the lookup with
6720 just one non-wild component has failed, and the original key is shortened right
6721 down to the null string) depends on the prefix:
6722
6723 .ilist
6724 If the prefix has zero length, the whole lookup fails.
6725 .next
6726 If the prefix has length 1, a lookup for just the prefix is done. For
6727 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6728 .next
6729 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6730 remainder is looked up. With the default prefix, therefore, the final lookup is
6731 for &"*"& on its own.
6732 .next
6733 Otherwise, the whole prefix is looked up.
6734 .endlist
6735
6736
6737 If the search type ends in &"*"& or &"*@"& (see section
6738 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6739 this implies happens after all partial lookups have failed. If &"partial0"& is
6740 specified, adding &"*"& to the search type has no effect with the default
6741 prefix, because the &"*"& key is already included in the sequence of partial
6742 lookups. However, there might be a use for lookup types such as
6743 &"partial0(.)lsearch*"&.
6744
6745 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6746 in domain lists and the like. Partial matching works only in terms of
6747 dot-separated components; a key such as &`*fict.example`&
6748 in a database file is useless, because the asterisk in a partial matching
6749 subject key is always followed by a dot.
6750
6751
6752
6753
6754 .section "Lookup caching" "SECID64"
6755 .cindex "lookup" "caching"
6756 .cindex "caching" "lookup data"
6757 Exim caches all lookup results in order to avoid needless repetition of
6758 lookups. However, because (apart from the daemon) Exim operates as a collection
6759 of independent, short-lived processes, this caching applies only within a
6760 single Exim process. There is no inter-process lookup caching facility.
6761
6762 For single-key lookups, Exim keeps the relevant files open in case there is
6763 another lookup that needs them. In some types of configuration this can lead to
6764 many files being kept open for messages with many recipients. To avoid hitting
6765 the operating system limit on the number of simultaneously open files, Exim
6766 closes the least recently used file when it needs to open more files than its
6767 own internal limit, which can be changed via the &%lookup_open_max%& option.
6768
6769 The single-key lookup files are closed and the lookup caches are flushed at
6770 strategic points during delivery &-- for example, after all routing is
6771 complete.
6772
6773
6774
6775
6776 .section "Quoting lookup data" "SECID65"
6777 .cindex "lookup" "quoting"
6778 .cindex "quoting" "in lookups"
6779 When data from an incoming message is included in a query-style lookup, there
6780 is the possibility of special characters in the data messing up the syntax of
6781 the query. For example, a NIS+ query that contains
6782 .code
6783 [name=$local_part]
6784 .endd
6785 will be broken if the local part happens to contain a closing square bracket.
6786 For NIS+, data can be enclosed in double quotes like this:
6787 .code
6788 [name="$local_part"]
6789 .endd
6790 but this still leaves the problem of a double quote in the data. The rule for
6791 NIS+ is that double quotes must be doubled. Other lookup types have different
6792 rules, and to cope with the differing requirements, an expansion operator
6793 of the following form is provided:
6794 .code
6795 ${quote_<lookup-type>:<string>}
6796 .endd
6797 For example, the safest way to write the NIS+ query is
6798 .code
6799 [name="${quote_nisplus:$local_part}"]
6800 .endd
6801 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6802 operator can be used for all lookup types, but has no effect for single-key
6803 lookups, since no quoting is ever needed in their key strings.
6804
6805
6806
6807
6808 .section "More about dnsdb" "SECTdnsdb"
6809 .cindex "dnsdb lookup"
6810 .cindex "lookup" "dnsdb"
6811 .cindex "DNS" "as a lookup type"
6812 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6813 of a record type and a domain name, separated by an equals sign. For example,
6814 an expansion string could contain:
6815 .code
6816 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6817 .endd
6818 If the lookup succeeds, the result is placed in &$value$&, which in this case
6819 is used on its own as the result. If the lookup does not succeed, the
6820 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6821 &<<SECTforexpfai>>& for an explanation of what this means.
6822
6823 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, and TXT,
6824 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6825 configured). If no type is given, TXT is assumed. When the type is PTR,
6826 the data can be an IP address, written as normal; inversion and the addition of
6827 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6828 .code
6829 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6830 .endd
6831 If the data for a PTR record is not a syntactically valid IP address, it is not
6832 altered and nothing is added.
6833
6834 .cindex "MX record" "in &(dnsdb)& lookup"
6835 .cindex "SRV record" "in &(dnsdb)& lookup"
6836 For an MX lookup, both the preference value and the host name are returned for
6837 each record, separated by a space. For an SRV lookup, the priority, weight,
6838 port, and host name are returned for each record, separated by spaces.
6839
6840 For any record type, if multiple records are found (or, for A6 lookups, if a
6841 single record leads to multiple addresses), the data is returned as a
6842 concatenation, with newline as the default separator. The order, of course,
6843 depends on the DNS resolver. You can specify a different separator character
6844 between multiple records by putting a right angle-bracket followed immediately
6845 by the new separator at the start of the query. For example:
6846 .code
6847 ${lookup dnsdb{>: a=host1.example}}
6848 .endd
6849 It is permitted to specify a space as the separator character. Further
6850 white space is ignored.
6851
6852 .cindex "TXT record" "in &(dnsdb)& lookup"
6853 .cindex "SPF record" "in &(dnsdb)& lookup"
6854 For TXT records with multiple items of data, only the first item is returned,
6855 unless a separator for them is specified using a comma after the separator
6856 character followed immediately by the TXT record item separator. To concatenate
6857 items without a separator, use a semicolon instead. For SPF records the
6858 default behaviour is to concatenate multiple items without using a separator.
6859 .code
6860 ${lookup dnsdb{>\n,: txt=a.b.example}}
6861 ${lookup dnsdb{>\n; txt=a.b.example}}
6862 ${lookup dnsdb{spf=example.org}}
6863 .endd
6864 It is permitted to specify a space as the separator character. Further
6865 white space is ignored.
6866
6867 .section "Pseudo dnsdb record types" "SECID66"
6868 .cindex "MX record" "in &(dnsdb)& lookup"
6869 By default, both the preference value and the host name are returned for
6870 each MX record, separated by a space. If you want only host names, you can use
6871 the pseudo-type MXH:
6872 .code
6873 ${lookup dnsdb{mxh=a.b.example}}
6874 .endd
6875 In this case, the preference values are omitted, and just the host names are
6876 returned.
6877
6878 .cindex "name server for enclosing domain"
6879 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6880 records on the given domain, but if none are found, it removes the first
6881 component of the domain name, and tries again. This process continues until NS
6882 records are found or there are no more components left (or there is a DNS
6883 error). In other words, it may return the name servers for a top-level domain,
6884 but it never returns the root name servers. If there are no NS records for the
6885 top-level domain, the lookup fails. Consider these examples:
6886 .code
6887 ${lookup dnsdb{zns=xxx.quercite.com}}
6888 ${lookup dnsdb{zns=xxx.edu}}
6889 .endd
6890 Assuming that in each case there are no NS records for the full domain name,
6891 the first returns the name servers for &%quercite.com%&, and the second returns
6892 the name servers for &%edu%&.
6893
6894 You should be careful about how you use this lookup because, unless the
6895 top-level domain does not exist, the lookup always returns some host names. The
6896 sort of use to which this might be put is for seeing if the name servers for a
6897 given domain are on a blacklist. You can probably assume that the name servers
6898 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6899 such a list.
6900
6901 .cindex "CSA" "in &(dnsdb)& lookup"
6902 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6903 records according to the CSA rules, which are described in section
6904 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6905 not sufficient because of the extra parent domain search behaviour of CSA. The
6906 result of a successful lookup such as:
6907 .code
6908 ${lookup dnsdb {csa=$sender_helo_name}}
6909 .endd
6910 has two space-separated fields: an authorization code and a target host name.
6911 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6912 authorization required but absent, or &"?"& for unknown.
6913
6914
6915 .section "Multiple dnsdb lookups" "SECID67"
6916 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6917 However, you can specify a list of domains or IP addresses in a single
6918 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6919 the default separator, but with the ability to change this. For example:
6920 .code
6921 ${lookup dnsdb{one.domain.com:two.domain.com}}
6922 ${lookup dnsdb{a=one.host.com:two.host.com}}
6923 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6924 .endd
6925 In order to retain backwards compatibility, there is one special case: if
6926 the lookup type is PTR and no change of separator is specified, Exim looks
6927 to see if the rest of the string is precisely one IPv6 address. In this
6928 case, it does not treat it as a list.
6929
6930 The data from each lookup is concatenated, with newline separators by default,
6931 in the same way that multiple DNS records for a single item are handled. A
6932 different separator can be specified, as described above.
6933
6934 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6935 temporary DNS error for any of them, the behaviour is controlled by
6936 an optional keyword followed by a comma that may appear before the record
6937 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6938 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6939 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6940 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6941 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6942 error causes the whole lookup to defer only if none of the other lookups
6943 succeed. The default is &"lax"&, so the following lookups are equivalent:
6944 .code
6945 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6946 ${lookup dnsdb{a=one.host.com:two.host.com}}
6947 .endd
6948 Thus, in the default case, as long as at least one of the DNS lookups
6949 yields some data, the lookup succeeds.
6950
6951
6952
6953
6954 .section "More about LDAP" "SECTldap"
6955 .cindex "LDAP" "lookup, more about"
6956 .cindex "lookup" "LDAP"
6957 .cindex "Solaris" "LDAP"
6958 The original LDAP implementation came from the University of Michigan; this has
6959 become &"Open LDAP"&, and there are now two different releases. Another
6960 implementation comes from Netscape, and Solaris 7 and subsequent releases
6961 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6962 the lookup function level, their error handling is different. For this reason
6963 it is necessary to set a compile-time variable when building Exim with LDAP, to
6964 indicate which LDAP library is in use. One of the following should appear in
6965 your &_Local/Makefile_&:
6966 .code
6967 LDAP_LIB_TYPE=UMICHIGAN
6968 LDAP_LIB_TYPE=OPENLDAP1
6969 LDAP_LIB_TYPE=OPENLDAP2
6970 LDAP_LIB_TYPE=NETSCAPE
6971 LDAP_LIB_TYPE=SOLARIS
6972 .endd
6973 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6974 same interface as the University of Michigan version.
6975
6976 There are three LDAP lookup types in Exim. These behave slightly differently in
6977 the way they handle the results of a query:
6978
6979 .ilist
6980 &(ldap)& requires the result to contain just one entry; if there are more, it
6981 gives an error.
6982 .next
6983 &(ldapdn)& also requires the result to contain just one entry, but it is the
6984 Distinguished Name that is returned rather than any attribute values.
6985 .next
6986 &(ldapm)& permits the result to contain more than one entry; the attributes
6987 from all of them are returned.
6988 .endlist
6989
6990
6991 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6992 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6993 the data returned by a successful lookup is described in the next section.
6994 First we explain how LDAP queries are coded.
6995
6996
6997 .section "Format of LDAP queries" "SECTforldaque"
6998 .cindex "LDAP" "query format"
6999 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7000 the configuration of a &(redirect)& router one might have this setting:
7001 .code
7002 data = ${lookup ldap \
7003   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7004   c=UK?mailbox?base?}}
7005 .endd
7006 .cindex "LDAP" "with TLS"
7007 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7008 secure (encrypted) LDAP connections. The second of these ensures that an
7009 encrypted TLS connection is used.
7010
7011 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7012 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7013 See the &%ldap_start_tls%& option.
7014
7015
7016 .section "LDAP quoting" "SECID68"
7017 .cindex "LDAP" "quoting"
7018 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7019 and the second because the LDAP query is represented as a URL. Furthermore,
7020 within an LDAP query, two different kinds of quoting are required. For this
7021 reason, there are two different LDAP-specific quoting operators.
7022
7023 The &%quote_ldap%& operator is designed for use on strings that are part of
7024 filter specifications. Conceptually, it first does the following conversions on
7025 the string:
7026 .code
7027 *   =>   \2A
7028 (   =>   \28
7029 )   =>   \29
7030 \   =>   \5C
7031 .endd
7032 in accordance with RFC 2254. The resulting string is then quoted according
7033 to the rules for URLs, that is, all non-alphanumeric characters except
7034 .code
7035 ! $ ' - . _ ( ) * +
7036 .endd
7037 are converted to their hex values, preceded by a percent sign. For example:
7038 .code
7039 ${quote_ldap: a(bc)*, a<yz>; }
7040 .endd
7041 yields
7042 .code
7043 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7044 .endd
7045 Removing the URL quoting, this is (with a leading and a trailing space):
7046 .code
7047 a\28bc\29\2A, a<yz>;
7048 .endd
7049 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7050 base DN specifications in queries. Conceptually, it first converts the string
7051 by inserting a backslash in front of any of the following characters:
7052 .code
7053 , + " \ < > ;
7054 .endd
7055 It also inserts a backslash before any leading spaces or # characters, and
7056 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7057 is then quoted according to the rules for URLs. For example:
7058 .code
7059 ${quote_ldap_dn: a(bc)*, a<yz>; }
7060 .endd
7061 yields
7062 .code
7063 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7064 .endd
7065 Removing the URL quoting, this is (with a trailing space):
7066 .code
7067 \ a(bc)*\, a\<yz\>\;\
7068 .endd
7069 There are some further comments about quoting in the section on LDAP
7070 authentication below.
7071
7072
7073 .section "LDAP connections" "SECID69"
7074 .cindex "LDAP" "connections"
7075 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7076 is in use, via a Unix domain socket. The example given above does not specify
7077 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7078 by starting it with
7079 .code
7080 ldap://<hostname>:<port>/...
7081 .endd
7082 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7083 used. When no server is specified in a query, a list of default servers is
7084 taken from the &%ldap_default_servers%& configuration option. This supplies a
7085 colon-separated list of servers which are tried in turn until one successfully
7086 handles a query, or there is a serious error. Successful handling either
7087 returns the requested data, or indicates that it does not exist. Serious errors
7088 are syntactical, or multiple values when only a single value is expected.
7089 Errors which cause the next server to be tried are connection failures, bind
7090 failures, and timeouts.
7091
7092 For each server name in the list, a port number can be given. The standard way
7093 of specifying a host and port is to use a colon separator (RFC 1738). Because
7094 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7095 doubled. For example
7096 .code
7097 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7098 .endd
7099 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7100 to the LDAP library with no server name, and the library's default (normally
7101 the local host) is used.
7102
7103 If you are using the OpenLDAP library, you can connect to an LDAP server using
7104 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7105 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7106 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7107 not available.
7108
7109 For this type of connection, instead of a host name for the server, a pathname
7110 for the socket is required, and the port number is not relevant. The pathname
7111 can be specified either as an item in &%ldap_default_servers%&, or inline in
7112 the query. In the former case, you can have settings such as
7113 .code
7114 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7115 .endd
7116 When the pathname is given in the query, you have to escape the slashes as
7117 &`%2F`& to fit in with the LDAP URL syntax. For example:
7118 .code
7119 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7120 .endd
7121 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7122 a pathname, it uses the Unix domain socket code, even if the query actually
7123 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7124 socket connection. This behaviour means that you can use a setting of
7125 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7126 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7127 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7128 backup host.
7129
7130 If an explicit &`ldapi`& type is given in a query when a host name is
7131 specified, an error is diagnosed. However, if there are more items in
7132 &%ldap_default_servers%&, they are tried. In other words:
7133
7134 .ilist
7135 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7136 interface.
7137 .next
7138 Using &`ldapi`& with a host name causes an error.
7139 .endlist
7140
7141
7142 Using &`ldapi`& with no host or path in the query, and no setting of
7143 &%ldap_default_servers%&, does whatever the library does by default.
7144
7145
7146
7147 .section "LDAP authentication and control information" "SECID70"
7148 .cindex "LDAP" "authentication"
7149 The LDAP URL syntax provides no way of passing authentication and other control
7150 information to the server. To make this possible, the URL in an LDAP query may
7151 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7152 spaces. If a value contains spaces it must be enclosed in double quotes, and
7153 when double quotes are used, backslash is interpreted in the usual way inside
7154 them. The following names are recognized:
7155 .display
7156 &`DEREFERENCE`&  set the dereferencing parameter
7157 &`NETTIME    `&  set a timeout for a network operation
7158 &`USER       `&  set the DN, for authenticating the LDAP bind
7159 &`PASS       `&  set the password, likewise
7160 &`REFERRALS  `&  set the referrals parameter
7161 &`SIZE       `&  set the limit for the number of entries returned
7162 &`TIME       `&  set the maximum waiting time for a query
7163 .endd
7164 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7165 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7166 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7167 library from trying to follow referrals issued by the LDAP server.
7168
7169 The name CONNECT is an obsolete name for NETTIME, retained for
7170 backwards compatibility. This timeout (specified as a number of seconds) is
7171 enforced from the client end for operations that can be carried out over a
7172 network. Specifically, it applies to network connections and calls to the
7173 &'ldap_result()'& function. If the value is greater than zero, it is used if
7174 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7175 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7176 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7177 Netscape SDK; for OpenLDAP no action is taken.
7178
7179 The TIME parameter (also a number of seconds) is passed to the server to
7180 set a server-side limit on the time taken to complete a search.
7181
7182
7183 Here is an example of an LDAP query in an Exim lookup that uses some of these
7184 values. This is a single line, folded to fit on the page:
7185 .code
7186 ${lookup ldap
7187   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7188   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7189   {$value}fail}
7190 .endd
7191 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7192 any of the auxiliary data. Exim configuration settings that include lookups
7193 which contain password information should be preceded by &"hide"& to prevent
7194 non-admin users from using the &%-bP%& option to see their values.
7195
7196 The auxiliary data items may be given in any order. The default is no
7197 connection timeout (the system timeout is used), no user or password, no limit
7198 on the number of entries returned, and no time limit on queries.
7199
7200 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7201 removes any URL quoting that it may contain before passing it LDAP. Apparently
7202 some libraries do this for themselves, but some do not. Removing the URL
7203 quoting has two advantages:
7204
7205 .ilist
7206 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7207 DNs as with DNs inside actual queries.
7208 .next
7209 It permits spaces inside USER= DNs.
7210 .endlist
7211
7212 For example, a setting such as
7213 .code
7214 USER=cn=${quote_ldap_dn:$1}
7215 .endd
7216 should work even if &$1$& contains spaces.
7217
7218 Expanded data for the PASS= value should be quoted using the &%quote%&
7219 expansion operator, rather than the LDAP quote operators. The only reason this
7220 field needs quoting is to ensure that it conforms to the Exim syntax, which
7221 does not allow unquoted spaces. For example:
7222 .code
7223 PASS=${quote:$3}
7224 .endd
7225 The LDAP authentication mechanism can be used to check passwords as part of
7226 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7227 &<<CHAPexpand>>&.
7228
7229
7230
7231 .section "Format of data returned by LDAP" "SECID71"
7232 .cindex "LDAP" "returned data formats"
7233 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7234 as a sequence of values, for example
7235 .code
7236 cn=manager, o=University of Cambridge, c=UK
7237 .endd
7238 The &(ldap)& lookup type generates an error if more than one entry matches the
7239 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7240 the result between the data from different entries. It is possible for multiple
7241 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7242 you know that whatever values are returned all came from a single entry in the
7243 directory.
7244
7245 In the common case where you specify a single attribute in your LDAP query, the
7246 result is not quoted, and does not contain the attribute name. If the attribute
7247 has multiple values, they are separated by commas.
7248
7249 If you specify multiple attributes, the result contains space-separated, quoted
7250 strings, each preceded by the attribute name and an equals sign. Within the
7251 quotes, the quote character, backslash, and newline are escaped with
7252 backslashes, and commas are used to separate multiple values for the attribute.
7253 Apart from the escaping, the string within quotes takes the same form as the
7254 output when a single attribute is requested. Specifying no attributes is the
7255 same as specifying all of an entry's attributes.
7256
7257 Here are some examples of the output format. The first line of each pair is an
7258 LDAP query, and the second is the data that is returned. The attribute called
7259 &%attr1%& has two values, whereas &%attr2%& has only one value:
7260 .code
7261 ldap:///o=base?attr1?sub?(uid=fred)
7262 value1.1, value1.2
7263
7264 ldap:///o=base?attr2?sub?(uid=fred)
7265 value two
7266
7267 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7268 attr1="value1.1, value1.2" attr2="value two"
7269
7270 ldap:///o=base??sub?(uid=fred)
7271 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7272 .endd
7273 The &%extract%& operator in string expansions can be used to pick out
7274 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7275 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7276 results of LDAP lookups.
7277
7278
7279
7280
7281 .section "More about NIS+" "SECTnisplus"
7282 .cindex "NIS+ lookup type"
7283 .cindex "lookup" "NIS+"
7284 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7285 and field name. If this is given, the result of a successful query is the
7286 contents of the named field; otherwise the result consists of a concatenation
7287 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7288 values containing spaces are quoted. For example, the query
7289 .code
7290 [name=mg1456],passwd.org_dir
7291 .endd
7292 might return the string
7293 .code
7294 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7295 home=/home/mg1456 shell=/bin/bash shadow=""
7296 .endd
7297 (split over two lines here to fit on the page), whereas
7298 .code
7299 [name=mg1456],passwd.org_dir:gcos
7300 .endd
7301 would just return
7302 .code
7303 Martin Guerre
7304 .endd
7305 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7306 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7307 operator is to double any quote characters within the text.
7308
7309
7310
7311 .section "SQL lookups" "SECTsql"
7312 .cindex "SQL lookup types"
7313 .cindex "MySQL" "lookup type"
7314 .cindex "PostgreSQL lookup type"
7315 .cindex "lookup" "MySQL"
7316 .cindex "lookup" "PostgreSQL"
7317 .cindex "Oracle" "lookup type"
7318 .cindex "lookup" "Oracle"
7319 .cindex "InterBase lookup type"
7320 .cindex "lookup" "InterBase"
7321 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7322 databases. Queries for these databases contain SQL statements, so an example
7323 might be
7324 .code
7325 ${lookup mysql{select mailbox from users where id='userx'}\
7326   {$value}fail}
7327 .endd
7328 If the result of the query contains more than one field, the data for each
7329 field in the row is returned, preceded by its name, so the result of
7330 .code
7331 ${lookup pgsql{select home,name from users where id='userx'}\
7332   {$value}}
7333 .endd
7334 might be
7335 .code
7336 home=/home/userx name="Mister X"
7337 .endd
7338 Empty values and values containing spaces are double quoted, with embedded
7339 quotes escaped by a backslash. If the result of the query contains just one
7340 field, the value is passed back verbatim, without a field name, for example:
7341 .code
7342 Mister X
7343 .endd
7344 If the result of the query yields more than one row, it is all concatenated,
7345 with a newline between the data for each row.
7346
7347
7348 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7349 .cindex "MySQL" "lookup type"
7350 .cindex "PostgreSQL lookup type"
7351 .cindex "lookup" "MySQL"
7352 .cindex "lookup" "PostgreSQL"
7353 .cindex "Oracle" "lookup type"
7354 .cindex "lookup" "Oracle"
7355 .cindex "InterBase lookup type"
7356 .cindex "lookup" "InterBase"
7357 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7358 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7359 option (as appropriate) must be set to a colon-separated list of server
7360 information.
7361 (For MySQL and PostgreSQL only, the global option need not be set if all
7362 queries contain their own server information &-- see section
7363 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7364 items: host name, database name, user name, and password. In the case of
7365 Oracle, the host name field is used for the &"service name"&, and the database
7366 name field is not used and should be empty. For example:
7367 .code
7368 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7369 .endd
7370 Because password data is sensitive, you should always precede the setting with
7371 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7372 option. Here is an example where two MySQL servers are listed:
7373 .code
7374 hide mysql_servers = localhost/users/root/secret:\
7375                      otherhost/users/root/othersecret
7376 .endd
7377 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7378 because this is a colon-separated list, the colon has to be doubled. For each
7379 query, these parameter groups are tried in order until a connection is made and
7380 a query is successfully processed. The result of a query may be that no data is
7381 found, but that is still a successful query. In other words, the list of
7382 servers provides a backup facility, not a list of different places to look.
7383
7384 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7385 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7386 respectively, and the characters single-quote, double-quote, and backslash
7387 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7388 addition, escapes the percent and underscore characters. This cannot be done
7389 for MySQL because these escapes are not recognized in contexts where these
7390 characters are not special.
7391
7392 .section "Specifying the server in the query" "SECTspeserque"
7393 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7394 it is possible to specify a list of servers with an individual query. This is
7395 done by starting the query with
7396 .display
7397 &`servers=`&&'server1:server2:server3:...'&&`;`&
7398 .endd
7399 Each item in the list may take one of two forms:
7400 .olist
7401 If it contains no slashes it is assumed to be just a host name. The appropriate
7402 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7403 of the same name, and the remaining parameters (database, user, password) are
7404 taken from there.
7405 .next
7406 If it contains any slashes, it is taken as a complete parameter set.
7407 .endlist
7408 The list of servers is used in exactly the same way as the global list.
7409 Once a connection to a server has happened and a query has been
7410 successfully executed, processing of the lookup ceases.
7411
7412 This feature is intended for use in master/slave situations where updates
7413 are occurring and you want to update the master rather than a slave. If the
7414 master is in the list as a backup for reading, you might have a global setting
7415 like this:
7416 .code
7417 mysql_servers = slave1/db/name/pw:\
7418                 slave2/db/name/pw:\
7419                 master/db/name/pw
7420 .endd
7421 In an updating lookup, you could then write:
7422 .code
7423 ${lookup mysql{servers=master; UPDATE ...} }
7424 .endd
7425 That query would then be sent only to the master server. If, on the other hand,
7426 the master is not to be used for reading, and so is not present in the global
7427 option, you can still update it by a query of this form:
7428 .code
7429 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7430 .endd
7431
7432
7433 .section "Special MySQL features" "SECID73"
7434 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7435 causes a connection to the server on the local host by means of a Unix domain
7436 socket. An alternate socket can be specified in parentheses. The full syntax of
7437 each item in &%mysql_servers%& is:
7438 .display
7439 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7440   <&'user'&>/<&'password'&>
7441 .endd
7442 Any of the three sub-parts of the first field can be omitted. For normal use on
7443 the local host it can be left blank or set to just &"localhost"&.
7444
7445 No database need be supplied &-- but if it is absent here, it must be given in
7446 the queries.
7447
7448 If a MySQL query is issued that does not request any data (an insert, update,
7449 or delete command), the result of the lookup is the number of rows affected.
7450
7451 &*Warning*&: This can be misleading. If an update does not actually change
7452 anything (for example, setting a field to the value it already has), the result
7453 is zero because no rows are affected.
7454
7455
7456 .section "Special PostgreSQL features" "SECID74"
7457 PostgreSQL lookups can also use Unix domain socket connections to the database.
7458 This is usually faster and costs less CPU time than a TCP/IP connection.
7459 However it can be used only if the mail server runs on the same machine as the
7460 database server. A configuration line for PostgreSQL via Unix domain sockets
7461 looks like this:
7462 .code
7463 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7464 .endd
7465 In other words, instead of supplying a host name, a path to the socket is
7466 given. The path name is enclosed in parentheses so that its slashes aren't
7467 visually confused with the delimiters for the other server parameters.
7468
7469 If a PostgreSQL query is issued that does not request any data (an insert,
7470 update, or delete command), the result of the lookup is the number of rows
7471 affected.
7472
7473 .section "More about SQLite" "SECTsqlite"
7474 .cindex "lookup" "SQLite"
7475 .cindex "sqlite lookup type"
7476 SQLite is different to the other SQL lookups because a file name is required in
7477 addition to the SQL query. An SQLite database is a single file, and there is no
7478 daemon as in the other SQL databases. The interface to Exim requires the name
7479 of the file, as an absolute path, to be given at the start of the query. It is
7480 separated from the query by white space. This means that the path name cannot
7481 contain white space. Here is a lookup expansion example:
7482 .code
7483 ${lookup sqlite {/some/thing/sqlitedb \
7484   select name from aliases where id='userx';}}
7485 .endd
7486 In a list, the syntax is similar. For example:
7487 .code
7488 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7489    select * from relays where ip='$sender_host_address';
7490 .endd
7491 The only character affected by the &%quote_sqlite%& operator is a single
7492 quote, which it doubles.
7493
7494 The SQLite library handles multiple simultaneous accesses to the database
7495 internally. Multiple readers are permitted, but only one process can
7496 update at once. Attempts to access the database while it is being updated
7497 are rejected after a timeout period, during which the SQLite library
7498 waits for the lock to be released. In Exim, the default timeout is set
7499 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7500 option.
7501 .ecindex IIDfidalo1
7502 .ecindex IIDfidalo2
7503
7504
7505 . ////////////////////////////////////////////////////////////////////////////
7506 . ////////////////////////////////////////////////////////////////////////////
7507
7508 .chapter "Domain, host, address, and local part lists" &&&
7509          "CHAPdomhosaddlists" &&&
7510          "Domain, host, and address lists"
7511 .scindex IIDdohoadli "lists of domains; hosts; etc."
7512 A number of Exim configuration options contain lists of domains, hosts,
7513 email addresses, or local parts. For example, the &%hold_domains%& option
7514 contains a list of domains whose delivery is currently suspended. These lists
7515 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7516 arguments to expansion conditions such as &%match_domain%&.
7517
7518 Each item in one of these lists is a pattern to be matched against a domain,
7519 host, email address, or local part, respectively. In the sections below, the
7520 different types of pattern for each case are described, but first we cover some
7521 general facilities that apply to all four kinds of list.
7522
7523
7524
7525 .section "Expansion of lists" "SECID75"
7526 .cindex "expansion" "of lists"
7527 Each list is expanded as a single string before it is used. The result of
7528 expansion must be a list, possibly containing empty items, which is split up
7529 into separate items for matching. By default, colon is the separator character,
7530 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7531 &<<SECTempitelis>>& for details of the list syntax; the second of these
7532 discusses the way to specify empty list items.
7533
7534
7535 If the string expansion is forced to fail, Exim behaves as if the item it is
7536 testing (domain, host, address, or local part) is not in the list. Other
7537 expansion failures cause temporary errors.
7538
7539 If an item in a list is a regular expression, backslashes, dollars and possibly
7540 other special characters in the expression must be protected against
7541 misinterpretation by the string expander. The easiest way to do this is to use
7542 the &`\N`& expansion feature to indicate that the contents of the regular
7543 expression should not be expanded. For example, in an ACL you might have:
7544 .code
7545 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7546                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7547 .endd
7548 The first item is a regular expression that is protected from expansion by
7549 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7550 senders based on the receiving domain.
7551
7552
7553
7554
7555 .section "Negated items in lists" "SECID76"
7556 .cindex "list" "negation"
7557 .cindex "negation" "in lists"
7558 Items in a list may be positive or negative. Negative items are indicated by a
7559 leading exclamation mark, which may be followed by optional white space. A list
7560 defines a set of items (domains, etc). When Exim processes one of these lists,
7561 it is trying to find out whether a domain, host, address, or local part
7562 (respectively) is in the set that is defined by the list. It works like this:
7563
7564 The list is scanned from left to right. If a positive item is matched, the
7565 subject that is being checked is in the set; if a negative item is matched, the
7566 subject is not in the set. If the end of the list is reached without the
7567 subject having matched any of the patterns, it is in the set if the last item
7568 was a negative one, but not if it was a positive one. For example, the list in
7569 .code
7570 domainlist relay_to_domains = !a.b.c : *.b.c
7571 .endd
7572 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7573 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7574 list is positive. However, if the setting were
7575 .code
7576 domainlist relay_to_domains = !a.b.c
7577 .endd
7578 then all domains other than &'a.b.c'& would match because the last item in the
7579 list is negative. In other words, a list that ends with a negative item behaves
7580 as if it had an extra item &`:*`& on the end.
7581
7582 Another way of thinking about positive and negative items in lists is to read
7583 the connector as &"or"& after a positive item and as &"and"& after a negative
7584 item.
7585
7586
7587
7588 .section "File names in lists" "SECTfilnamlis"
7589 .cindex "list" "file name in"
7590 If an item in a domain, host, address, or local part list is an absolute file
7591 name (beginning with a slash character), each line of the file is read and
7592 processed as if it were an independent item in the list, except that further
7593 file names are not allowed,
7594 and no expansion of the data from the file takes place.
7595 Empty lines in the file are ignored, and the file may also contain comment
7596 lines:
7597
7598 .ilist
7599 For domain and host lists, if a # character appears anywhere in a line of the
7600 file, it and all following characters are ignored.
7601 .next
7602 Because local parts may legitimately contain # characters, a comment in an
7603 address list or local part list file is recognized only if # is preceded by
7604 white space or the start of the line. For example:
7605 .code
7606 not#comment@x.y.z   # but this is a comment
7607 .endd
7608 .endlist
7609
7610 Putting a file name in a list has the same effect as inserting each line of the
7611 file as an item in the list (blank lines and comments excepted). However, there
7612 is one important difference: the file is read each time the list is processed,
7613 so if its contents vary over time, Exim's behaviour changes.
7614
7615 If a file name is preceded by an exclamation mark, the sense of any match
7616 within the file is inverted. For example, if
7617 .code
7618 hold_domains = !/etc/nohold-domains
7619 .endd
7620 and the file contains the lines
7621 .code
7622 !a.b.c
7623 *.b.c
7624 .endd
7625 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7626 any domain matching &`*.b.c`& is not.
7627
7628
7629
7630 .section "An lsearch file is not an out-of-line list" "SECID77"
7631 As will be described in the sections that follow, lookups can be used in lists
7632 to provide indexed methods of checking list membership. There has been some
7633 confusion about the way &(lsearch)& lookups work in lists. Because
7634 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7635 sometimes thought that it is allowed to contain wild cards and other kinds of
7636 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7637 always fixed strings, just as for any other single-key lookup type.
7638
7639 If you want to use a file to contain wild-card patterns that form part of a
7640 list, just give the file name on its own, without a search type, as described
7641 in the previous section. You could also use the &(wildlsearch)& or
7642 &(nwildlsearch)&, but there is no advantage in doing this.
7643
7644
7645
7646
7647 .section "Named lists" "SECTnamedlists"
7648 .cindex "named lists"
7649 .cindex "list" "named"
7650 A list of domains, hosts, email addresses, or local parts can be given a name
7651 which is then used to refer to the list elsewhere in the configuration. This is
7652 particularly convenient if the same list is required in several different
7653 places. It also allows lists to be given meaningful names, which can improve
7654 the readability of the configuration. For example, it is conventional to define
7655 a domain list called &'local_domains'& for all the domains that are handled
7656 locally on a host, using a configuration line such as
7657 .code
7658 domainlist local_domains = localhost:my.dom.example
7659 .endd
7660 Named lists are referenced by giving their name preceded by a plus sign, so,
7661 for example, a router that is intended to handle local domains would be
7662 configured with the line
7663 .code
7664 domains = +local_domains
7665 .endd
7666 The first router in a configuration is often one that handles all domains
7667 except the local ones, using a configuration with a negated item like this:
7668 .code
7669 dnslookup:
7670   driver = dnslookup
7671   domains = ! +local_domains
7672   transport = remote_smtp
7673   no_more
7674 .endd
7675 The four kinds of named list are created by configuration lines starting with
7676 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7677 respectively. Then there follows the name that you are defining, followed by an
7678 equals sign and the list itself. For example:
7679 .code
7680 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7681 addresslist bad_senders = cdb;/etc/badsenders
7682 .endd
7683 A named list may refer to other named lists:
7684 .code
7685 domainlist  dom1 = first.example : second.example
7686 domainlist  dom2 = +dom1 : third.example
7687 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7688 .endd
7689 &*Warning*&: If the last item in a referenced list is a negative one, the
7690 effect may not be what you intended, because the negation does not propagate
7691 out to the higher level. For example, consider:
7692 .code
7693 domainlist  dom1 = !a.b
7694 domainlist  dom2 = +dom1 : *.b
7695 .endd
7696 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7697 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7698 means it matches the second list as well. The effect is not the same as
7699 .code
7700 domainlist  dom2 = !a.b : *.b
7701 .endd
7702 where &'x.y'& does not match. It's best to avoid negation altogether in
7703 referenced lists if you can.
7704
7705 Named lists may have a performance advantage. When Exim is routing an
7706 address or checking an incoming message, it caches the result of tests on named
7707 lists. So, if you have a setting such as
7708 .code
7709 domains = +local_domains
7710 .endd
7711 on several of your routers
7712 or in several ACL statements,
7713 the actual test is done only for the first one. However, the caching works only
7714 if there are no expansions within the list itself or any sublists that it
7715 references. In other words, caching happens only for lists that are known to be
7716 the same each time they are referenced.
7717
7718 By default, there may be up to 16 named lists of each type. This limit can be
7719 extended by changing a compile-time variable. The use of domain and host lists
7720 is recommended for concepts such as local domains, relay domains, and relay
7721 hosts. The default configuration is set up like this.
7722
7723
7724
7725 .section "Named lists compared with macros" "SECID78"
7726 .cindex "list" "named compared with macro"
7727 .cindex "macro" "compared with named list"
7728 At first sight, named lists might seem to be no different from macros in the
7729 configuration file. However, macros are just textual substitutions. If you
7730 write
7731 .code
7732 ALIST = host1 : host2
7733 auth_advertise_hosts = !ALIST
7734 .endd
7735 it probably won't do what you want, because that is exactly the same as
7736 .code
7737 auth_advertise_hosts = !host1 : host2
7738 .endd
7739 Notice that the second host name is not negated. However, if you use a host
7740 list, and write
7741 .code
7742 hostlist alist = host1 : host2
7743 auth_advertise_hosts = ! +alist
7744 .endd
7745 the negation applies to the whole list, and so that is equivalent to
7746 .code
7747 auth_advertise_hosts = !host1 : !host2
7748 .endd
7749
7750
7751 .section "Named list caching" "SECID79"
7752 .cindex "list" "caching of named"
7753 .cindex "caching" "named lists"
7754 While processing a message, Exim caches the result of checking a named list if
7755 it is sure that the list is the same each time. In practice, this means that
7756 the cache operates only if the list contains no $ characters, which guarantees
7757 that it will not change when it is expanded. Sometimes, however, you may have
7758 an expanded list that you know will be the same each time within a given
7759 message. For example:
7760 .code
7761 domainlist special_domains = \
7762            ${lookup{$sender_host_address}cdb{/some/file}}
7763 .endd
7764 This provides a list of domains that depends only on the sending host's IP
7765 address. If this domain list is referenced a number of times (for example,
7766 in several ACL lines, or in several routers) the result of the check is not
7767 cached by default, because Exim does not know that it is going to be the
7768 same list each time.
7769
7770 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7771 cache the result anyway. For example:
7772 .code
7773 domainlist_cache special_domains = ${lookup{...
7774 .endd
7775 If you do this, you should be absolutely sure that caching is going to do
7776 the right thing in all cases. When in doubt, leave it out.
7777
7778
7779
7780 .section "Domain lists" "SECTdomainlist"
7781 .cindex "domain list" "patterns for"
7782 .cindex "list" "domain list"
7783 Domain lists contain patterns that are to be matched against a mail domain.
7784 The following types of item may appear in domain lists:
7785
7786 .ilist
7787 .cindex "primary host name"
7788 .cindex "host name" "matched in domain list"
7789 .oindex "&%primary_hostname%&"
7790 .cindex "domain list" "matching primary host name"
7791 .cindex "@ in a domain list"
7792 If a pattern consists of a single @ character, it matches the local host name,
7793 as set by the &%primary_hostname%& option (or defaulted). This makes it
7794 possible to use the same configuration file on several different hosts that
7795 differ only in their names.
7796 .next
7797 .cindex "@[] in a domain list"
7798 .cindex "domain list" "matching local IP interfaces"
7799 .cindex "domain literal"
7800 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7801 in square brackets (as in an email address that contains a domain literal), but
7802 only if that IP address is recognized as local for email routing purposes. The
7803 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7804 control which of a host's several IP addresses are treated as local.
7805 In today's Internet, the use of domain literals is controversial.
7806 .next
7807 .cindex "@mx_any"
7808 .cindex "@mx_primary"
7809 .cindex "@mx_secondary"
7810 .cindex "domain list" "matching MX pointers to local host"
7811 If a pattern consists of the string &`@mx_any`& it matches any domain that
7812 has an MX record pointing to the local host or to any host that is listed in
7813 .oindex "&%hosts_treat_as_local%&"
7814 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7815 are similar, except that the first matches only when a primary MX target is the
7816 local host, and the second only when no primary MX target is the local host,
7817 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7818 preference value &-- there may of course be more than one of them.
7819
7820 The MX lookup that takes place when matching a pattern of this type is
7821 performed with the resolver options for widening names turned off. Thus, for
7822 example, a single-component domain will &'not'& be expanded by adding the
7823 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7824 options of the &(dnslookup)& router for a discussion of domain widening.
7825
7826 Sometimes you may want to ignore certain IP addresses when using one of these
7827 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7828 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7829 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7830 on a router). For example:
7831 .code
7832 domains = @mx_any/ignore=127.0.0.1
7833 .endd
7834 This example matches any domain that has an MX record pointing to one of
7835 the local host's IP addresses other than 127.0.0.1.
7836
7837 The list of IP addresses is in fact processed by the same code that processes
7838 host lists, so it may contain CIDR-coded network specifications and it may also
7839 contain negative items.
7840
7841 Because the list of IP addresses is a sublist within a domain list, you have to
7842 be careful about delimiters if there is more than one address. Like any other
7843 list, the default delimiter can be changed. Thus, you might have:
7844 .code
7845 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7846           an.other.domain : ...
7847 .endd
7848 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7849 involved, it is easiest to change the delimiter for the main list as well:
7850 .code
7851 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7852           an.other.domain ? ...
7853 .endd
7854 .next
7855 .cindex "asterisk" "in domain list"
7856 .cindex "domain list" "asterisk in"
7857 .cindex "domain list" "matching &""ends with""&"
7858 If a pattern starts with an asterisk, the remaining characters of the pattern
7859 are compared with the terminating characters of the domain. The use of &"*"& in
7860 domain lists differs from its use in partial matching lookups. In a domain
7861 list, the character following the asterisk need not be a dot, whereas partial
7862 matching works only in terms of dot-separated components. For example, a domain
7863 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7864 &'cipher.key.ex'&.
7865
7866 .next
7867 .cindex "regular expressions" "in domain list"
7868 .cindex "domain list" "matching regular expression"
7869 If a pattern starts with a circumflex character, it is treated as a regular
7870 expression, and matched against the domain using a regular expression matching
7871 function. The circumflex is treated as part of the regular expression.
7872 Email domains are case-independent, so this regular expression match is by
7873 default case-independent, but you can make it case-dependent by starting it
7874 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7875 are given in chapter &<<CHAPregexp>>&.
7876
7877 &*Warning*&: Because domain lists are expanded before being processed, you
7878 must escape any backslash and dollar characters in the regular expression, or
7879 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7880 it is not to be expanded (unless you really do want to build a regular
7881 expression by expansion, of course).
7882 .next
7883 .cindex "lookup" "in domain list"
7884 .cindex "domain list" "matching by lookup"
7885 If a pattern starts with the name of a single-key lookup type followed by a
7886 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7887 must be a file name in a suitable format for the lookup type. For example, for
7888 &"cdb;"& it must be an absolute path:
7889 .code
7890 domains = cdb;/etc/mail/local_domains.cdb
7891 .endd
7892 The appropriate type of lookup is done on the file using the domain name as the
7893 key. In most cases, the data that is looked up is not used; Exim is interested
7894 only in whether or not the key is present in the file. However, when a lookup
7895 is used for the &%domains%& option on a router
7896 or a &%domains%& condition in an ACL statement, the data is preserved in the
7897 &$domain_data$& variable and can be referred to in other router options or
7898 other statements in the same ACL.
7899
7900 .next
7901 Any of the single-key lookup type names may be preceded by
7902 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7903 .code
7904 domains = partial-dbm;/partial/domains
7905 .endd
7906 This causes partial matching logic to be invoked; a description of how this
7907 works is given in section &<<SECTpartiallookup>>&.
7908
7909 .next
7910 .cindex "asterisk" "in lookup type"
7911 Any of the single-key lookup types may be followed by an asterisk. This causes
7912 a default lookup for a key consisting of a single asterisk to be done if the
7913 original lookup fails. This is not a useful feature when using a domain list to
7914 select particular domains (because any domain would match), but it might have
7915 value if the result of the lookup is being used via the &$domain_data$&
7916 expansion variable.
7917 .next
7918 If the pattern starts with the name of a query-style lookup type followed by a
7919 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7920 pattern must be an appropriate query for the lookup type, as described in
7921 chapter &<<CHAPfdlookup>>&. For example:
7922 .code
7923 hold_domains = mysql;select domain from holdlist \
7924   where domain = '${quote_mysql:$domain}';
7925 .endd
7926 In most cases, the data that is looked up is not used (so for an SQL query, for
7927 example, it doesn't matter what field you select). Exim is interested only in
7928 whether or not the query succeeds. However, when a lookup is used for the
7929 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7930 variable and can be referred to in other options.
7931 .next
7932 .cindex "domain list" "matching literal domain name"
7933 If none of the above cases apply, a caseless textual comparison is made
7934 between the pattern and the domain.
7935 .endlist
7936
7937 Here is an example that uses several different kinds of pattern:
7938 .code
7939 domainlist funny_domains = \
7940   @ : \
7941   lib.unseen.edu : \
7942   *.foundation.fict.example : \
7943   \N^[1-2]\d{3}\.fict\.example$\N : \
7944   partial-dbm;/opt/data/penguin/book : \
7945   nis;domains.byname : \
7946   nisplus;[name=$domain,status=local],domains.org_dir
7947 .endd
7948 There are obvious processing trade-offs among the various matching modes. Using
7949 an asterisk is faster than a regular expression, and listing a few names
7950 explicitly probably is too. The use of a file or database lookup is expensive,
7951 but may be the only option if hundreds of names are required. Because the
7952 patterns are tested in order, it makes sense to put the most commonly matched
7953 patterns earlier.
7954
7955
7956
7957 .section "Host lists" "SECThostlist"
7958 .cindex "host list" "patterns in"
7959 .cindex "list" "host list"
7960 Host lists are used to control what remote hosts are allowed to do. For
7961 example, some hosts may be allowed to use the local host as a relay, and some
7962 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7963 two different ways, by name or by IP address. In a host list, some types of
7964 pattern are matched to a host name, and some are matched to an IP address.
7965 You need to be particularly careful with this when single-key lookups are
7966 involved, to ensure that the right value is being used as the key.
7967
7968
7969 .section "Special host list patterns" "SECID80"
7970 .cindex "empty item in hosts list"
7971 .cindex "host list" "empty string in"
7972 If a host list item is the empty string, it matches only when no remote host is
7973 involved. This is the case when a message is being received from a local
7974 process using SMTP on the standard input, that is, when a TCP/IP connection is
7975 not used.
7976
7977 .cindex "asterisk" "in host list"
7978 The special pattern &"*"& in a host list matches any host or no host. Neither
7979 the IP address nor the name is actually inspected.
7980
7981
7982
7983 .section "Host list patterns that match by IP address" "SECThoslispatip"
7984 .cindex "host list" "matching IP addresses"
7985 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7986 the incoming address actually appears in the IPv6 host as
7987 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7988 list, it is converted into a traditional IPv4 address first. (Not all operating
7989 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7990 concerns.)
7991
7992 The following types of pattern in a host list check the remote host by
7993 inspecting its IP address:
7994
7995 .ilist
7996 If the pattern is a plain domain name (not a regular expression, not starting
7997 with *, not a lookup of any kind), Exim calls the operating system function
7998 to find the associated IP address(es). Exim uses the newer
7999 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8000 This typically causes a forward DNS lookup of the name. The result is compared
8001 with the IP address of the subject host.
8002
8003 If there is a temporary problem (such as a DNS timeout) with the host name
8004 lookup, a temporary error occurs. For example, if the list is being used in an
8005 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8006 temporary SMTP error code. If no IP address can be found for the host name,
8007 what happens is described in section &<<SECTbehipnot>>& below.
8008
8009 .next
8010 .cindex "@ in a host list"
8011 If the pattern is &"@"&, the primary host name is substituted and used as a
8012 domain name, as just described.
8013
8014 .next
8015 If the pattern is an IP address, it is matched against the IP address of the
8016 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8017 IPv6 addresses can be given in colon-separated format, but the colons have to
8018 be doubled so as not to be taken as item separators when the default list
8019 separator is used. IPv6 addresses are recognized even when Exim is compiled
8020 without IPv6 support. This means that if they appear in a host list on an
8021 IPv4-only host, Exim will not treat them as host names. They are just addresses
8022 that can never match a client host.
8023
8024 .next
8025 .cindex "@[] in a host list"
8026 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8027 the local host. For example, if the local host is an IPv4 host with one
8028 interface address 10.45.23.56, these two ACL statements have the same effect:
8029 .code
8030 accept hosts = 127.0.0.1 : 10.45.23.56
8031 accept hosts = @[]
8032 .endd
8033 .next
8034 .cindex "CIDR notation"
8035 If the pattern is an IP address followed by a slash and a mask length (for
8036 example 10.11.42.0/24), it is matched against the IP address of the subject
8037 host under the given mask. This allows, an entire network of hosts to be
8038 included (or excluded) by a single item. The mask uses CIDR notation; it
8039 specifies the number of address bits that must match, starting from the most
8040 significant end of the address.
8041
8042 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8043 of a range of addresses. It is the number of bits in the network portion of the
8044 address. The above example specifies a 24-bit netmask, so it matches all 256
8045 addresses in the 10.11.42.0 network. An item such as
8046 .code
8047 192.168.23.236/31
8048 .endd
8049 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8050 32 for an IPv4 address is the same as no mask at all; just a single address
8051 matches.
8052
8053 Here is another example which shows an IPv4 and an IPv6 network:
8054 .code
8055 recipient_unqualified_hosts = 192.168.0.0/16: \
8056                               3ffe::ffff::836f::::/48
8057 .endd
8058 The doubling of list separator characters applies only when these items
8059 appear inline in a host list. It is not required when indirecting via a file.
8060 For example:
8061 .code
8062 recipient_unqualified_hosts = /opt/exim/unqualnets
8063 .endd
8064 could make use of a file containing
8065 .code
8066 172.16.0.0/12
8067 3ffe:ffff:836f::/48
8068 .endd
8069 to have exactly the same effect as the previous example. When listing IPv6
8070 addresses inline, it is usually more convenient to use the facility for
8071 changing separator characters. This list contains the same two networks:
8072 .code
8073 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8074                                  3ffe:ffff:836f::/48
8075 .endd
8076 The separator is changed to semicolon by the leading &"<;"& at the start of the
8077 list.
8078 .endlist
8079
8080
8081
8082 .section "Host list patterns for single-key lookups by host address" &&&
8083          "SECThoslispatsikey"
8084 .cindex "host list" "lookup of IP address"
8085 When a host is to be identified by a single-key lookup of its complete IP
8086 address, the pattern takes this form:
8087 .display
8088 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8089 .endd
8090 For example:
8091 .code
8092 hosts_lookup = net-cdb;/hosts-by-ip.db
8093 .endd
8094 The text form of the IP address of the subject host is used as the lookup key.
8095 IPv6 addresses are converted to an unabbreviated form, using lower case
8096 letters, with dots as separators because colon is the key terminator in
8097 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8098 quoting the keys, but this is a facility that was added later.] The data
8099 returned by the lookup is not used.
8100
8101 .cindex "IP address" "masking"
8102 .cindex "host list" "masked IP address"
8103 Single-key lookups can also be performed using masked IP addresses, using
8104 patterns of this form:
8105 .display
8106 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8107 .endd
8108 For example:
8109 .code
8110 net24-dbm;/networks.db
8111 .endd
8112 The IP address of the subject host is masked using <&'number'&> as the mask
8113 length. A textual string is constructed from the masked value, followed by the
8114 mask, and this is used as the lookup key. For example, if the host's IP address
8115 is 192.168.34.6, the key that is looked up for the above example is
8116 &"192.168.34.0/24"&.
8117
8118 When an IPv6 address is converted to a string, dots are normally used instead
8119 of colons, so that keys in &(lsearch)& files need not contain colons (which
8120 terminate &(lsearch)& keys). This was implemented some time before the ability
8121 to quote keys was made available in &(lsearch)& files. However, the more
8122 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8123 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8124 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8125 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8126 addresses are always used.
8127
8128 Ideally, it would be nice to tidy up this anomalous situation by changing to
8129 colons in all cases, given that quoting is now available for &(lsearch)&.
8130 However, this would be an incompatible change that might break some existing
8131 configurations.
8132
8133 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8134 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8135 the former case the key strings include the mask value, whereas in the latter
8136 case the IP address is used on its own.
8137
8138
8139
8140 .section "Host list patterns that match by host name" "SECThoslispatnam"
8141 .cindex "host" "lookup failures"
8142 .cindex "unknown host name"
8143 .cindex "host list" "matching host name"
8144 There are several types of pattern that require Exim to know the name of the
8145 remote host. These are either wildcard patterns or lookups by name. (If a
8146 complete hostname is given without any wildcarding, it is used to find an IP
8147 address to match against, as described in the section &<<SECThoslispatip>>&
8148 above.)
8149
8150 If the remote host name is not already known when Exim encounters one of these
8151 patterns, it has to be found from the IP address.
8152 Although many sites on the Internet are conscientious about maintaining reverse
8153 DNS data for their hosts, there are also many that do not do this.
8154 Consequently, a name cannot always be found, and this may lead to unwanted
8155 effects. Take care when configuring host lists with wildcarded name patterns.
8156 Consider what will happen if a name cannot be found.
8157
8158 Because of the problems of determining host names from IP addresses, matching
8159 against host names is not as common as matching against IP addresses.
8160
8161 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8162 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8163 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8164 are done can be changed by setting the &%host_lookup_order%& option. For
8165 security, once Exim has found one or more names, it looks up the IP addresses
8166 for these names and compares them with the IP address that it started with.
8167 Only those names whose IP addresses match are accepted. Any other names are
8168 discarded. If no names are left, Exim behaves as if the host name cannot be
8169 found. In the most common case there is only one name and one IP address.
8170
8171 There are some options that control what happens if a host name cannot be
8172 found. These are described in section &<<SECTbehipnot>>& below.
8173
8174 .cindex "host" "alias for"
8175 .cindex "alias for host"
8176 As a result of aliasing, hosts may have more than one name. When processing any
8177 of the following types of pattern, all the host's names are checked:
8178
8179 .ilist
8180 .cindex "asterisk" "in host list"
8181 If a pattern starts with &"*"& the remainder of the item must match the end of
8182 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8183 &'.b.c'&. This special simple form is provided because this is a very common
8184 requirement. Other kinds of wildcarding require the use of a regular
8185 expression.
8186 .next
8187 .cindex "regular expressions" "in host list"
8188 .cindex "host list" "regular expression in"
8189 If the item starts with &"^"& it is taken to be a regular expression which is
8190 matched against the host name. Host names are case-independent, so this regular
8191 expression match is by default case-independent, but you can make it
8192 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8193 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8194 example,
8195 .code
8196 ^(a|b)\.c\.d$
8197 .endd
8198 is a regular expression that matches either of the two hosts &'a.c.d'& or
8199 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8200 that backslash and dollar characters are not misinterpreted as part of the
8201 string expansion. The simplest way to do this is to use &`\N`& to mark that
8202 part of the string as non-expandable. For example:
8203 .code
8204 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8205 .endd
8206 &*Warning*&: If you want to match a complete host name, you must include the
8207 &`$`& terminating metacharacter in the regular expression, as in the above
8208 example. Without it, a match at the start of the host name is all that is
8209 required.
8210 .endlist
8211
8212
8213
8214
8215 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8216 .cindex "host" "lookup failures, permanent"
8217 While processing a host list, Exim may need to look up an IP address from a
8218 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8219 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8220 behaviour when it fails to find the information it is seeking is the same.
8221
8222 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8223 apply to temporary DNS errors, whose handling is described in the next section.
8224
8225 .cindex "&`+include_unknown`&"
8226 .cindex "&`+ignore_unknown`&"
8227 By default, Exim behaves as if the host does not match the list. This may not
8228 always be what you want to happen. To change Exim's behaviour, the special
8229 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8230 top level &-- they are not recognized in an indirected file).
8231
8232 .ilist
8233 If any item that follows &`+include_unknown`& requires information that
8234 cannot found, Exim behaves as if the host does match the list. For example,
8235 .code
8236 host_reject_connection = +include_unknown:*.enemy.ex
8237 .endd
8238 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8239 any hosts whose name it cannot find.
8240
8241 .next
8242 If any item that follows &`+ignore_unknown`& requires information that cannot
8243 be found, Exim ignores that item and proceeds to the rest of the list. For
8244 example:
8245 .code
8246 accept hosts = +ignore_unknown : friend.example : \
8247                192.168.4.5
8248 .endd
8249 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8250 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8251 name can be found for 192.168.4.5, it is rejected.
8252 .endlist
8253
8254 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8255 list. The effect of each one lasts until the next, or until the end of the
8256 list.
8257
8258
8259 .section "Temporary DNS errors when looking up host information" &&&
8260          "SECTtemdnserr"
8261 .cindex "host" "lookup failures, temporary"
8262 .cindex "&`+include_defer`&"
8263 .cindex "&`+ignore_defer`&"
8264 A temporary DNS lookup failure normally causes a defer action (except when
8265 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8266 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8267 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8268 section. These options should be used with care, probably only in non-critical
8269 host lists such as whitelists.
8270
8271
8272
8273 .section "Host list patterns for single-key lookups by host name" &&&
8274          "SECThoslispatnamsk"
8275 .cindex "unknown host name"
8276 .cindex "host list" "matching host name"
8277 If a pattern is of the form
8278 .display
8279 <&'single-key-search-type'&>;<&'search-data'&>
8280 .endd
8281 for example
8282 .code
8283 dbm;/host/accept/list
8284 .endd
8285 a single-key lookup is performed, using the host name as its key. If the
8286 lookup succeeds, the host matches the item. The actual data that is looked up
8287 is not used.
8288
8289 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8290 keys in the file, not IP addresses. If you want to do lookups based on IP
8291 addresses, you must precede the search type with &"net-"& (see section
8292 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8293 two items in the same list, one doing an address lookup and one doing a name
8294 lookup, both using the same file.
8295
8296
8297
8298 .section "Host list patterns for query-style lookups" "SECID81"
8299 If a pattern is of the form
8300 .display
8301 <&'query-style-search-type'&>;<&'query'&>
8302 .endd
8303 the query is obeyed, and if it succeeds, the host matches the item. The actual
8304 data that is looked up is not used. The variables &$sender_host_address$& and
8305 &$sender_host_name$& can be used in the query. For example:
8306 .code
8307 hosts_lookup = pgsql;\
8308   select ip from hostlist where ip='$sender_host_address'
8309 .endd
8310 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8311 can use the &%sg%& expansion item to change this if you need to. If you want to
8312 use masked IP addresses in database queries, you can use the &%mask%& expansion
8313 operator.
8314
8315 If the query contains a reference to &$sender_host_name$&, Exim automatically
8316 looks up the host name if has not already done so. (See section
8317 &<<SECThoslispatnam>>& for comments on finding host names.)
8318
8319 Historical note: prior to release 4.30, Exim would always attempt to find a
8320 host name before running the query, unless the search type was preceded by
8321 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8322 still recognized for query-style lookups, but its presence or absence has no
8323 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8324 See section &<<SECThoslispatsikey>>&.)
8325
8326
8327
8328 .section "Mixing wildcarded host names and addresses in host lists" &&&
8329          "SECTmixwilhos"
8330 .cindex "host list" "mixing names and addresses in"
8331 If you have name lookups or wildcarded host names and IP addresses in the same
8332 host list, you should normally put the IP addresses first. For example, in an
8333 ACL you could have:
8334 .code
8335 accept hosts = 10.9.8.7 : *.friend.example
8336 .endd
8337 The reason for this lies in the left-to-right way that Exim processes lists.
8338 It can test IP addresses without doing any DNS lookups, but when it reaches an
8339 item that requires a host name, it fails if it cannot find a host name to
8340 compare with the pattern. If the above list is given in the opposite order, the
8341 &%accept%& statement fails for a host whose name cannot be found, even if its
8342 IP address is 10.9.8.7.
8343
8344 If you really do want to do the name check first, and still recognize the IP
8345 address, you can rewrite the ACL like this:
8346 .code
8347 accept hosts = *.friend.example
8348 accept hosts = 10.9.8.7
8349 .endd
8350 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8351 &<<CHAPACL>>& for details of ACLs.
8352
8353
8354
8355
8356
8357 .section "Address lists" "SECTaddresslist"
8358 .cindex "list" "address list"
8359 .cindex "address list" "empty item"
8360 .cindex "address list" "patterns"
8361 Address lists contain patterns that are matched against mail addresses. There
8362 is one special case to be considered: the sender address of a bounce message is
8363 always empty. You can test for this by providing an empty item in an address
8364 list. For example, you can set up a router to process bounce messages by
8365 using this option setting:
8366 .code
8367 senders = :
8368 .endd
8369 The presence of the colon creates an empty item. If you do not provide any
8370 data, the list is empty and matches nothing. The empty sender can also be
8371 detected by a regular expression that matches an empty string,
8372 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8373
8374 Non-empty items in an address list can be straightforward email addresses. For
8375 example:
8376 .code
8377 senders = jbc@askone.example : hs@anacreon.example
8378 .endd
8379 A certain amount of wildcarding is permitted. If a pattern contains an @
8380 character, but is not a regular expression and does not begin with a
8381 semicolon-terminated lookup type (described below), the local part of the
8382 subject address is compared with the local part of the pattern, which may start
8383 with an asterisk. If the local parts match, the domain is checked in exactly
8384 the same way as for a pattern in a domain list. For example, the domain can be
8385 wildcarded, refer to a named list, or be a lookup:
8386 .code
8387 deny senders = *@*.spamming.site:\
8388                *@+hostile_domains:\
8389                bozo@partial-lsearch;/list/of/dodgy/sites:\
8390                *@dbm;/bad/domains.db
8391 .endd
8392 .cindex "local part" "starting with !"
8393 .cindex "address list" "local part starting with !"
8394 If a local part that begins with an exclamation mark is required, it has to be
8395 specified using a regular expression, because otherwise the exclamation mark is
8396 treated as a sign of negation, as is standard in lists.
8397
8398 If a non-empty pattern that is not a regular expression or a lookup does not
8399 contain an @ character, it is matched against the domain part of the subject
8400 address. The only two formats that are recognized this way are a literal
8401 domain, or a domain pattern that starts with *. In both these cases, the effect
8402 is the same as if &`*@`& preceded the pattern. For example:
8403 .code
8404 deny senders = enemy.domain : *.enemy.domain
8405 .endd
8406
8407 The following kinds of more complicated address list pattern can match any
8408 address, including the empty address that is characteristic of bounce message
8409 senders:
8410
8411 .ilist
8412 .cindex "regular expressions" "in address list"
8413 .cindex "address list" "regular expression in"
8414 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8415 done against the complete address, with the pattern as the regular expression.
8416 You must take care that backslash and dollar characters are not misinterpreted
8417 as part of the string expansion. The simplest way to do this is to use &`\N`&
8418 to mark that part of the string as non-expandable. For example:
8419 .code
8420 deny senders = \N^.*this.*@example\.com$\N : \
8421                \N^\d{8}.+@spamhaus.example$\N : ...
8422 .endd
8423 The &`\N`& sequences are removed by the expansion, so these items do indeed
8424 start with &"^"& by the time they are being interpreted as address patterns.
8425
8426 .next
8427 .cindex "address list" "lookup for complete address"
8428 Complete addresses can be looked up by using a pattern that starts with a
8429 lookup type terminated by a semicolon, followed by the data for the lookup. For
8430 example:
8431 .code
8432 deny senders = cdb;/etc/blocked.senders : \
8433   mysql;select address from blocked where \
8434   address='${quote_mysql:$sender_address}'
8435 .endd
8436 Both query-style and single-key lookup types can be used. For a single-key
8437 lookup type, Exim uses the complete address as the key. However, empty keys are
8438 not supported for single-key lookups, so a match against the empty address
8439 always fails. This restriction does not apply to query-style lookups.
8440
8441 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8442 cannot be used, and is ignored if specified, with an entry being written to the
8443 panic log.
8444 .cindex "*@ with single-key lookup"
8445 However, you can configure lookup defaults, as described in section
8446 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8447 default. For example, with this lookup:
8448 .code
8449 accept senders = lsearch*@;/some/file
8450 .endd
8451 the file could contains lines like this:
8452 .code
8453 user1@domain1.example
8454 *@domain2.example
8455 .endd
8456 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8457 that are tried is:
8458 .code
8459 nimrod@jaeger.example
8460 *@jaeger.example
8461 *
8462 .endd
8463 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8464 would mean that every address matches, thus rendering the test useless.
8465
8466 &*Warning 2*&: Do not confuse these two kinds of item:
8467 .code
8468 deny recipients = dbm*@;/some/file
8469 deny recipients = *@dbm;/some/file
8470 .endd
8471 The first does a whole address lookup, with defaulting, as just described,
8472 because it starts with a lookup type. The second matches the local part and
8473 domain independently, as described in a bullet point below.
8474 .endlist
8475
8476
8477 The following kinds of address list pattern can match only non-empty addresses.
8478 If the subject address is empty, a match against any of these pattern types
8479 always fails.
8480
8481
8482 .ilist
8483 .cindex "@@ with single-key lookup"
8484 .cindex "address list" "@@ lookup type"
8485 .cindex "address list" "split local part and domain"
8486 If a pattern starts with &"@@"& followed by a single-key lookup item
8487 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8488 split into a local part and a domain. The domain is looked up in the file. If
8489 it is not found, there is no match. If it is found, the data that is looked up
8490 from the file is treated as a colon-separated list of local part patterns, each
8491 of which is matched against the subject local part in turn.
8492
8493 .cindex "asterisk" "in address list"
8494 The lookup may be a partial one, and/or one involving a search for a default
8495 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8496 patterns that are looked up can be regular expressions or begin with &"*"&, or
8497 even be further lookups. They may also be independently negated. For example,
8498 with
8499 .code
8500 deny senders = @@dbm;/etc/reject-by-domain
8501 .endd
8502 the data from which the DBM file is built could contain lines like
8503 .code
8504 baddomain.com:  !postmaster : *
8505 .endd
8506 to reject all senders except &%postmaster%& from that domain.
8507
8508 .cindex "local part" "starting with !"
8509 If a local part that actually begins with an exclamation mark is required, it
8510 has to be specified using a regular expression. In &(lsearch)& files, an entry
8511 may be split over several lines by indenting the second and subsequent lines,
8512 but the separating colon must still be included at line breaks. White space
8513 surrounding the colons is ignored. For example:
8514 .code
8515 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8516  spammer3 : spammer4
8517 .endd
8518 As in all colon-separated lists in Exim, a colon can be included in an item by
8519 doubling.
8520
8521 If the last item in the list starts with a right angle-bracket, the remainder
8522 of the item is taken as a new key to look up in order to obtain a continuation
8523 list of local parts. The new key can be any sequence of characters. Thus one
8524 might have entries like
8525 .code
8526 aol.com: spammer1 : spammer 2 : >*
8527 xyz.com: spammer3 : >*
8528 *:       ^\d{8}$
8529 .endd
8530 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8531 local parts for all domains, in addition to the specific local parts listed for
8532 each domain. Of course, using this feature costs another lookup each time a
8533 chain is followed, but the effort needed to maintain the data is reduced.
8534
8535 .cindex "loop" "in lookups"
8536 It is possible to construct loops using this facility, and in order to catch
8537 them, the chains may be no more than fifty items long.
8538
8539 .next
8540 The @@<&'lookup'&> style of item can also be used with a query-style
8541 lookup, but in this case, the chaining facility is not available. The lookup
8542 can only return a single list of local parts.
8543 .endlist
8544
8545 &*Warning*&: There is an important difference between the address list items
8546 in these two examples:
8547 .code
8548 senders = +my_list
8549 senders = *@+my_list
8550 .endd
8551 In the first one, &`my_list`& is a named address list, whereas in the second
8552 example it is a named domain list.
8553
8554
8555
8556
8557 .section "Case of letters in address lists" "SECTcasletadd"
8558 .cindex "case of local parts"
8559 .cindex "address list" "case forcing"
8560 .cindex "case forcing in address lists"
8561 Domains in email addresses are always handled caselessly, but for local parts
8562 case may be significant on some systems (see &%caseful_local_part%& for how
8563 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8564 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8565 blocking lists should be done in a case-independent manner. Since most address
8566 lists in Exim are used for this kind of control, Exim attempts to do this by
8567 default.
8568
8569 The domain portion of an address is always lowercased before matching it to an
8570 address list. The local part is lowercased by default, and any string
8571 comparisons that take place are done caselessly. This means that the data in
8572 the address list itself, in files included as plain file names, and in any file
8573 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8574 keys in files that are looked up by a search type other than &(lsearch)& (which
8575 works caselessly) must be in lower case, because these lookups are not
8576 case-independent.
8577
8578 .cindex "&`+caseful`&"
8579 To allow for the possibility of caseful address list matching, if an item in
8580 an address list is the string &"+caseful"&, the original case of the local
8581 part is restored for any comparisons that follow, and string comparisons are no
8582 longer case-independent. This does not affect the domain, which remains in
8583 lower case. However, although independent matches on the domain alone are still
8584 performed caselessly, regular expressions that match against an entire address
8585 become case-sensitive after &"+caseful"& has been seen.
8586
8587
8588
8589 .section "Local part lists" "SECTlocparlis"
8590 .cindex "list" "local part list"
8591 .cindex "local part" "list"
8592 Case-sensitivity in local part lists is handled in the same way as for address
8593 lists, as just described. The &"+caseful"& item can be used if required. In a
8594 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8595 set false, the subject is lowercased and the matching is initially
8596 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8597 matching in the local part list, but not elsewhere in the router. If
8598 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8599 option is case-sensitive from the start.
8600
8601 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8602 comments are handled in the same way as address lists &-- they are recognized
8603 only if the # is preceded by white space or the start of the line.
8604 Otherwise, local part lists are matched in the same way as domain lists, except
8605 that the special items that refer to the local host (&`@`&, &`@[]`&,
8606 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8607 Refer to section &<<SECTdomainlist>>& for details of the other available item
8608 types.
8609 .ecindex IIDdohoadli
8610
8611
8612
8613
8614 . ////////////////////////////////////////////////////////////////////////////
8615 . ////////////////////////////////////////////////////////////////////////////
8616
8617 .chapter "String expansions" "CHAPexpand"
8618 .scindex IIDstrexp "expansion" "of strings"
8619 Many strings in Exim's run time configuration are expanded before use. Some of
8620 them are expanded every time they are used; others are expanded only once.
8621
8622 When a string is being expanded it is copied verbatim from left to right except
8623 when a dollar or backslash character is encountered. A dollar specifies the
8624 start of a portion of the string that is interpreted and replaced as described
8625 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8626 escape character, as described in the following section.
8627
8628 Whether a string is expanded depends upon the context.  Usually this is solely
8629 dependent upon the option for which a value is sought; in this documentation,
8630 options for which string expansion is performed are marked with &dagger; after
8631 the data type.  ACL rules always expand strings.  A couple of expansion
8632 conditions do not expand some of the brace-delimited branches, for security
8633 reasons.
8634
8635
8636
8637 .section "Literal text in expanded strings" "SECTlittext"
8638 .cindex "expansion" "including literal text"
8639 An uninterpreted dollar can be included in an expanded string by putting a
8640 backslash in front of it. A backslash can be used to prevent any special
8641 character being treated specially in an expansion, including backslash itself.
8642 If the string appears in quotes in the configuration file, two backslashes are
8643 required because the quotes themselves cause interpretation of backslashes when
8644 the string is read in (see section &<<SECTstrings>>&).
8645
8646 .cindex "expansion" "non-expandable substrings"
8647 A portion of the string can specified as non-expandable by placing it between
8648 two occurrences of &`\N`&. This is particularly useful for protecting regular
8649 expressions, which often contain backslashes and dollar signs. For example:
8650 .code
8651 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8652 .endd
8653 On encountering the first &`\N`&, the expander copies subsequent characters
8654 without interpretation until it reaches the next &`\N`& or the end of the
8655 string.
8656
8657
8658
8659 .section "Character escape sequences in expanded strings" "SECID82"
8660 .cindex "expansion" "escape sequences"
8661 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8662 expanded string is recognized as an escape sequence for the character newline,
8663 carriage return, or tab, respectively. A backslash followed by up to three
8664 octal digits is recognized as an octal encoding for a single character, and a
8665 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8666 encoding.
8667
8668 These escape sequences are also recognized in quoted strings when they are read
8669 in. Their interpretation in expansions as well is useful for unquoted strings,
8670 and for other cases such as looked-up strings that are then expanded.
8671
8672
8673 .section "Testing string expansions" "SECID83"
8674 .cindex "expansion" "testing"
8675 .cindex "testing" "string expansion"
8676 .oindex "&%-be%&"
8677 Many expansions can be tested by calling Exim with the &%-be%& option. This
8678 takes the command arguments, or lines from the standard input if there are no
8679 arguments, runs them through the string expansion code, and writes the results
8680 to the standard output. Variables based on configuration values are set up, but
8681 since no message is being processed, variables such as &$local_part$& have no
8682 value. Nevertheless the &%-be%& option can be useful for checking out file and
8683 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8684 and &%nhash%&.
8685
8686 Exim gives up its root privilege when it is called with the &%-be%& option, and
8687 instead runs under the uid and gid it was called with, to prevent users from
8688 using &%-be%& for reading files to which they do not have access.
8689
8690 .oindex "&%-bem%&"
8691 If you want to test expansions that include variables whose values are taken
8692 from a message, there are two other options that can be used. The &%-bem%&
8693 option is like &%-be%& except that it is followed by a file name. The file is
8694 read as a message before doing the test expansions. For example:
8695 .code
8696 exim -bem /tmp/test.message '$h_subject:'
8697 .endd
8698 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8699 Exim message identifier. For example:
8700 .code
8701 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8702 .endd
8703 This loads the message from Exim's spool before doing the test expansions, and
8704 is therefore restricted to admin users.
8705
8706
8707 .section "Forced expansion failure" "SECTforexpfai"
8708 .cindex "expansion" "forced failure"
8709 A number of expansions that are described in the following section have
8710 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8711 (which are sometimes called &"curly brackets"&). Which of the two strings is
8712 used depends on some condition that is evaluated as part of the expansion. If,
8713 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8714 the entire string expansion fails in a way that can be detected by the code
8715 that requested the expansion. This is called &"forced expansion failure"&, and
8716 its consequences depend on the circumstances. In some cases it is no different
8717 from any other expansion failure, but in others a different action may be
8718 taken. Such variations are mentioned in the documentation of the option that is
8719 being expanded.
8720
8721
8722
8723
8724 .section "Expansion items" "SECTexpansionitems"
8725 The following items are recognized in expanded strings. White space may be used
8726 between sub-items that are keywords or substrings enclosed in braces inside an
8727 outer set of braces, to improve readability. &*Warning*&: Within braces,
8728 white space is significant.
8729
8730 .vlist
8731 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8732 .cindex "expansion" "variables"
8733 Substitute the contents of the named variable, for example:
8734 .code
8735 $local_part
8736 ${domain}
8737 .endd
8738 The second form can be used to separate the name from subsequent alphanumeric
8739 characters. This form (using braces) is available only for variables; it does
8740 &'not'& apply to message headers. The names of the variables are given in
8741 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8742 given, the expansion fails.
8743
8744 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8745 .cindex "expansion" "operators"
8746 The string is first itself expanded, and then the operation specified by
8747 <&'op'&> is applied to it. For example:
8748 .code
8749 ${lc:$local_part}
8750 .endd
8751 The string starts with the first character after the colon, which may be
8752 leading white space. A list of operators is given in section &<<SECTexpop>>&
8753 below. The operator notation is used for simple expansion items that have just
8754 one argument, because it reduces the number of braces and therefore makes the
8755 string easier to understand.
8756
8757 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8758 This item inserts &"basic"& header lines. It is described with the &%header%&
8759 expansion item below.
8760
8761
8762 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8763 .cindex "expansion" "calling an acl"
8764 .cindex "&%acl%&" "call from expansion"
8765 The name and zero to nine argument strings are first expanded separately.  The expanded
8766 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8767 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8768 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8769 and may use the variables; if another acl expansion is used the values
8770 are overwritten.  If the ACL sets
8771 a value using a "message =" modifier and returns accept or deny, the value becomes
8772 the result of the expansion.
8773 If no message was set and the ACL returned accept or deny
8774 the value is an empty string.
8775 If the ACL returned defer the result is a forced-fail.  Otherwise the expansion fails.
8776
8777
8778 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8779        {*&<&'arg'&>&*}...}*&"
8780 .cindex &%dlfunc%&
8781 This expansion dynamically loads and then calls a locally-written C function.
8782 This functionality is available only if Exim is compiled with
8783 .code
8784 EXPAND_DLFUNC=yes
8785 .endd
8786 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8787 object so that it doesn't reload the same object file in the same Exim process
8788 (but of course Exim does start new processes frequently).
8789
8790 There may be from zero to eight arguments to the function. When compiling
8791 a local function that is to be called in this way, &_local_scan.h_& should be
8792 included. The Exim variables and functions that are defined by that API
8793 are also available for dynamically loaded functions. The function itself
8794 must have the following type:
8795 .code
8796 int dlfunction(uschar **yield, int argc, uschar *argv[])
8797 .endd
8798 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8799 function should return one of the following values:
8800
8801 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8802 into the expanded string that is being built.
8803
8804 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8805 from &'yield'&, if it is set.
8806
8807 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8808 taken from &'yield'& if it is set.
8809
8810 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8811
8812 When compiling a function that is to be used in this way with gcc,
8813 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8814 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8815
8816 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8817        {*&<&'string3'&>&*}}*&"
8818 .cindex "expansion" "extracting substrings by key"
8819 .cindex "&%extract%&" "substrings by key"
8820 The key and <&'string1'&> are first expanded separately. Leading and trailing
8821 white space is removed from the key (but not from any of the strings). The key
8822 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8823 form:
8824 .display
8825 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8826 .endd
8827 .vindex "&$value$&"
8828 where the equals signs and spaces (but not both) are optional. If any of the
8829 values contain white space, they must be enclosed in double quotes, and any
8830 values that are enclosed in double quotes are subject to escape processing as
8831 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8832 for the value that corresponds to the key. The search is case-insensitive. If
8833 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8834 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8835 variable &$value$& contains the value that has been extracted. Afterwards, it
8836 is restored to any previous value it might have had.
8837
8838 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8839 key is not found. If {<&'string2'&>} is also omitted, the value that was
8840 extracted is used. Thus, for example, these two expansions are identical, and
8841 yield &"2001"&:
8842 .code
8843 ${extract{gid}{uid=1984 gid=2001}}
8844 ${extract{gid}{uid=1984 gid=2001}{$value}}
8845 .endd
8846 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8847 appear, for example:
8848 .code
8849 ${extract{Z}{A=... B=...}{$value} fail }
8850 .endd
8851 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8852 {<&'string2'&>} must be present for &"fail"& to be recognized.
8853
8854
8855 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8856         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8857 .cindex "expansion" "extracting substrings by number"
8858 .cindex "&%extract%&" "substrings by number"
8859 The <&'number'&> argument must consist entirely of decimal digits,
8860 apart from leading and trailing white space, which is ignored.
8861 This is what distinguishes this form of &%extract%& from the previous kind. It
8862 behaves in the same way, except that, instead of extracting a named field, it
8863 extracts from <&'string1'&> the field whose number is given as the first
8864 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8865 <&'string3'&> as before.
8866
8867 The fields in the string are separated by any one of the characters in the
8868 separator string. These may include space or tab characters.
8869 The first field is numbered one. If the number is negative, the fields are
8870 counted from the end of the string, with the rightmost one numbered -1. If the
8871 number given is zero, the entire string is returned. If the modulus of the
8872 number is greater than the number of fields in the string, the result is the
8873 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8874 provided. For example:
8875 .code
8876 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8877 .endd
8878 yields &"42"&, and
8879 .code
8880 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8881 .endd
8882 yields &"99"&. Two successive separators mean that the field between them is
8883 empty (for example, the fifth field above).
8884
8885
8886 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8887 .cindex "list" "selecting by condition"
8888 .cindex "expansion" "selecting from list by condition"
8889 .vindex "&$item$&"
8890 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8891 default, but the separator can be changed in the usual way. For each item
8892 in this list, its value is place in &$item$&, and then the condition is
8893 evaluated. If the condition is true, &$item$& is added to the output as an
8894 item in a new list; if the condition is false, the item is discarded. The
8895 separator used for the output list is the same as the one used for the
8896 input, but a separator setting is not included in the output. For example:
8897 .code
8898 ${filter{a:b:c}{!eq{$item}{b}}
8899 .endd
8900 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8901 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8902
8903
8904 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8905 .cindex "hash function" "textual"
8906 .cindex "expansion" "textual hash"
8907 This is a textual hashing function, and was the first to be implemented in
8908 early versions of Exim. In current releases, there are other hashing functions
8909 (numeric, MD5, and SHA-1), which are described below.
8910
8911 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8912 <&'n'&>. If you are using fixed values for these numbers, that is, if
8913 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8914 use the simpler operator notation that avoids some of the braces:
8915 .code
8916 ${hash_<n>_<m>:<string>}
8917 .endd
8918 The second number is optional (in both notations). If <&'n'&> is greater than
8919 or equal to the length of the string, the expansion item returns the string.
8920 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8921 function to the string. The new string consists of characters taken from the
8922 first <&'m'&> characters of the string
8923 .code
8924 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8925 .endd
8926 If <&'m'&> is not present the value 26 is used, so that only lower case
8927 letters appear. For example:
8928 .display
8929 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8930 &`$hash{5}{monty}}           `&   yields  &`monty`&
8931 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8932 .endd
8933
8934 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8935         &*$h_*&<&'header&~name'&>&*:*&" &&&
8936        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8937         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8938        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8939         &*$rh_*&<&'header&~name'&>&*:*&"
8940 .cindex "expansion" "header insertion"
8941 .vindex "&$header_$&"
8942 .vindex "&$bheader_$&"
8943 .vindex "&$rheader_$&"
8944 .cindex "header lines" "in expansion strings"
8945 .cindex "header lines" "character sets"
8946 .cindex "header lines" "decoding"
8947 Substitute the contents of the named message header line, for example
8948 .code
8949 $header_reply-to:
8950 .endd
8951 The newline that terminates a header line is not included in the expansion, but
8952 internal newlines (caused by splitting the header line over several physical
8953 lines) may be present.
8954
8955 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8956 the data in the header line is interpreted.
8957
8958 .ilist
8959 .cindex "white space" "in header lines"
8960 &%rheader%& gives the original &"raw"& content of the header line, with no
8961 processing at all, and without the removal of leading and trailing white space.
8962
8963 .next
8964 .cindex "base64 encoding" "in header lines"
8965 &%bheader%& removes leading and trailing white space, and then decodes base64
8966 or quoted-printable MIME &"words"& within the header text, but does no
8967 character set translation. If decoding of what looks superficially like a MIME
8968 &"word"& fails, the raw string is returned. If decoding
8969 .cindex "binary zero" "in header line"
8970 produces a binary zero character, it is replaced by a question mark &-- this is
8971 what Exim does for binary zeros that are actually received in header lines.
8972
8973 .next
8974 &%header%& tries to translate the string as decoded by &%bheader%& to a
8975 standard character set. This is an attempt to produce the same string as would
8976 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8977 returned. Translation is attempted only on operating systems that support the
8978 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8979 a system Makefile or in &_Local/Makefile_&.
8980 .endlist ilist
8981
8982 In a filter file, the target character set for &%header%& can be specified by a
8983 command of the following form:
8984 .code
8985 headers charset "UTF-8"
8986 .endd
8987 This command affects all references to &$h_$& (or &$header_$&) expansions in
8988 subsequently obeyed filter commands. In the absence of this command, the target
8989 character set in a filter is taken from the setting of the &%headers_charset%&
8990 option in the runtime configuration. The value of this option defaults to the
8991 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8992 ISO-8859-1.
8993
8994 Header names follow the syntax of RFC 2822, which states that they may contain
8995 any printing characters except space and colon. Consequently, curly brackets
8996 &'do not'& terminate header names, and should not be used to enclose them as
8997 if they were variables. Attempting to do so causes a syntax error.
8998
8999 Only header lines that are common to all copies of a message are visible to
9000 this mechanism. These are the original header lines that are received with the
9001 message, and any that are added by an ACL statement or by a system
9002 filter. Header lines that are added to a particular copy of a message by a
9003 router or transport are not accessible.
9004
9005 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9006 before the DATA ACL, because the header structure is not set up until the
9007 message is received. Header lines that are added in a RCPT ACL (for example)
9008 are saved until the message's incoming header lines are available, at which
9009 point they are added. When a DATA ACL is running, however, header lines added
9010 by earlier ACLs are visible.
9011
9012 Upper case and lower case letters are synonymous in header names. If the
9013 following character is white space, the terminating colon may be omitted, but
9014 this is not recommended, because you may then forget it when it is needed. When
9015 white space terminates the header name, it is included in the expanded string.
9016 If the message does not contain the given header, the expansion item is
9017 replaced by an empty string. (See the &%def%& condition in section
9018 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9019
9020 If there is more than one header with the same name, they are all concatenated
9021 to form the substitution string, up to a maximum length of 64K. Unless
9022 &%rheader%& is being used, leading and trailing white space is removed from
9023 each header before concatenation, and a completely empty header is ignored. A
9024 newline character is then inserted between non-empty headers, but there is no
9025 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9026 those headers that contain lists of addresses, a comma is also inserted at the
9027 junctions between headers. This does not happen for the &%rheader%& expansion.
9028
9029
9030 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9031 .cindex "expansion" "hmac hashing"
9032 .cindex &%hmac%&
9033 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9034 shared secret and some text into a message authentication code, as specified in
9035 RFC 2104. This differs from &`${md5:secret_text...}`& or
9036 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9037 cryptographic hash, allowing for authentication that is not possible with MD5
9038 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9039 present. For example:
9040 .code
9041 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9042 .endd
9043 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9044 produces:
9045 .code
9046 dd97e3ba5d1a61b5006108f8c8252953
9047 .endd
9048 As an example of how this might be used, you might put in the main part of
9049 an Exim configuration:
9050 .code
9051 SPAMSCAN_SECRET=cohgheeLei2thahw
9052 .endd
9053 In a router or a transport you could then have:
9054 .code
9055 headers_add = \
9056   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9057   ${hmac{md5}{SPAMSCAN_SECRET}\
9058   {${primary_hostname},${message_exim_id},$h_message-id:}}
9059 .endd
9060 Then given a message, you can check where it was scanned by looking at the
9061 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9062 this header line is authentic by recomputing the authentication code from the
9063 host name, message ID and the &'Message-id:'& header line. This can be done
9064 using Exim's &%-be%& option, or by other means, for example by using the
9065 &'hmac_md5_hex()'& function in Perl.
9066
9067
9068 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9069 .cindex "expansion" "conditional"
9070 .cindex "&%if%&, expansion item"
9071 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9072 item; otherwise <&'string2'&> is used. The available conditions are described
9073 in section &<<SECTexpcond>>& below. For example:
9074 .code
9075 ${if eq {$local_part}{postmaster} {yes}{no} }
9076 .endd
9077 The second string need not be present; if it is not and the condition is not
9078 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9079 be present instead of the second string (without any curly brackets). In this
9080 case, the expansion is forced to fail if the condition is not true (see section
9081 &<<SECTforexpfai>>&).
9082
9083 If both strings are omitted, the result is the string &`true`& if the condition
9084 is true, and the empty string if the condition is false. This makes it less
9085 cumbersome to write custom ACL and router conditions. For example, instead of
9086 .code
9087 condition = ${if >{$acl_m4}{3}{true}{false}}
9088 .endd
9089 you can use
9090 .code
9091 condition = ${if >{$acl_m4}{3}}
9092 .endd
9093
9094 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9095 .cindex "expansion" "string truncation"
9096 .cindex "&%length%& expansion item"
9097 The &%length%& item is used to extract the initial portion of a string. Both
9098 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9099 you are using a fixed value for the number, that is, if <&'string1'&> does not
9100 change when expanded, you can use the simpler operator notation that avoids
9101 some of the braces:
9102 .code
9103 ${length_<n>:<string>}
9104 .endd
9105 The result of this item is either the first <&'n'&> characters or the whole
9106 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9107 &%strlen%&, which gives the length of a string.
9108
9109
9110 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9111         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9112 This is the first of one of two different types of lookup item, which are both
9113 described in the next item.
9114
9115 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9116         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9117 .cindex "expansion" "lookup in"
9118 .cindex "file" "lookups"
9119 .cindex "lookup" "in expanded string"
9120 The two forms of lookup item specify data lookups in files and databases, as
9121 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9122 lookups, and the second is used for query-style lookups. The <&'key'&>,
9123 <&'file'&>, and <&'query'&> strings are expanded before use.
9124
9125 If there is any white space in a lookup item which is part of a filter command,
9126 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9127 other place where white space is significant, the lookup item must be enclosed
9128 in double quotes. The use of data lookups in users' filter files may be locked
9129 out by the system administrator.
9130
9131 .vindex "&$value$&"
9132 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9133 During its expansion, the variable &$value$& contains the data returned by the
9134 lookup. Afterwards it reverts to the value it had previously (at the outer
9135 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9136 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9137 string on failure. If <&'string2'&> is provided, it can itself be a nested
9138 lookup, thus providing a mechanism for looking up a default value when the
9139 original lookup fails.
9140
9141 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9142 data for the outer lookup while the parameters of the second lookup are
9143 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9144 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9145 appear, and in this case, if the lookup fails, the entire expansion is forced
9146 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9147 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9148 successful lookup, and nothing in the case of failure.
9149
9150 For single-key lookups, the string &"partial"& is permitted to precede the
9151 search type in order to do partial matching, and * or *@ may follow a search
9152 type to request default lookups if the key does not match (see sections
9153 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9154
9155 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9156 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9157 and non-wild parts of the key during the expansion of the replacement text.
9158 They return to their previous values at the end of the lookup item.
9159
9160 This example looks up the postmaster alias in the conventional alias file:
9161 .code
9162 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9163 .endd
9164 This example uses NIS+ to look up the full name of the user corresponding to
9165 the local part of an address, forcing the expansion to fail if it is not found:
9166 .code
9167 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9168   {$value}fail}
9169 .endd
9170
9171
9172 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9173 .cindex "expansion" "list creation"
9174 .vindex "&$item$&"
9175 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9176 default, but the separator can be changed in the usual way. For each item
9177 in this list, its value is place in &$item$&, and then <&'string2'&> is
9178 expanded and added to the output as an item in a new list. The separator used
9179 for the output list is the same as the one used for the input, but a separator
9180 setting is not included in the output. For example:
9181 .code
9182 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9183 .endd
9184 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9185 value of &$item$& is restored to what it was before. See also the &*filter*&
9186 and &*reduce*& expansion items.
9187
9188 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9189 .cindex "expansion" "numeric hash"
9190 .cindex "hash function" "numeric"
9191 The three strings are expanded; the first two must yield numbers. Call them
9192 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9193 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9194 can use the simpler operator notation that avoids some of the braces:
9195 .code
9196 ${nhash_<n>_<m>:<string>}
9197 .endd
9198 The second number is optional (in both notations). If there is only one number,
9199 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9200 processed by a div/mod hash function that returns two numbers, separated by a
9201 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9202 example,
9203 .code
9204 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9205 .endd
9206 returns the string &"6/33"&.
9207
9208
9209
9210 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9211 .cindex "Perl" "use in expanded string"
9212 .cindex "expansion" "calling Perl from"
9213 This item is available only if Exim has been built to include an embedded Perl
9214 interpreter. The subroutine name and the arguments are first separately
9215 expanded, and then the Perl subroutine is called with those arguments. No
9216 additional arguments need be given; the maximum number permitted, including the
9217 name of the subroutine, is nine.
9218
9219 The return value of the subroutine is inserted into the expanded string, unless
9220 the return value is &%undef%&. In that case, the expansion fails in the same
9221 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9222 Whatever you return is evaluated in a scalar context. For example, if you
9223 return the name of a Perl vector, the return value is the size of the vector,
9224 not its contents.
9225
9226 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9227 with the error message that was passed to &%die%&. More details of the embedded
9228 Perl facility are given in chapter &<<CHAPperl>>&.
9229
9230 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9231 out the use of this expansion item in filter files.
9232
9233
9234 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9235 .cindex "&%prvs%& expansion item"
9236 The first argument is a complete email address and the second is secret
9237 keystring. The third argument, specifying a key number, is optional. If absent,
9238 it defaults to 0. The result of the expansion is a prvs-signed email address,
9239 to be typically used with the &%return_path%& option on an &(smtp)& transport
9240 as part of a bounce address tag validation (BATV) scheme. For more discussion
9241 and an example, see section &<<SECTverifyPRVS>>&.
9242
9243 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9244         {*&<&'string'&>&*}}*&"
9245 .cindex "&%prvscheck%& expansion item"
9246 This expansion item is the complement of the &%prvs%& item. It is used for
9247 checking prvs-signed addresses. If the expansion of the first argument does not
9248 yield a syntactically valid prvs-signed address, the whole item expands to the
9249 empty string. When the first argument does expand to a syntactically valid
9250 prvs-signed address, the second argument is expanded, with the prvs-decoded
9251 version of the address and the key number extracted from the address in the
9252 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9253
9254 These two variables can be used in the expansion of the second argument to
9255 retrieve the secret. The validity of the prvs-signed address is then checked
9256 against the secret. The result is stored in the variable &$prvscheck_result$&,
9257 which is empty for failure or &"1"& for success.
9258
9259 The third argument is optional; if it is missing, it defaults to an empty
9260 string. This argument is now expanded. If the result is an empty string, the
9261 result of the expansion is the decoded version of the address. This is the case
9262 whether or not the signature was valid. Otherwise, the result of the expansion
9263 is the expansion of the third argument.
9264
9265 All three variables can be used in the expansion of the third argument.
9266 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9267 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9268
9269 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9270 .cindex "expansion" "inserting an entire file"
9271 .cindex "file" "inserting into expansion"
9272 .cindex "&%readfile%& expansion item"
9273 The file name and end-of-line string are first expanded separately. The file is
9274 then read, and its contents replace the entire item. All newline characters in
9275 the file are replaced by the end-of-line string if it is present. Otherwise,
9276 newlines are left in the string.
9277 String expansion is not applied to the contents of the file. If you want this,
9278 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9279 the string expansion fails.
9280
9281 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9282 locks out the use of this expansion item in filter files.
9283
9284
9285
9286 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9287         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9288 .cindex "expansion" "inserting from a socket"
9289 .cindex "socket, use of in expansion"
9290 .cindex "&%readsocket%& expansion item"
9291 This item inserts data from a Unix domain or Internet socket into the expanded
9292 string. The minimal way of using it uses just two arguments, as in these
9293 examples:
9294 .code
9295 ${readsocket{/socket/name}{request string}}
9296 ${readsocket{inet:some.host:1234}{request string}}
9297 .endd
9298 For a Unix domain socket, the first substring must be the path to the socket.
9299 For an Internet socket, the first substring must contain &`inet:`& followed by
9300 a host name or IP address, followed by a colon and a port, which can be a
9301 number or the name of a TCP port in &_/etc/services_&. An IP address may
9302 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9303 example:
9304 .code
9305 ${readsocket{inet:[::1]:1234}{request string}}
9306 .endd
9307 Only a single host name may be given, but if looking it up yields more than
9308 one IP address, they are each tried in turn until a connection is made. For
9309 both kinds of socket, Exim makes a connection, writes the request string
9310 (unless it is an empty string) and reads from the socket until an end-of-file
9311 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9312 extend what can be done. Firstly, you can vary the timeout. For example:
9313 .code
9314 ${readsocket{/socket/name}{request string}{3s}}
9315 .endd
9316 A fourth argument allows you to change any newlines that are in the data
9317 that is read, in the same way as for &%readfile%& (see above). This example
9318 turns them into spaces:
9319 .code
9320 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9321 .endd
9322 As with all expansions, the substrings are expanded before the processing
9323 happens. Errors in these sub-expansions cause the expansion to fail. In
9324 addition, the following errors can occur:
9325
9326 .ilist
9327 Failure to create a socket file descriptor;
9328 .next
9329 Failure to connect the socket;
9330 .next
9331 Failure to write the request string;
9332 .next
9333 Timeout on reading from the socket.
9334 .endlist
9335
9336 By default, any of these errors causes the expansion to fail. However, if
9337 you supply a fifth substring, it is expanded and used when any of the above
9338 errors occurs. For example:
9339 .code
9340 ${readsocket{/socket/name}{request string}{3s}{\n}\
9341   {socket failure}}
9342 .endd
9343 You can test for the existence of a Unix domain socket by wrapping this
9344 expansion in &`${if exists`&, but there is a race condition between that test
9345 and the actual opening of the socket, so it is safer to use the fifth argument
9346 if you want to be absolutely sure of avoiding an expansion error for a
9347 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9348
9349 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9350 locks out the use of this expansion item in filter files.
9351
9352
9353 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9354 .cindex "expansion" "reducing a list to a scalar"
9355 .cindex "list" "reducing to a scalar"
9356 .vindex "&$value$&"
9357 .vindex "&$item$&"
9358 This operation reduces a list to a single, scalar string. After expansion,
9359 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9360 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9361 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9362 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9363 them. The result of that expansion is assigned to &$value$& before the next
9364 iteration. When the end of the list is reached, the final value of &$value$& is
9365 added to the expansion output. The &*reduce*& expansion item can be used in a
9366 number of ways. For example, to add up a list of numbers:
9367 .code
9368 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9369 .endd
9370 The result of that expansion would be &`6`&. The maximum of a list of numbers
9371 can be found:
9372 .code
9373 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9374 .endd
9375 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9376 restored to what they were before. See also the &*filter*& and &*map*&
9377 expansion items.
9378
9379 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9380 This item inserts &"raw"& header lines. It is described with the &%header%&
9381 expansion item above.
9382
9383 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9384         {*&<&'string2'&>&*}}*&"
9385 .cindex "expansion" "running a command"
9386 .cindex "&%run%& expansion item"
9387 The command and its arguments are first expanded separately, and then the
9388 command is run in a separate process, but under the same uid and gid. As in
9389 other command executions from Exim, a shell is not used by default. If you want
9390 a shell, you must explicitly code it.
9391
9392 The standard input for the command exists, but is empty. The standard output
9393 and standard error are set to the same file descriptor.
9394 .cindex "return code" "from &%run%& expansion"
9395 .vindex "&$value$&"
9396 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9397 and replaces the entire item; during this expansion, the standard output/error
9398 from the command is in the variable &$value$&. If the command fails,
9399 <&'string2'&>, if present, is expanded and used. Once again, during the
9400 expansion, the standard output/error from the command is in the variable
9401 &$value$&.
9402
9403 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9404 can be the word &"fail"& (not in braces) to force expansion failure if the
9405 command does not succeed. If both strings are omitted, the result is contents
9406 of the standard output/error on success, and nothing on failure.
9407
9408 .vindex "&$run_in_acl$&"
9409 The standard output/error of the command is put in the variable &$value$&.
9410 In this ACL example, the output of a command is logged for the admin to
9411 troubleshoot:
9412 .code
9413 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9414       log_message  = Output of id: $value
9415 .endd
9416 If the command requires shell idioms, such as the > redirect operator, the
9417 shell must be invoked directly, such as with:
9418 .code
9419 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9420 .endd
9421
9422 .vindex "&$runrc$&"
9423 The return code from the command is put in the variable &$runrc$&, and this
9424 remains set afterwards, so in a filter file you can do things like this:
9425 .code
9426 if "${run{x y z}{}}$runrc" is 1 then ...
9427   elif $runrc is 2 then ...
9428   ...
9429 endif
9430 .endd
9431 If execution of the command fails (for example, the command does not exist),
9432 the return code is 127 &-- the same code that shells use for non-existent
9433 commands.
9434
9435 &*Warning*&: In a router or transport, you cannot assume the order in which
9436 option values are expanded, except for those preconditions whose order of
9437 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9438 by the expansion of one option, and use it in another.
9439
9440 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9441 out the use of this expansion item in filter files.
9442
9443
9444 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9445 .cindex "expansion" "string substitution"
9446 .cindex "&%sg%& expansion item"
9447 This item works like Perl's substitution operator (s) with the global (/g)
9448 option; hence its name. However, unlike the Perl equivalent, Exim does not
9449 modify the subject string; instead it returns the modified string for insertion
9450 into the overall expansion. The item takes three arguments: the subject string,
9451 a regular expression, and a substitution string. For example:
9452 .code
9453 ${sg{abcdefabcdef}{abc}{xyz}}
9454 .endd
9455 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9456 if any $ or \ characters are required in the regular expression or in the
9457 substitution string, they have to be escaped. For example:
9458 .code
9459 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9460 .endd
9461 yields &"defabc"&, and
9462 .code
9463 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9464 .endd
9465 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9466 the regular expression from string expansion.
9467
9468
9469
9470 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9471 .cindex "&%substr%& expansion item"
9472 .cindex "substring extraction"
9473 .cindex "expansion" "substring extraction"
9474 The three strings are expanded; the first two must yield numbers. Call them
9475 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9476 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9477 can use the simpler operator notation that avoids some of the braces:
9478 .code
9479 ${substr_<n>_<m>:<string>}
9480 .endd
9481 The second number is optional (in both notations).
9482 If it is absent in the simpler format, the preceding underscore must also be
9483 omitted.
9484
9485 The &%substr%& item can be used to extract more general substrings than
9486 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9487 length required. For example
9488 .code
9489 ${substr{3}{2}{$local_part}}
9490 .endd
9491 If the starting offset is greater than the string length the result is the
9492 null string; if the length plus starting offset is greater than the string
9493 length, the result is the right-hand part of the string, starting from the
9494 given offset. The first character in the string has offset zero.
9495
9496 The &%substr%& expansion item can take negative offset values to count
9497 from the right-hand end of its operand. The last character is offset -1, the
9498 second-last is offset -2, and so on. Thus, for example,
9499 .code
9500 ${substr{-5}{2}{1234567}}
9501 .endd
9502 yields &"34"&. If the absolute value of a negative offset is greater than the
9503 length of the string, the substring starts at the beginning of the string, and
9504 the length is reduced by the amount of overshoot. Thus, for example,
9505 .code
9506 ${substr{-5}{2}{12}}
9507 .endd
9508 yields an empty string, but
9509 .code
9510 ${substr{-3}{2}{12}}
9511 .endd
9512 yields &"1"&.
9513
9514 When the second number is omitted from &%substr%&, the remainder of the string
9515 is taken if the offset is positive. If it is negative, all characters in the
9516 string preceding the offset point are taken. For example, an offset of -1 and
9517 no length, as in these semantically identical examples:
9518 .code
9519 ${substr_-1:abcde}
9520 ${substr{-1}{abcde}}
9521 .endd
9522 yields all but the last character of the string, that is, &"abcd"&.
9523
9524
9525
9526 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9527         {*&<&'replacements'&>&*}}*&"
9528 .cindex "expansion" "character translation"
9529 .cindex "&%tr%& expansion item"
9530 This item does single-character translation on its subject string. The second
9531 argument is a list of characters to be translated in the subject string. Each
9532 matching character is replaced by the corresponding character from the
9533 replacement list. For example
9534 .code
9535 ${tr{abcdea}{ac}{13}}
9536 .endd
9537 yields &`1b3de1`&. If there are duplicates in the second character string, the
9538 last occurrence is used. If the third string is shorter than the second, its
9539 last character is replicated. However, if it is empty, no translation takes
9540 place.
9541 .endlist
9542
9543
9544
9545 .section "Expansion operators" "SECTexpop"
9546 .cindex "expansion" "operators"
9547 For expansion items that perform transformations on a single argument string,
9548 the &"operator"& notation is used because it is simpler and uses fewer braces.
9549 The substring is first expanded before the operation is applied to it. The
9550 following operations can be performed:
9551
9552 .vlist
9553 .vitem &*${address:*&<&'string'&>&*}*&
9554 .cindex "expansion" "RFC 2822 address handling"
9555 .cindex "&%address%& expansion item"
9556 The string is interpreted as an RFC 2822 address, as it might appear in a
9557 header line, and the effective address is extracted from it. If the string does
9558 not parse successfully, the result is empty.
9559
9560
9561 .vitem &*${addresses:*&<&'string'&>&*}*&
9562 .cindex "expansion" "RFC 2822 address handling"
9563 .cindex "&%addresses%& expansion item"
9564 The string (after expansion) is interpreted as a list of addresses in RFC
9565 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9566 operative address (&'local-part@domain'&) is extracted from each item, and the
9567 result of the expansion is a colon-separated list, with appropriate
9568 doubling of colons should any happen to be present in the email addresses.
9569 Syntactically invalid RFC2822 address items are omitted from the output.
9570
9571 It is possible to specify a character other than colon for the output
9572 separator by starting the string with > followed by the new separator
9573 character. For example:
9574 .code
9575 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9576 .endd
9577 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9578 expansion item, which extracts the working address from a single RFC2822
9579 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9580 processing lists.
9581
9582
9583 .vitem &*${base62:*&<&'digits'&>&*}*&
9584 .cindex "&%base62%& expansion item"
9585 .cindex "expansion" "conversion to base 62"
9586 The string must consist entirely of decimal digits. The number is converted to
9587 base 62 and output as a string of six characters, including leading zeros. In
9588 the few operating environments where Exim uses base 36 instead of base 62 for
9589 its message identifiers (because those systems do not have case-sensitive file
9590 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9591 be absolutely clear: this is &'not'& base64 encoding.
9592
9593 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9594 .cindex "&%base62d%& expansion item"
9595 .cindex "expansion" "conversion to base 62"
9596 The string must consist entirely of base-62 digits, or, in operating
9597 environments where Exim uses base 36 instead of base 62 for its message
9598 identifiers, base-36 digits. The number is converted to decimal and output as a
9599 string.
9600
9601
9602 .vitem &*${domain:*&<&'string'&>&*}*&
9603 .cindex "domain" "extraction"
9604 .cindex "expansion" "domain extraction"
9605 The string is interpreted as an RFC 2822 address and the domain is extracted
9606 from it. If the string does not parse successfully, the result is empty.
9607
9608
9609 .vitem &*${escape:*&<&'string'&>&*}*&
9610 .cindex "expansion" "escaping non-printing characters"
9611 .cindex "&%escape%& expansion item"
9612 If the string contains any non-printing characters, they are converted to
9613 escape sequences starting with a backslash. Whether characters with the most
9614 significant bit set (so-called &"8-bit characters"&) count as printing or not
9615 is controlled by the &%print_topbitchars%& option.
9616
9617
9618 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9619 .cindex "expansion" "expression evaluation"
9620 .cindex "expansion" "arithmetic expression"
9621 .cindex "&%eval%& expansion item"
9622 These items supports simple arithmetic and bitwise logical operations in
9623 expansion strings. The string (after expansion) must be a conventional
9624 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9625 logical operators, and parentheses. All operations are carried out using
9626 integer arithmetic. The operator priorities are as follows (the same as in the
9627 C programming language):
9628 .table2 70pt 300pt
9629 .irow &'highest:'& "not (~), negate (-)"
9630 .irow ""   "multiply (*), divide (/), remainder (%)"
9631 .irow ""   "plus (+), minus (-)"
9632 .irow ""   "shift-left (<<), shift-right (>>)"
9633 .irow ""   "and (&&)"
9634 .irow ""   "xor (^)"
9635 .irow &'lowest:'&  "or (|)"
9636 .endtable
9637 Binary operators with the same priority are evaluated from left to right. White
9638 space is permitted before or after operators.
9639
9640 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9641 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9642 decimal, even if they start with a leading zero; hexadecimal numbers are not
9643 permitted. This can be useful when processing numbers extracted from dates or
9644 times, which often do have leading zeros.
9645
9646 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9647 or 1024*1024*1024,
9648 respectively. Negative numbers are supported. The result of the computation is
9649 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9650
9651 .display
9652 &`${eval:1+1}            `&  yields 2
9653 &`${eval:1+2*3}          `&  yields 7
9654 &`${eval:(1+2)*3}        `&  yields 9
9655 &`${eval:2+42%5}         `&  yields 4
9656 &`${eval:0xc&amp;5}          `&  yields 4
9657 &`${eval:0xc|5}          `&  yields 13
9658 &`${eval:0xc^5}          `&  yields 9
9659 &`${eval:0xc>>1}         `&  yields 6
9660 &`${eval:0xc<<1}         `&  yields 24
9661 &`${eval:~255&amp;0x1234}    `&  yields 4608
9662 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9663 .endd
9664
9665 As a more realistic example, in an ACL you might have
9666 .code
9667 deny   message = Too many bad recipients
9668        condition =                    \
9669          ${if and {                   \
9670            {>{$rcpt_count}{10}}       \
9671            {                          \
9672            <                          \
9673              {$recipients_count}      \
9674              {${eval:$rcpt_count/2}}  \
9675            }                          \
9676          }{yes}{no}}
9677 .endd
9678 The condition is true if there have been more than 10 RCPT commands and
9679 fewer than half of them have resulted in a valid recipient.
9680
9681
9682 .vitem &*${expand:*&<&'string'&>&*}*&
9683 .cindex "expansion" "re-expansion of substring"
9684 The &%expand%& operator causes a string to be expanded for a second time. For
9685 example,
9686 .code
9687 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9688 .endd
9689 first looks up a string in a file while expanding the operand for &%expand%&,
9690 and then re-expands what it has found.
9691
9692
9693 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9694 .cindex "Unicode"
9695 .cindex "UTF-8" "conversion from"
9696 .cindex "expansion" "UTF-8 conversion"
9697 .cindex "&%from_utf8%& expansion item"
9698 The world is slowly moving towards Unicode, although there are no standards for
9699 email yet. However, other applications (including some databases) are starting
9700 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9701 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9702 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9703 the result is an undefined sequence of bytes.
9704
9705 Unicode code points with values less than 256 are compatible with ASCII and
9706 ISO-8859-1 (also known as Latin-1).
9707 For example, character 169 is the copyright symbol in both cases, though the
9708 way it is encoded is different. In UTF-8, more than one byte is needed for
9709 characters with code values greater than 127, whereas ISO-8859-1 is a
9710 single-byte encoding (but thereby limited to 256 characters). This makes
9711 translation from UTF-8 to ISO-8859-1 straightforward.
9712
9713
9714 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9715 .cindex "hash function" "textual"
9716 .cindex "expansion" "textual hash"
9717 The &%hash%& operator is a simpler interface to the hashing function that can
9718 be used when the two parameters are fixed numbers (as opposed to strings that
9719 change when expanded). The effect is the same as
9720 .code
9721 ${hash{<n>}{<m>}{<string>}}
9722 .endd
9723 See the description of the general &%hash%& item above for details. The
9724 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9725
9726
9727
9728 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9729 .cindex "base64 encoding" "conversion from hex"
9730 .cindex "expansion" "hex to base64"
9731 .cindex "&%hex2b64%& expansion item"
9732 This operator converts a hex string into one that is base64 encoded. This can
9733 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9734
9735
9736 .vitem &*${lc:*&<&'string'&>&*}*&
9737 .cindex "case forcing in strings"
9738 .cindex "string" "case forcing"
9739 .cindex "lower casing"
9740 .cindex "expansion" "case forcing"
9741 .cindex "&%lc%& expansion item"
9742 This forces the letters in the string into lower-case, for example:
9743 .code
9744 ${lc:$local_part}
9745 .endd
9746
9747 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9748 .cindex "expansion" "string truncation"
9749 .cindex "&%length%& expansion item"
9750 The &%length%& operator is a simpler interface to the &%length%& function that
9751 can be used when the parameter is a fixed number (as opposed to a string that
9752 changes when expanded). The effect is the same as
9753 .code
9754 ${length{<number>}{<string>}}
9755 .endd
9756 See the description of the general &%length%& item above for details. Note that
9757 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9758 when &%length%& is used as an operator.
9759
9760
9761 .vitem &*${listcount:*&<&'string'&>&*}*&
9762 .cindex "expansion" "list item count"
9763 .cindex "list" "item count"
9764 .cindex "list" "count of items"
9765 .cindex "&%listcount%& expansion item"
9766 The string is interpreted as a list and the number of items is returned.
9767
9768
9769 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${list_*&<&'type'&>&*name*&>&*}*&
9770 .cindex "expansion" "named list"
9771 .cindex "&%listnamed%& expansion item"
9772 The name is interpreted as a named list and the content of the list is returned,
9773 expanding any referenced lists, re-quoting as needed for colon-separation.
9774 If the optional type if given it must be one of "a", "d", "h" or "l"
9775 and selects address-, domain-, host- or localpart- lists to search among respectively.
9776 Otherwise all types are searched in an undefined order and the first
9777 matching list is returned.
9778
9779
9780 .vitem &*${local_part:*&<&'string'&>&*}*&
9781 .cindex "expansion" "local part extraction"
9782 .cindex "&%local_part%& expansion item"
9783 The string is interpreted as an RFC 2822 address and the local part is
9784 extracted from it. If the string does not parse successfully, the result is
9785 empty.
9786
9787
9788 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9789 .cindex "masked IP address"
9790 .cindex "IP address" "masking"
9791 .cindex "CIDR notation"
9792 .cindex "expansion" "IP address masking"
9793 .cindex "&%mask%& expansion item"
9794 If the form of the string to be operated on is not an IP address followed by a
9795 slash and an integer (that is, a network address in CIDR notation), the
9796 expansion fails. Otherwise, this operator converts the IP address to binary,
9797 masks off the least significant bits according to the bit count, and converts
9798 the result back to text, with mask appended. For example,
9799 .code
9800 ${mask:10.111.131.206/28}
9801 .endd
9802 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9803 be mostly used for looking up masked addresses in files, the result for an IPv6
9804 address uses dots to separate components instead of colons, because colon
9805 terminates a key string in lsearch files. So, for example,
9806 .code
9807 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9808 .endd
9809 returns the string
9810 .code
9811 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9812 .endd
9813 Letters in IPv6 addresses are always output in lower case.
9814
9815
9816 .vitem &*${md5:*&<&'string'&>&*}*&
9817 .cindex "MD5 hash"
9818 .cindex "expansion" "MD5 hash"
9819 .cindex "&%md5%& expansion item"
9820 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9821 as a 32-digit hexadecimal number, in which any letters are in lower case.
9822
9823
9824 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9825 .cindex "expansion" "numeric hash"
9826 .cindex "hash function" "numeric"
9827 The &%nhash%& operator is a simpler interface to the numeric hashing function
9828 that can be used when the two parameters are fixed numbers (as opposed to
9829 strings that change when expanded). The effect is the same as
9830 .code
9831 ${nhash{<n>}{<m>}{<string>}}
9832 .endd
9833 See the description of the general &%nhash%& item above for details.
9834
9835
9836 .vitem &*${quote:*&<&'string'&>&*}*&
9837 .cindex "quoting" "in string expansions"
9838 .cindex "expansion" "quoting"
9839 .cindex "&%quote%& expansion item"
9840 The &%quote%& operator puts its argument into double quotes if it
9841 is an empty string or
9842 contains anything other than letters, digits, underscores, dots, and hyphens.
9843 Any occurrences of double quotes and backslashes are escaped with a backslash.
9844 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9845 respectively For example,
9846 .code
9847 ${quote:ab"*"cd}
9848 .endd
9849 becomes
9850 .code
9851 "ab\"*\"cd"
9852 .endd
9853 The place where this is useful is when the argument is a substitution from a
9854 variable or a message header.
9855
9856 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9857 .cindex "&%quote_local_part%& expansion item"
9858 This operator is like &%quote%&, except that it quotes the string only if
9859 required to do so by the rules of RFC 2822 for quoting local parts. For
9860 example, a plus sign would not cause quoting (but it would for &%quote%&).
9861 If you are creating a new email address from the contents of &$local_part$&
9862 (or any other unknown data), you should always use this operator.
9863
9864
9865 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9866 .cindex "quoting" "lookup-specific"
9867 This operator applies lookup-specific quoting rules to the string. Each
9868 query-style lookup type has its own quoting rules which are described with
9869 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9870 .code
9871 ${quote_ldap:two * two}
9872 .endd
9873 returns
9874 .code
9875 two%20%5C2A%20two
9876 .endd
9877 For single-key lookup types, no quoting is ever necessary and this operator
9878 yields an unchanged string.
9879
9880
9881 .vitem &*${randint:*&<&'n'&>&*}*&
9882 .cindex "random number"
9883 This operator returns a somewhat random number which is less than the
9884 supplied number and is at least 0.  The quality of this randomness depends
9885 on how Exim was built; the values are not suitable for keying material.
9886 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9887 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
9888 for versions of GnuTLS with that function.
9889 Otherwise, the implementation may be arc4random(), random() seeded by
9890 srandomdev() or srandom(), or a custom implementation even weaker than
9891 random().
9892
9893
9894 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9895 .cindex "expansion" "IP address"
9896 This operator reverses an IP address; for IPv4 addresses, the result is in
9897 dotted-quad decimal form, while for IPv6 addreses the result is in
9898 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9899 for DNS.  For example,
9900 .code
9901 ${reverse_ip:192.0.2.4}
9902 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9903 .endd
9904 returns
9905 .code
9906 4.2.0.192
9907 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
9908 .endd
9909
9910
9911 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9912 .cindex "expansion" "RFC 2047"
9913 .cindex "RFC 2047" "expansion operator"
9914 .cindex "&%rfc2047%& expansion item"
9915 This operator encodes text according to the rules of RFC 2047. This is an
9916 encoding that is used in header lines to encode non-ASCII characters. It is
9917 assumed that the input string is in the encoding specified by the
9918 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9919 contains only characters in the range 33&--126, and no instances of the
9920 characters
9921 .code
9922 ? = ( ) < > @ , ; : \ " . [ ] _
9923 .endd
9924 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9925 string, using as many &"encoded words"& as necessary to encode all the
9926 characters.
9927
9928
9929 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9930 .cindex "expansion" "RFC 2047"
9931 .cindex "RFC 2047" "decoding"
9932 .cindex "&%rfc2047d%& expansion item"
9933 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9934 bytes are replaced by question marks. Characters are converted into the
9935 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9936 not recognized unless &%check_rfc2047_length%& is set false.
9937
9938 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9939 access a header line, RFC 2047 decoding is done automatically. You do not need
9940 to use this operator as well.
9941
9942
9943
9944 .vitem &*${rxquote:*&<&'string'&>&*}*&
9945 .cindex "quoting" "in regular expressions"
9946 .cindex "regular expressions" "quoting"
9947 .cindex "&%rxquote%& expansion item"
9948 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9949 characters in its argument. This is useful when substituting the values of
9950 variables or headers inside regular expressions.
9951
9952
9953 .vitem &*${sha1:*&<&'string'&>&*}*&
9954 .cindex "SHA-1 hash"
9955 .cindex "expansion" "SHA-1 hashing"
9956 .cindex "&%sha2%& expansion item"
9957 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9958 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9959
9960
9961 .vitem &*${stat:*&<&'string'&>&*}*&
9962 .cindex "expansion" "statting a file"
9963 .cindex "file" "extracting characteristics"
9964 .cindex "&%stat%& expansion item"
9965 The string, after expansion, must be a file path. A call to the &[stat()]&
9966 function is made for this path. If &[stat()]& fails, an error occurs and the
9967 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9968 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9969 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9970 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9971 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9972 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9973 can extract individual fields using the &%extract%& expansion item.
9974
9975 The use of the &%stat%& expansion in users' filter files can be locked out by
9976 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9977 systems for files larger than 2GB.
9978
9979 .vitem &*${str2b64:*&<&'string'&>&*}*&
9980 .cindex "expansion" "base64 encoding"
9981 .cindex "base64 encoding" "in string expansion"
9982 .cindex "&%str2b64%& expansion item"
9983 This operator converts a string into one that is base64 encoded.
9984
9985
9986
9987 .vitem &*${strlen:*&<&'string'&>&*}*&
9988 .cindex "expansion" "string length"
9989 .cindex "string" "length in expansion"
9990 .cindex "&%strlen%& expansion item"
9991 The item is replace by the length of the expanded string, expressed as a
9992 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9993
9994
9995 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9996 .cindex "&%substr%& expansion item"
9997 .cindex "substring extraction"
9998 .cindex "expansion" "substring expansion"
9999 The &%substr%& operator is a simpler interface to the &%substr%& function that
10000 can be used when the two parameters are fixed numbers (as opposed to strings
10001 that change when expanded). The effect is the same as
10002 .code
10003 ${substr{<start>}{<length>}{<string>}}
10004 .endd
10005 See the description of the general &%substr%& item above for details. The
10006 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10007
10008 .vitem &*${time_eval:*&<&'string'&>&*}*&
10009 .cindex "&%time_eval%& expansion item"
10010 .cindex "time interval" "decoding"
10011 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10012 seconds.
10013
10014 .vitem &*${time_interval:*&<&'string'&>&*}*&
10015 .cindex "&%time_interval%& expansion item"
10016 .cindex "time interval" "formatting"
10017 The argument (after sub-expansion) must be a sequence of decimal digits that
10018 represents an interval of time as a number of seconds. It is converted into a
10019 number of larger units and output in Exim's normal time format, for example,
10020 &`1w3d4h2m6s`&.
10021
10022 .vitem &*${uc:*&<&'string'&>&*}*&
10023 .cindex "case forcing in strings"
10024 .cindex "string" "case forcing"
10025 .cindex "upper casing"
10026 .cindex "expansion" "case forcing"
10027 .cindex "&%uc%& expansion item"
10028 This forces the letters in the string into upper-case.
10029 .endlist
10030
10031
10032
10033
10034
10035
10036 .section "Expansion conditions" "SECTexpcond"
10037 .scindex IIDexpcond "expansion" "conditions"
10038 The following conditions are available for testing by the &%${if%& construct
10039 while expanding strings:
10040
10041 .vlist
10042 .vitem &*!*&<&'condition'&>
10043 .cindex "expansion" "negating a condition"
10044 .cindex "negation" "in expansion condition"
10045 Preceding any condition with an exclamation mark negates the result of the
10046 condition.
10047
10048 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10049 .cindex "numeric comparison"
10050 .cindex "expansion" "numeric comparison"
10051 There are a number of symbolic operators for doing numeric comparisons. They
10052 are:
10053 .display
10054 &`=   `&   equal
10055 &`==  `&   equal
10056 &`>   `&   greater
10057 &`>=  `&   greater or equal
10058 &`<   `&   less
10059 &`<=  `&   less or equal
10060 .endd
10061 For example:
10062 .code
10063 ${if >{$message_size}{10M} ...
10064 .endd
10065 Note that the general negation operator provides for inequality testing. The
10066 two strings must take the form of optionally signed decimal integers,
10067 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10068 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10069 As a special case, the numerical value of an empty string is taken as
10070 zero.
10071
10072 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10073 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10074 10M, not if 10M is larger than &$message_size$&.
10075
10076
10077 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10078         {*&<&'arg2'&>&*}...}*&
10079 .cindex "expansion" "calling an acl"
10080 .cindex "&%acl%&" "expansion condition"
10081 The name and zero to nine argument strings are first expanded separately.  The expanded
10082 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10083 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10084 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10085 and may use the variables; if another acl expansion is used the values
10086 are overwritten.  If the ACL sets
10087 a value using a "message =" modifier the variable $value becomes
10088 the result of the expansion, otherwise it is empty.
10089 If the ACL returns accept the condition is true; if deny, false.
10090 If the ACL returns defer the result is a forced-fail.
10091
10092 .vitem &*bool&~{*&<&'string'&>&*}*&
10093 .cindex "expansion" "boolean parsing"
10094 .cindex "&%bool%& expansion condition"
10095 This condition turns a string holding a true or false representation into
10096 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10097 (case-insensitively); also positive integer numbers map to true if non-zero,
10098 false if zero.
10099 An empty string is treated as false.
10100 Leading and trailing whitespace is ignored;
10101 thus a string consisting only of whitespace is false.
10102 All other string values will result in expansion failure.
10103
10104 When combined with ACL variables, this expansion condition will let you
10105 make decisions in one place and act on those decisions in another place.
10106 For example:
10107 .code
10108 ${if bool{$acl_m_privileged_sender} ...
10109 .endd
10110
10111
10112 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10113 .cindex "expansion" "boolean parsing"
10114 .cindex "&%bool_lax%& expansion condition"
10115 Like &%bool%&, this condition turns a string into a boolean state.  But
10116 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10117 loose definition that the Router &%condition%& option uses.  The empty string
10118 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10119 true.  Leading and trailing whitespace is ignored.
10120
10121 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10122
10123 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10124 .cindex "expansion" "encrypted comparison"
10125 .cindex "encrypted strings, comparing"
10126 .cindex "&%crypteq%& expansion condition"
10127 This condition is included in the Exim binary if it is built to support any
10128 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10129 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10130 included in the binary.
10131
10132 The &%crypteq%& condition has two arguments. The first is encrypted and
10133 compared against the second, which is already encrypted. The second string may
10134 be in the LDAP form for storing encrypted strings, which starts with the
10135 encryption type in curly brackets, followed by the data. If the second string
10136 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10137 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10138 Typically this will be a field from a password file. An example of an encrypted
10139 string in LDAP form is:
10140 .code
10141 {md5}CY9rzUYh03PK3k6DJie09g==
10142 .endd
10143 If such a string appears directly in an expansion, the curly brackets have to
10144 be quoted, because they are part of the expansion syntax. For example:
10145 .code
10146 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10147 .endd
10148 The following encryption types (whose names are matched case-independently) are
10149 supported:
10150
10151 .ilist
10152 .cindex "MD5 hash"
10153 .cindex "base64 encoding" "in encrypted password"
10154 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10155 printable characters to compare with the remainder of the second string. If the
10156 length of the comparison string is 24, Exim assumes that it is base64 encoded
10157 (as in the above example). If the length is 32, Exim assumes that it is a
10158 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10159 comparison fails.
10160
10161 .next
10162 .cindex "SHA-1 hash"
10163 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10164 printable characters to compare with the remainder of the second string. If the
10165 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10166 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10167 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10168
10169 .next
10170 .cindex "&[crypt()]&"
10171 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10172 only the first eight characters of the password. However, in modern operating
10173 systems this is no longer true, and in many cases the entire password is used,
10174 whatever its length.
10175
10176 .next
10177 .cindex "&[crypt16()]&"
10178 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10179 use up to 16 characters of the password in some operating systems. Again, in
10180 modern operating systems, more characters may be used.
10181 .endlist
10182 Exim has its own version of &[crypt16()]&, which is just a double call to
10183 &[crypt()]&. For operating systems that have their own version, setting
10184 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10185 operating system version instead of its own. This option is set by default in
10186 the OS-dependent &_Makefile_& for those operating systems that are known to
10187 support &[crypt16()]&.
10188
10189 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10190 it was not using the same algorithm as some operating systems' versions. It
10191 turns out that as well as &[crypt16()]& there is a function called
10192 &[bigcrypt()]& in some operating systems. This may or may not use the same
10193 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10194
10195 However, since there is now a move away from the traditional &[crypt()]&
10196 functions towards using SHA1 and other algorithms, tidying up this area of
10197 Exim is seen as very low priority.
10198
10199 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10200 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10201 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10202 default is &`{crypt}`&. Whatever the default, you can always use either
10203 function by specifying it explicitly in curly brackets.
10204
10205 .vitem &*def:*&<&'variable&~name'&>
10206 .cindex "expansion" "checking for empty variable"
10207 .cindex "&%def%& expansion condition"
10208 The &%def%& condition must be followed by the name of one of the expansion
10209 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10210 variable does not contain the empty string. For example:
10211 .code
10212 ${if def:sender_ident {from $sender_ident}}
10213 .endd
10214 Note that the variable name is given without a leading &%$%& character. If the
10215 variable does not exist, the expansion fails.
10216
10217 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10218         &~&*def:h_*&<&'header&~name'&>&*:*&"
10219 .cindex "expansion" "checking header line existence"
10220 This condition is true if a message is being processed and the named header
10221 exists in the message. For example,
10222 .code
10223 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10224 .endd
10225 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10226 the header name must be terminated by a colon if white space does not follow.
10227
10228 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10229        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10230 .cindex "string" "comparison"
10231 .cindex "expansion" "string comparison"
10232 .cindex "&%eq%& expansion condition"
10233 .cindex "&%eqi%& expansion condition"
10234 The two substrings are first expanded. The condition is true if the two
10235 resulting strings are identical. For &%eq%& the comparison includes the case of
10236 letters, whereas for &%eqi%& the comparison is case-independent.
10237
10238 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10239 .cindex "expansion" "file existence test"
10240 .cindex "file" "existence test"
10241 .cindex "&%exists%&, expansion condition"
10242 The substring is first expanded and then interpreted as an absolute path. The
10243 condition is true if the named file (or directory) exists. The existence test
10244 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10245 users' filter files may be locked out by the system administrator.
10246
10247 .vitem &*first_delivery*&
10248 .cindex "delivery" "first"
10249 .cindex "first delivery"
10250 .cindex "expansion" "first delivery test"
10251 .cindex "&%first_delivery%& expansion condition"
10252 This condition, which has no data, is true during a message's first delivery
10253 attempt. It is false during any subsequent delivery attempts.
10254
10255
10256 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10257        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10258 .cindex "list" "iterative conditions"
10259 .cindex "expansion" "&*forall*& condition"
10260 .cindex "expansion" "&*forany*& condition"
10261 .vindex "&$item$&"
10262 These conditions iterate over a list. The first argument is expanded to form
10263 the list. By default, the list separator is a colon, but it can be changed by
10264 the normal method. The second argument is interpreted as a condition that is to
10265 be applied to each item in the list in turn. During the interpretation of the
10266 condition, the current list item is placed in a variable called &$item$&.
10267 .ilist
10268 For &*forany*&, interpretation stops if the condition is true for any item, and
10269 the result of the whole condition is true. If the condition is false for all
10270 items in the list, the overall condition is false.
10271 .next
10272 For &*forall*&, interpretation stops if the condition is false for any item,
10273 and the result of the whole condition is false. If the condition is true for
10274 all items in the list, the overall condition is true.
10275 .endlist
10276 Note that negation of &*forany*& means that the condition must be false for all
10277 items for the overall condition to succeed, and negation of &*forall*& means
10278 that the condition must be false for at least one item. In this example, the
10279 list separator is changed to a comma:
10280 .code
10281 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10282 .endd
10283 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10284 being processed, to enable these expansion items to be nested.
10285
10286
10287 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10288        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10289 .cindex "string" "comparison"
10290 .cindex "expansion" "string comparison"
10291 .cindex "&%ge%& expansion condition"
10292 .cindex "&%gei%& expansion condition"
10293 The two substrings are first expanded. The condition is true if the first
10294 string is lexically greater than or equal to the second string. For &%ge%& the
10295 comparison includes the case of letters, whereas for &%gei%& the comparison is
10296 case-independent.
10297
10298 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10299        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10300 .cindex "string" "comparison"
10301 .cindex "expansion" "string comparison"
10302 .cindex "&%gt%& expansion condition"
10303 .cindex "&%gti%& expansion condition"
10304 The two substrings are first expanded. The condition is true if the first
10305 string is lexically greater than the second string. For &%gt%& the comparison
10306 includes the case of letters, whereas for &%gti%& the comparison is
10307 case-independent.
10308
10309 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10310        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10311 .cindex "string" "comparison"
10312 .cindex "list" "iterative conditions"
10313 Both strings are expanded; the second string is treated as a list of simple
10314 strings; if the first string is a member of the second, then the condition
10315 is true.
10316
10317 These are simpler to use versions of the more powerful &*forany*& condition.
10318 Examples, and the &*forany*& equivalents:
10319 .code
10320 ${if inlist{needle}{foo:needle:bar}}
10321   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10322 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10323   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10324 .endd
10325
10326 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10327        &*isip4&~{*&<&'string'&>&*}*& &&&
10328        &*isip6&~{*&<&'string'&>&*}*&
10329 .cindex "IP address" "testing string format"
10330 .cindex "string" "testing for IP address"
10331 .cindex "&%isip%& expansion condition"
10332 .cindex "&%isip4%& expansion condition"
10333 .cindex "&%isip6%& expansion condition"
10334 The substring is first expanded, and then tested to see if it has the form of
10335 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10336 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10337
10338 For an IPv4 address, the test is for four dot-separated components, each of
10339 which consists of from one to three digits. For an IPv6 address, up to eight
10340 colon-separated components are permitted, each containing from one to four
10341 hexadecimal digits. There may be fewer than eight components if an empty
10342 component (adjacent colons) is present. Only one empty component is permitted.
10343
10344 &*Note*&: The checks are just on the form of the address; actual numerical
10345 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10346 check. The main use of these tests is to distinguish between IP addresses and
10347 host names, or between IPv4 and IPv6 addresses. For example, you could use
10348 .code
10349 ${if isip4{$sender_host_address}...
10350 .endd
10351 to test which IP version an incoming SMTP connection is using.
10352
10353 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10354 .cindex "LDAP" "use for authentication"
10355 .cindex "expansion" "LDAP authentication test"
10356 .cindex "&%ldapauth%& expansion condition"
10357 This condition supports user authentication using LDAP. See section
10358 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10359 queries. For this use, the query must contain a user name and password. The
10360 query itself is not used, and can be empty. The condition is true if the
10361 password is not empty, and the user name and password are accepted by the LDAP
10362 server. An empty password is rejected without calling LDAP because LDAP binds
10363 with an empty password are considered anonymous regardless of the username, and
10364 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10365 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10366 this can be used.
10367
10368
10369 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10370        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10371 .cindex "string" "comparison"
10372 .cindex "expansion" "string comparison"
10373 .cindex "&%le%& expansion condition"
10374 .cindex "&%lei%& expansion condition"
10375 The two substrings are first expanded. The condition is true if the first
10376 string is lexically less than or equal to the second string. For &%le%& the
10377 comparison includes the case of letters, whereas for &%lei%& the comparison is
10378 case-independent.
10379
10380 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10381        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10382 .cindex "string" "comparison"
10383 .cindex "expansion" "string comparison"
10384 .cindex "&%lt%& expansion condition"
10385 .cindex "&%lti%& expansion condition"
10386 The two substrings are first expanded. The condition is true if the first
10387 string is lexically less than the second string. For &%lt%& the comparison
10388 includes the case of letters, whereas for &%lti%& the comparison is
10389 case-independent.
10390
10391
10392 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10393 .cindex "expansion" "regular expression comparison"
10394 .cindex "regular expressions" "match in expanded string"
10395 .cindex "&%match%& expansion condition"
10396 The two substrings are first expanded. The second is then treated as a regular
10397 expression and applied to the first. Because of the pre-expansion, if the
10398 regular expression contains dollar, or backslash characters, they must be
10399 escaped. Care must also be taken if the regular expression contains braces
10400 (curly brackets). A closing brace must be escaped so that it is not taken as a
10401 premature termination of <&'string2'&>. The easiest approach is to use the
10402 &`\N`& feature to disable expansion of the regular expression.
10403 For example,
10404 .code
10405 ${if match {$local_part}{\N^\d{3}\N} ...
10406 .endd
10407 If the whole expansion string is in double quotes, further escaping of
10408 backslashes is also required.
10409
10410 The condition is true if the regular expression match succeeds.
10411 The regular expression is not required to begin with a circumflex
10412 metacharacter, but if there is no circumflex, the expression is not anchored,
10413 and it may match anywhere in the subject, not just at the start. If you want
10414 the pattern to match at the end of the subject, you must include the &`$`&
10415 metacharacter at an appropriate point.
10416
10417 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10418 At the start of an &%if%& expansion the values of the numeric variable
10419 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10420 succeeds causes them to be reset to the substrings of that condition and they
10421 will have these values during the expansion of the success string. At the end
10422 of the &%if%& expansion, the previous values are restored. After testing a
10423 combination of conditions using &%or%&, the subsequent values of the numeric
10424 variables are those of the condition that succeeded.
10425
10426 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10427 .cindex "&%match_address%& expansion condition"
10428 See &*match_local_part*&.
10429
10430 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10431 .cindex "&%match_domain%& expansion condition"
10432 See &*match_local_part*&.
10433
10434 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10435 .cindex "&%match_ip%& expansion condition"
10436 This condition matches an IP address to a list of IP address patterns. It must
10437 be followed by two argument strings. The first (after expansion) must be an IP
10438 address or an empty string. The second (not expanded) is a restricted host
10439 list that can match only an IP address, not a host name. For example:
10440 .code
10441 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10442 .endd
10443 The specific types of host list item that are permitted in the list are:
10444
10445 .ilist
10446 An IP address, optionally with a CIDR mask.
10447 .next
10448 A single asterisk, which matches any IP address.
10449 .next
10450 An empty item, which matches only if the IP address is empty. This could be
10451 useful for testing for a locally submitted message or one from specific hosts
10452 in a single test such as
10453 . ==== As this is a nested list, any displays it contains must be indented
10454 . ==== as otherwise they are too far to the left. This comment applies to
10455 . ==== the use of xmlto plus fop. There's no problem when formatting with
10456 . ==== sdop, with or without the extra indent.
10457 .code
10458   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10459 .endd
10460 where the first item in the list is the empty string.
10461 .next
10462 The item @[] matches any of the local host's interface addresses.
10463 .next
10464 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10465 even if &`net-`& is not specified. There is never any attempt to turn the IP
10466 address into a host name. The most common type of linear search for
10467 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10468 masks. For example:
10469 .code
10470   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10471 .endd
10472 It is of course possible to use other kinds of lookup, and in such a case, you
10473 do need to specify the &`net-`& prefix if you want to specify a specific
10474 address mask, for example:
10475 .code
10476   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10477 .endd
10478 However, unless you are combining a &%match_ip%& condition with others, it is
10479 just as easy to use the fact that a lookup is itself a condition, and write:
10480 .code
10481   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10482 .endd
10483 .endlist ilist
10484
10485 Note that <&'string2'&> is not itself subject to string expansion, unless
10486 Exim was built with the EXPAND_LISTMATCH_RHS option.
10487
10488 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10489
10490 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10491 .cindex "domain list" "in expansion condition"
10492 .cindex "address list" "in expansion condition"
10493 .cindex "local part" "list, in expansion condition"
10494 .cindex "&%match_local_part%& expansion condition"
10495 This condition, together with &%match_address%& and &%match_domain%&, make it
10496 possible to test domain, address, and local part lists within expansions. Each
10497 condition requires two arguments: an item and a list to match. A trivial
10498 example is:
10499 .code
10500 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10501 .endd
10502 In each case, the second argument may contain any of the allowable items for a
10503 list of the appropriate type. Also, because the second argument (after
10504 expansion) is a standard form of list, it is possible to refer to a named list.
10505 Thus, you can use conditions like this:
10506 .code
10507 ${if match_domain{$domain}{+local_domains}{...
10508 .endd
10509 .cindex "&`+caseful`&"
10510 For address lists, the matching starts off caselessly, but the &`+caseful`&
10511 item can be used, as in all address lists, to cause subsequent items to
10512 have their local parts matched casefully. Domains are always matched
10513 caselessly.
10514
10515 Note that <&'string2'&> is not itself subject to string expansion, unless
10516 Exim was built with the EXPAND_LISTMATCH_RHS option.
10517
10518 &*Note*&: Host lists are &'not'& supported in this way. This is because
10519 hosts have two identities: a name and an IP address, and it is not clear
10520 how to specify cleanly how such a test would work. However, IP addresses can be
10521 matched using &%match_ip%&.
10522
10523 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10524 .cindex "PAM authentication"
10525 .cindex "AUTH" "with PAM"
10526 .cindex "Solaris" "PAM support"
10527 .cindex "expansion" "PAM authentication test"
10528 .cindex "&%pam%& expansion condition"
10529 &'Pluggable Authentication Modules'&
10530 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10531 available in the latest releases of Solaris and in some GNU/Linux
10532 distributions. The Exim support, which is intended for use in conjunction with
10533 the SMTP AUTH command, is available only if Exim is compiled with
10534 .code
10535 SUPPORT_PAM=yes
10536 .endd
10537 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10538 in some releases of GNU/Linux &%-ldl%& is also needed.
10539
10540 The argument string is first expanded, and the result must be a
10541 colon-separated list of strings. Leading and trailing white space is ignored.
10542 The PAM module is initialized with the service name &"exim"& and the user name
10543 taken from the first item in the colon-separated data string (<&'string1'&>).
10544 The remaining items in the data string are passed over in response to requests
10545 from the authentication function. In the simple case there will only be one
10546 request, for a password, so the data consists of just two strings.
10547
10548 There can be problems if any of the strings are permitted to contain colon
10549 characters. In the usual way, these have to be doubled to avoid being taken as
10550 separators. If the data is being inserted from a variable, the &%sg%& expansion
10551 item can be used to double any existing colons. For example, the configuration
10552 of a LOGIN authenticator might contain this setting:
10553 .code
10554 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10555 .endd
10556 For a PLAIN authenticator you could use:
10557 .code
10558 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10559 .endd
10560 In some operating systems, PAM authentication can be done only from a process
10561 running as root. Since Exim is running as the Exim user when receiving
10562 messages, this means that PAM cannot be used directly in those systems.
10563 A patched version of the &'pam_unix'& module that comes with the
10564 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10565 The patched module allows one special uid/gid combination, in addition to root,
10566 to authenticate. If you build the patched module to allow the Exim user and
10567 group, PAM can then be used from an Exim authenticator.
10568
10569
10570 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10571 .cindex "&'pwcheck'& daemon"
10572 .cindex "Cyrus"
10573 .cindex "expansion" "&'pwcheck'& authentication test"
10574 .cindex "&%pwcheck%& expansion condition"
10575 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10576 This is one way of making it possible for passwords to be checked by a process
10577 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10578 deprecated. Its replacement is &'saslauthd'& (see below).
10579
10580 The pwcheck support is not included in Exim by default. You need to specify
10581 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10582 building Exim. For example:
10583 .code
10584 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10585 .endd
10586 You do not need to install the full Cyrus software suite in order to use
10587 the pwcheck daemon. You can compile and install just the daemon alone
10588 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10589 access to the &_/var/pwcheck_& directory.
10590
10591 The &%pwcheck%& condition takes one argument, which must be the user name and
10592 password, separated by a colon. For example, in a LOGIN authenticator
10593 configuration, you might have this:
10594 .code
10595 server_condition = ${if pwcheck{$auth1:$auth2}}
10596 .endd
10597 Again, for a PLAIN authenticator configuration, this would be:
10598 .code
10599 server_condition = ${if pwcheck{$auth2:$auth3}}
10600 .endd
10601 .vitem &*queue_running*&
10602 .cindex "queue runner" "detecting when delivering from"
10603 .cindex "expansion" "queue runner test"
10604 .cindex "&%queue_running%& expansion condition"
10605 This condition, which has no data, is true during delivery attempts that are
10606 initiated by queue runner processes, and false otherwise.
10607
10608
10609 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10610 .cindex "Radius"
10611 .cindex "expansion" "Radius authentication"
10612 .cindex "&%radius%& expansion condition"
10613 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10614 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10615 the Radius client configuration file in order to build Exim with Radius
10616 support.
10617
10618 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10619 library, using the original API. If you are using release 0.4.0 or later of
10620 this library, you need to set
10621 .code
10622 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10623 .endd
10624 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10625 &%libradius%& library that comes with FreeBSD. To do this, set
10626 .code
10627 RADIUS_LIB_TYPE=RADLIB
10628 .endd
10629 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10630 You may also have to supply a suitable setting in EXTRALIBS so that the
10631 Radius library can be found when Exim is linked.
10632
10633 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10634 Radius client library, which calls the Radius server. The condition is true if
10635 the authentication is successful. For example:
10636 .code
10637 server_condition = ${if radius{<arguments>}}
10638 .endd
10639
10640
10641 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10642         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10643 .cindex "&'saslauthd'& daemon"
10644 .cindex "Cyrus"
10645 .cindex "expansion" "&'saslauthd'& authentication test"
10646 .cindex "&%saslauthd%& expansion condition"
10647 This condition supports user authentication using the Cyrus &'saslauthd'&
10648 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10649 Using this daemon is one way of making it possible for passwords to be checked
10650 by a process that is not running as root.
10651
10652 The saslauthd support is not included in Exim by default. You need to specify
10653 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10654 building Exim. For example:
10655 .code
10656 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10657 .endd
10658 You do not need to install the full Cyrus software suite in order to use
10659 the saslauthd daemon. You can compile and install just the daemon alone
10660 from the Cyrus SASL library.
10661
10662 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10663 two are mandatory. For example:
10664 .code
10665 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10666 .endd
10667 The service and the realm are optional (which is why the arguments are enclosed
10668 in their own set of braces). For details of the meaning of the service and
10669 realm, and how to run the daemon, consult the Cyrus documentation.
10670 .endlist vlist
10671
10672
10673
10674 .section "Combining expansion conditions" "SECID84"
10675 .cindex "expansion" "combining conditions"
10676 Several conditions can be tested at once by combining them using the &%and%&
10677 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10678 conditions on their own, and precede their lists of sub-conditions. Each
10679 sub-condition must be enclosed in braces within the overall braces that contain
10680 the list. No repetition of &%if%& is used.
10681
10682
10683 .vlist
10684 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10685 .cindex "&""or""& expansion condition"
10686 .cindex "expansion" "&""or""& of conditions"
10687 The sub-conditions are evaluated from left to right. The condition is true if
10688 any one of the sub-conditions is true.
10689 For example,
10690 .code
10691 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10692 .endd
10693 When a true sub-condition is found, the following ones are parsed but not
10694 evaluated. If there are several &"match"& sub-conditions the values of the
10695 numeric variables afterwards are taken from the first one that succeeds.
10696
10697 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10698 .cindex "&""and""& expansion condition"
10699 .cindex "expansion" "&""and""& of conditions"
10700 The sub-conditions are evaluated from left to right. The condition is true if
10701 all of the sub-conditions are true. If there are several &"match"&
10702 sub-conditions, the values of the numeric variables afterwards are taken from
10703 the last one. When a false sub-condition is found, the following ones are
10704 parsed but not evaluated.
10705 .endlist
10706 .ecindex IIDexpcond
10707
10708
10709
10710
10711 .section "Expansion variables" "SECTexpvar"
10712 .cindex "expansion" "variables, list of"
10713 This section contains an alphabetical list of all the expansion variables. Some
10714 of them are available only when Exim is compiled with specific options such as
10715 support for TLS or the content scanning extension.
10716
10717 .vlist
10718 .vitem "&$0$&, &$1$&, etc"
10719 .cindex "numerical variables (&$1$& &$2$& etc)"
10720 When a &%match%& expansion condition succeeds, these variables contain the
10721 captured substrings identified by the regular expression during subsequent
10722 processing of the success string of the containing &%if%& expansion item.
10723 However, they do not retain their values afterwards; in fact, their previous
10724 values are restored at the end of processing an &%if%& item. The numerical
10725 variables may also be set externally by some other matching process which
10726 precedes the expansion of the string. For example, the commands available in
10727 Exim filter files include an &%if%& command with its own regular expression
10728 matching condition.
10729
10730 .vitem "&$acl_c...$&"
10731 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10732 can be given any name that starts with &$acl_c$& and is at least six characters
10733 long, but the sixth character must be either a digit or an underscore. For
10734 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10735 variables persist throughout the lifetime of an SMTP connection. They can be
10736 used to pass information between ACLs and between different invocations of the
10737 same ACL. When a message is received, the values of these variables are saved
10738 with the message, and can be accessed by filters, routers, and transports
10739 during subsequent delivery.
10740
10741 .vitem "&$acl_m...$&"
10742 These variables are like the &$acl_c...$& variables, except that their values
10743 are reset after a message has been received. Thus, if several messages are
10744 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10745 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10746 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10747 message is received, the values of these variables are saved with the message,
10748 and can be accessed by filters, routers, and transports during subsequent
10749 delivery.
10750
10751 .vitem &$acl_verify_message$&
10752 .vindex "&$acl_verify_message$&"
10753 After an address verification has failed, this variable contains the failure
10754 message. It retains its value for use in subsequent modifiers. The message can
10755 be preserved by coding like this:
10756 .code
10757 warn !verify = sender
10758      set acl_m0 = $acl_verify_message
10759 .endd
10760 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10761 &%log_message%& modifiers, to include information about the verification
10762 failure.
10763
10764 .vitem &$address_data$&
10765 .vindex "&$address_data$&"
10766 This variable is set by means of the &%address_data%& option in routers. The
10767 value then remains with the address while it is processed by subsequent routers
10768 and eventually a transport. If the transport is handling multiple addresses,
10769 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10770 for more details. &*Note*&: The contents of &$address_data$& are visible in
10771 user filter files.
10772
10773 If &$address_data$& is set when the routers are called from an ACL to verify
10774 a recipient address, the final value is still in the variable for subsequent
10775 conditions and modifiers of the ACL statement. If routing the address caused it
10776 to be redirected to just one address, the child address is also routed as part
10777 of the verification, and in this case the final value of &$address_data$& is
10778 from the child's routing.
10779
10780 If &$address_data$& is set when the routers are called from an ACL to verify a
10781 sender address, the final value is also preserved, but this time in
10782 &$sender_address_data$&, to distinguish it from data from a recipient
10783 address.
10784
10785 In both cases (recipient and sender verification), the value does not persist
10786 after the end of the current ACL statement. If you want to preserve
10787 these values for longer, you can save them in ACL variables.
10788
10789 .vitem &$address_file$&
10790 .vindex "&$address_file$&"
10791 When, as a result of aliasing, forwarding, or filtering, a message is directed
10792 to a specific file, this variable holds the name of the file when the transport
10793 is running. At other times, the variable is empty. For example, using the
10794 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10795 .code
10796 /home/r2d2/savemail
10797 .endd
10798 then when the &(address_file)& transport is running, &$address_file$&
10799 contains the text string &`/home/r2d2/savemail`&.
10800 .cindex "Sieve filter" "value of &$address_file$&"
10801 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10802 then up to the transport configuration to generate an appropriate absolute path
10803 to the relevant file.
10804
10805 .vitem &$address_pipe$&
10806 .vindex "&$address_pipe$&"
10807 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10808 this variable holds the pipe command when the transport is running.
10809
10810 .vitem "&$auth1$& &-- &$auth3$&"
10811 .vindex "&$auth1$&, &$auth2$&, etc"
10812 These variables are used in SMTP authenticators (see chapters
10813 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10814
10815 .vitem &$authenticated_id$&
10816 .cindex "authentication" "id"
10817 .vindex "&$authenticated_id$&"
10818 When a server successfully authenticates a client it may be configured to
10819 preserve some of the authentication information in the variable
10820 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10821 user/password authenticator configuration might preserve the user name for use
10822 in the routers. Note that this is not the same information that is saved in
10823 &$sender_host_authenticated$&.
10824 When a message is submitted locally (that is, not over a TCP connection)
10825 the value of &$authenticated_id$& is normally the login name of the calling
10826 process. However, a trusted user can override this by means of the &%-oMai%&
10827 command line option.
10828
10829
10830
10831
10832 .vitem &$authenticated_sender$&
10833 .cindex "sender" "authenticated"
10834 .cindex "authentication" "sender"
10835 .cindex "AUTH" "on MAIL command"
10836 .vindex "&$authenticated_sender$&"
10837 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10838 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10839 described in section &<<SECTauthparamail>>&. Unless the data is the string
10840 &"<>"&, it is set as the authenticated sender of the message, and the value is
10841 available during delivery in the &$authenticated_sender$& variable. If the
10842 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10843
10844 .vindex "&$qualify_domain$&"
10845 When a message is submitted locally (that is, not over a TCP connection), the
10846 value of &$authenticated_sender$& is an address constructed from the login
10847 name of the calling process and &$qualify_domain$&, except that a trusted user
10848 can override this by means of the &%-oMas%& command line option.
10849
10850
10851 .vitem &$authentication_failed$&
10852 .cindex "authentication" "failure"
10853 .vindex "&$authentication_failed$&"
10854 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10855 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10856 possible to distinguish between &"did not try to authenticate"&
10857 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10858 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10859 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10860 negative response to an AUTH command, including (for example) an attempt to use
10861 an undefined mechanism.
10862
10863 .vitem &$av_failed$&
10864 .cindex "content scanning" "AV scanner failure"
10865 This variable is available when Exim is compiled with the content-scanning
10866 extension. It is set to &"0"& by default, but will be set to &"1"& if any
10867 problem occurs with the virus scanner (specified by &%av_scanner%&) during
10868 the ACL malware condition.
10869
10870 .vitem &$body_linecount$&
10871 .cindex "message body" "line count"
10872 .cindex "body of message" "line count"
10873 .vindex "&$body_linecount$&"
10874 When a message is being received or delivered, this variable contains the
10875 number of lines in the message's body. See also &$message_linecount$&.
10876
10877 .vitem &$body_zerocount$&
10878 .cindex "message body" "binary zero count"
10879 .cindex "body of message" "binary zero count"
10880 .cindex "binary zero" "in message body"
10881 .vindex "&$body_zerocount$&"
10882 When a message is being received or delivered, this variable contains the
10883 number of binary zero bytes (ASCII NULs) in the message's body.
10884
10885 .vitem &$bounce_recipient$&
10886 .vindex "&$bounce_recipient$&"
10887 This is set to the recipient address of a bounce message while Exim is creating
10888 it. It is useful if a customized bounce message text file is in use (see
10889 chapter &<<CHAPemsgcust>>&).
10890
10891 .vitem &$bounce_return_size_limit$&
10892 .vindex "&$bounce_return_size_limit$&"
10893 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10894 up to a multiple of 1000. It is useful when a customized error message text
10895 file is in use (see chapter &<<CHAPemsgcust>>&).
10896
10897 .vitem &$caller_gid$&
10898 .cindex "gid (group id)" "caller"
10899 .vindex "&$caller_gid$&"
10900 The real group id under which the process that called Exim was running. This is
10901 not the same as the group id of the originator of a message (see
10902 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10903 incarnation normally contains the Exim gid.
10904
10905 .vitem &$caller_uid$&
10906 .cindex "uid (user id)" "caller"
10907 .vindex "&$caller_uid$&"
10908 The real user id under which the process that called Exim was running. This is
10909 not the same as the user id of the originator of a message (see
10910 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10911 incarnation normally contains the Exim uid.
10912
10913 .vitem &$compile_date$&
10914 .vindex "&$compile_date$&"
10915 The date on which the Exim binary was compiled.
10916
10917 .vitem &$compile_number$&
10918 .vindex "&$compile_number$&"
10919 The building process for Exim keeps a count of the number
10920 of times it has been compiled. This serves to distinguish different
10921 compilations of the same version of the program.
10922
10923 .vitem &$demime_errorlevel$&
10924 .vindex "&$demime_errorlevel$&"
10925 This variable is available when Exim is compiled with
10926 the content-scanning extension and the obsolete &%demime%& condition. For
10927 details, see section &<<SECTdemimecond>>&.
10928
10929 .vitem &$demime_reason$&
10930 .vindex "&$demime_reason$&"
10931 This variable is available when Exim is compiled with the
10932 content-scanning extension and the obsolete &%demime%& condition. For details,
10933 see section &<<SECTdemimecond>>&.
10934
10935 .vitem &$dnslist_domain$& &&&
10936        &$dnslist_matched$& &&&
10937        &$dnslist_text$& &&&
10938        &$dnslist_value$&
10939 .vindex "&$dnslist_domain$&"
10940 .vindex "&$dnslist_matched$&"
10941 .vindex "&$dnslist_text$&"
10942 .vindex "&$dnslist_value$&"
10943 .cindex "black list (DNS)"
10944 When a DNS (black) list lookup succeeds, these variables are set to contain
10945 the following data from the lookup: the list's domain name, the key that was
10946 looked up, the contents of any associated TXT record, and the value from the
10947 main A record. See section &<<SECID204>>& for more details.
10948
10949 .vitem &$domain$&
10950 .vindex "&$domain$&"
10951 When an address is being routed, or delivered on its own, this variable
10952 contains the domain. Uppercase letters in the domain are converted into lower
10953 case for &$domain$&.
10954
10955 Global address rewriting happens when a message is received, so the value of
10956 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10957 is set during user filtering, but not during system filtering, because a
10958 message may have many recipients and the system filter is called just once.
10959
10960 When more than one address is being delivered at once (for example, several
10961 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10962 have the same domain. Transports can be restricted to handling only one domain
10963 at a time if the value of &$domain$& is required at transport time &-- this is
10964 the default for local transports. For further details of the environment in
10965 which local transports are run, see chapter &<<CHAPenvironment>>&.
10966
10967 .oindex "&%delay_warning_condition%&"
10968 At the end of a delivery, if all deferred addresses have the same domain, it is
10969 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10970
10971 The &$domain$& variable is also used in some other circumstances:
10972
10973 .ilist
10974 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10975 the recipient address. The domain of the &'sender'& address is in
10976 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10977 normally set during the running of the MAIL ACL. However, if the sender address
10978 is verified with a callout during the MAIL ACL, the sender domain is placed in
10979 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10980 the &(smtp)& transport.
10981
10982 .next
10983 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10984 &$domain$& contains the domain portion of the address that is being rewritten;
10985 it can be used in the expansion of the replacement address, for example, to
10986 rewrite domains by file lookup.
10987
10988 .next
10989 With one important exception, whenever a domain list is being scanned,
10990 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10991 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10992 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10993 that, in a RCPT ACL, the sender domain list can be dependent on the
10994 recipient domain (which is what is in &$domain$& at this time).
10995
10996 .next
10997 .cindex "ETRN" "value of &$domain$&"
10998 .oindex "&%smtp_etrn_command%&"
10999 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11000 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11001 .endlist
11002
11003
11004 .vitem &$domain_data$&
11005 .vindex "&$domain_data$&"
11006 When the &%domains%& option on a router matches a domain by
11007 means of a lookup, the data read by the lookup is available during the running
11008 of the router as &$domain_data$&. In addition, if the driver routes the
11009 address to a transport, the value is available in that transport. If the
11010 transport is handling multiple addresses, the value from the first address is
11011 used.
11012
11013 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11014 domain by means of a lookup. The data read by the lookup is available during
11015 the rest of the ACL statement. In all other situations, this variable expands
11016 to nothing.
11017
11018 .vitem &$exim_gid$&
11019 .vindex "&$exim_gid$&"
11020 This variable contains the numerical value of the Exim group id.
11021
11022 .vitem &$exim_path$&
11023 .vindex "&$exim_path$&"
11024 This variable contains the path to the Exim binary.
11025
11026 .vitem &$exim_uid$&
11027 .vindex "&$exim_uid$&"
11028 This variable contains the numerical value of the Exim user id.
11029
11030 .vitem &$found_extension$&
11031 .vindex "&$found_extension$&"
11032 This variable is available when Exim is compiled with the
11033 content-scanning extension and the obsolete &%demime%& condition. For details,
11034 see section &<<SECTdemimecond>>&.
11035
11036 .vitem &$header_$&<&'name'&>
11037 This is not strictly an expansion variable. It is expansion syntax for
11038 inserting the message header line with the given name. Note that the name must
11039 be terminated by colon or white space, because it may contain a wide variety of
11040 characters. Note also that braces must &'not'& be used.
11041
11042 .vitem &$home$&
11043 .vindex "&$home$&"
11044 When the &%check_local_user%& option is set for a router, the user's home
11045 directory is placed in &$home$& when the check succeeds. In particular, this
11046 means it is set during the running of users' filter files. A router may also
11047 explicitly set a home directory for use by a transport; this can be overridden
11048 by a setting on the transport itself.
11049
11050 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11051 of the environment variable HOME.
11052
11053 .vitem &$host$&
11054 .vindex "&$host$&"
11055 If a router assigns an address to a transport (any transport), and passes a
11056 list of hosts with the address, the value of &$host$& when the transport starts
11057 to run is the name of the first host on the list. Note that this applies both
11058 to local and remote transports.
11059
11060 .cindex "transport" "filter"
11061 .cindex "filter" "transport filter"
11062 For the &(smtp)& transport, if there is more than one host, the value of
11063 &$host$& changes as the transport works its way through the list. In
11064 particular, when the &(smtp)& transport is expanding its options for encryption
11065 using TLS, or for specifying a transport filter (see chapter
11066 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11067 is connected.
11068
11069 When used in the client part of an authenticator configuration (see chapter
11070 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11071 client is connected.
11072
11073
11074 .vitem &$host_address$&
11075 .vindex "&$host_address$&"
11076 This variable is set to the remote host's IP address whenever &$host$& is set
11077 for a remote connection. It is also set to the IP address that is being checked
11078 when the &%ignore_target_hosts%& option is being processed.
11079
11080 .vitem &$host_data$&
11081 .vindex "&$host_data$&"
11082 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11083 result of the lookup is made available in the &$host_data$& variable. This
11084 allows you, for example, to do things like this:
11085 .code
11086 deny  hosts = net-lsearch;/some/file
11087 message = $host_data
11088 .endd
11089 .vitem &$host_lookup_deferred$&
11090 .cindex "host name" "lookup, failure of"
11091 .vindex "&$host_lookup_deferred$&"
11092 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11093 message comes from a remote host and there is an attempt to look up the host's
11094 name from its IP address, and the attempt is not successful, one of these
11095 variables is set to &"1"&.
11096
11097 .ilist
11098 If the lookup receives a definite negative response (for example, a DNS lookup
11099 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11100
11101 .next
11102 If there is any kind of problem during the lookup, such that Exim cannot
11103 tell whether or not the host name is defined (for example, a timeout for a DNS
11104 lookup), &$host_lookup_deferred$& is set to &"1"&.
11105 .endlist ilist
11106
11107 Looking up a host's name from its IP address consists of more than just a
11108 single reverse lookup. Exim checks that a forward lookup of at least one of the
11109 names it receives from a reverse lookup yields the original IP address. If this
11110 is not the case, Exim does not accept the looked up name(s), and
11111 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11112 IP address (for example, the existence of a PTR record in the DNS) is not
11113 sufficient on its own for the success of a host name lookup. If the reverse
11114 lookup succeeds, but there is a lookup problem such as a timeout when checking
11115 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11116 &"1"&. See also &$sender_host_name$&.
11117
11118 .vitem &$host_lookup_failed$&
11119 .vindex "&$host_lookup_failed$&"
11120 See &$host_lookup_deferred$&.
11121
11122
11123 .vitem &$inode$&
11124 .vindex "&$inode$&"
11125 The only time this variable is set is while expanding the &%directory_file%&
11126 option in the &(appendfile)& transport. The variable contains the inode number
11127 of the temporary file which is about to be renamed. It can be used to construct
11128 a unique name for the file.
11129
11130 .vitem &$interface_address$&
11131 .vindex "&$interface_address$&"
11132 This is an obsolete name for &$received_ip_address$&.
11133
11134 .vitem &$interface_port$&
11135 .vindex "&$interface_port$&"
11136 This is an obsolete name for &$received_port$&.
11137
11138 .vitem &$item$&
11139 .vindex "&$item$&"
11140 This variable is used during the expansion of &*forall*& and &*forany*&
11141 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11142 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11143 empty.
11144
11145 .vitem &$ldap_dn$&
11146 .vindex "&$ldap_dn$&"
11147 This variable, which is available only when Exim is compiled with LDAP support,
11148 contains the DN from the last entry in the most recently successful LDAP
11149 lookup.
11150
11151 .vitem &$load_average$&
11152 .vindex "&$load_average$&"
11153 This variable contains the system load average, multiplied by 1000 so that it
11154 is an integer. For example, if the load average is 0.21, the value of the
11155 variable is 210. The value is recomputed every time the variable is referenced.
11156
11157 .vitem &$local_part$&
11158 .vindex "&$local_part$&"
11159 When an address is being routed, or delivered on its own, this
11160 variable contains the local part. When a number of addresses are being
11161 delivered together (for example, multiple RCPT commands in an SMTP
11162 session), &$local_part$& is not set.
11163
11164 Global address rewriting happens when a message is received, so the value of
11165 &$local_part$& during routing and delivery is the value after rewriting.
11166 &$local_part$& is set during user filtering, but not during system filtering,
11167 because a message may have many recipients and the system filter is called just
11168 once.
11169
11170 .vindex "&$local_part_prefix$&"
11171 .vindex "&$local_part_suffix$&"
11172 If a local part prefix or suffix has been recognized, it is not included in the
11173 value of &$local_part$& during routing and subsequent delivery. The values of
11174 any prefix or suffix are in &$local_part_prefix$& and
11175 &$local_part_suffix$&, respectively.
11176
11177 When a message is being delivered to a file, pipe, or autoreply transport as a
11178 result of aliasing or forwarding, &$local_part$& is set to the local part of
11179 the parent address, not to the file name or command (see &$address_file$& and
11180 &$address_pipe$&).
11181
11182 When an ACL is running for a RCPT command, &$local_part$& contains the
11183 local part of the recipient address.
11184
11185 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11186 &$local_part$& contains the local part of the address that is being rewritten;
11187 it can be used in the expansion of the replacement address, for example.
11188
11189 In all cases, all quoting is removed from the local part. For example, for both
11190 the addresses
11191 .code
11192 "abc:xyz"@test.example
11193 abc\:xyz@test.example
11194 .endd
11195 the value of &$local_part$& is
11196 .code
11197 abc:xyz
11198 .endd
11199 If you use &$local_part$& to create another address, you should always wrap it
11200 inside a quoting operator. For example, in a &(redirect)& router you could
11201 have:
11202 .code
11203 data = ${quote_local_part:$local_part}@new.domain.example
11204 .endd
11205 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11206 to process local parts in a case-dependent manner in a router, you can set the
11207 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11208
11209 .vitem &$local_part_data$&
11210 .vindex "&$local_part_data$&"
11211 When the &%local_parts%& option on a router matches a local part by means of a
11212 lookup, the data read by the lookup is available during the running of the
11213 router as &$local_part_data$&. In addition, if the driver routes the address
11214 to a transport, the value is available in that transport. If the transport is
11215 handling multiple addresses, the value from the first address is used.
11216
11217 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11218 matches a local part by means of a lookup. The data read by the lookup is
11219 available during the rest of the ACL statement. In all other situations, this
11220 variable expands to nothing.
11221
11222 .vitem &$local_part_prefix$&
11223 .vindex "&$local_part_prefix$&"
11224 When an address is being routed or delivered, and a
11225 specific prefix for the local part was recognized, it is available in this
11226 variable, having been removed from &$local_part$&.
11227
11228 .vitem &$local_part_suffix$&
11229 .vindex "&$local_part_suffix$&"
11230 When an address is being routed or delivered, and a
11231 specific suffix for the local part was recognized, it is available in this
11232 variable, having been removed from &$local_part$&.
11233
11234 .vitem &$local_scan_data$&
11235 .vindex "&$local_scan_data$&"
11236 This variable contains the text returned by the &[local_scan()]& function when
11237 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11238
11239 .vitem &$local_user_gid$&
11240 .vindex "&$local_user_gid$&"
11241 See &$local_user_uid$&.
11242
11243 .vitem &$local_user_uid$&
11244 .vindex "&$local_user_uid$&"
11245 This variable and &$local_user_gid$& are set to the uid and gid after the
11246 &%check_local_user%& router precondition succeeds. This means that their values
11247 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11248 and &%condition%&), for the &%address_data%& expansion, and for any
11249 router-specific expansions. At all other times, the values in these variables
11250 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11251
11252 .vitem &$localhost_number$&
11253 .vindex "&$localhost_number$&"
11254 This contains the expanded value of the
11255 &%localhost_number%& option. The expansion happens after the main options have
11256 been read.
11257
11258 .vitem &$log_inodes$&
11259 .vindex "&$log_inodes$&"
11260 The number of free inodes in the disk partition where Exim's
11261 log files are being written. The value is recalculated whenever the variable is
11262 referenced. If the relevant file system does not have the concept of inodes,
11263 the value of is -1. See also the &%check_log_inodes%& option.
11264
11265 .vitem &$log_space$&
11266 .vindex "&$log_space$&"
11267 The amount of free space (as a number of kilobytes) in the disk
11268 partition where Exim's log files are being written. The value is recalculated
11269 whenever the variable is referenced. If the operating system does not have the
11270 ability to find the amount of free space (only true for experimental systems),
11271 the space value is -1. See also the &%check_log_space%& option.
11272
11273
11274 .vitem &$mailstore_basename$&
11275 .vindex "&$mailstore_basename$&"
11276 This variable is set only when doing deliveries in &"mailstore"& format in the
11277 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11278 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11279 contains the basename of the files that are being written, that is, the name
11280 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11281 variable is empty.
11282
11283 .vitem &$malware_name$&
11284 .vindex "&$malware_name$&"
11285 This variable is available when Exim is compiled with the
11286 content-scanning extension. It is set to the name of the virus that was found
11287 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11288
11289 .vitem &$max_received_linelength$&
11290 .vindex "&$max_received_linelength$&"
11291 .cindex "maximum" "line length"
11292 .cindex "line length" "maximum"
11293 This variable contains the number of bytes in the longest line that was
11294 received as part of the message, not counting the line termination
11295 character(s).
11296
11297 .vitem &$message_age$&
11298 .cindex "message" "age of"
11299 .vindex "&$message_age$&"
11300 This variable is set at the start of a delivery attempt to contain the number
11301 of seconds since the message was received. It does not change during a single
11302 delivery attempt.
11303
11304 .vitem &$message_body$&
11305 .cindex "body of message" "expansion variable"
11306 .cindex "message body" "in expansion"
11307 .cindex "binary zero" "in message body"
11308 .vindex "&$message_body$&"
11309 .oindex "&%message_body_visible%&"
11310 This variable contains the initial portion of a message's body while it is
11311 being delivered, and is intended mainly for use in filter files. The maximum
11312 number of characters of the body that are put into the variable is set by the
11313 &%message_body_visible%& configuration option; the default is 500.
11314
11315 .oindex "&%message_body_newlines%&"
11316 By default, newlines are converted into spaces in &$message_body$&, to make it
11317 easier to search for phrases that might be split over a line break. However,
11318 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11319 zeros are always converted into spaces.
11320
11321 .vitem &$message_body_end$&
11322 .cindex "body of message" "expansion variable"
11323 .cindex "message body" "in expansion"
11324 .vindex "&$message_body_end$&"
11325 This variable contains the final portion of a message's
11326 body while it is being delivered. The format and maximum size are as for
11327 &$message_body$&.
11328
11329 .vitem &$message_body_size$&
11330 .cindex "body of message" "size"
11331 .cindex "message body" "size"
11332 .vindex "&$message_body_size$&"
11333 When a message is being delivered, this variable contains the size of the body
11334 in bytes. The count starts from the character after the blank line that
11335 separates the body from the header. Newlines are included in the count. See
11336 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11337
11338 .vitem &$message_exim_id$&
11339 .vindex "&$message_exim_id$&"
11340 When a message is being received or delivered, this variable contains the
11341 unique message id that is generated and used by Exim to identify the message.
11342 An id is not created for a message until after its header has been successfully
11343 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11344 line; it is the local id that Exim assigns to the message, for example:
11345 &`1BXTIK-0001yO-VA`&.
11346
11347 .vitem &$message_headers$&
11348 .vindex &$message_headers$&
11349 This variable contains a concatenation of all the header lines when a message
11350 is being processed, except for lines added by routers or transports. The header
11351 lines are separated by newline characters. Their contents are decoded in the
11352 same way as a header line that is inserted by &%bheader%&.
11353
11354 .vitem &$message_headers_raw$&
11355 .vindex &$message_headers_raw$&
11356 This variable is like &$message_headers$& except that no processing of the
11357 contents of header lines is done.
11358
11359 .vitem &$message_id$&
11360 This is an old name for &$message_exim_id$&, which is now deprecated.
11361
11362 .vitem &$message_linecount$&
11363 .vindex "&$message_linecount$&"
11364 This variable contains the total number of lines in the header and body of the
11365 message. Compare &$body_linecount$&, which is the count for the body only.
11366 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11367 number of lines received. Before delivery happens (that is, before filters,
11368 routers, and transports run) the count is increased to include the
11369 &'Received:'& header line that Exim standardly adds, and also any other header
11370 lines that are added by ACLs. The blank line that separates the message header
11371 from the body is not counted.
11372
11373 As with the special case of &$message_size$&, during the expansion of the
11374 appendfile transport's maildir_tag option in maildir format, the value of
11375 &$message_linecount$& is the precise size of the number of newlines in the
11376 file that has been written (minus one for the blank line between the
11377 header and the body).
11378
11379 Here is an example of the use of this variable in a DATA ACL:
11380 .code
11381 deny message   = Too many lines in message header
11382      condition = \
11383       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11384 .endd
11385 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11386 message has not yet been received.
11387
11388 .vitem &$message_size$&
11389 .cindex "size" "of message"
11390 .cindex "message" "size"
11391 .vindex "&$message_size$&"
11392 When a message is being processed, this variable contains its size in bytes. In
11393 most cases, the size includes those headers that were received with the
11394 message, but not those (such as &'Envelope-to:'&) that are added to individual
11395 deliveries as they are written. However, there is one special case: during the
11396 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11397 doing a delivery in maildir format, the value of &$message_size$& is the
11398 precise size of the file that has been written. See also
11399 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11400
11401 .cindex "RCPT" "value of &$message_size$&"
11402 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11403 contains the size supplied on the MAIL command, or -1 if no size was given. The
11404 value may not, of course, be truthful.
11405
11406 .vitem &$mime_$&&'xxx'&
11407 A number of variables whose names start with &$mime$& are
11408 available when Exim is compiled with the content-scanning extension. For
11409 details, see section &<<SECTscanmimepart>>&.
11410
11411 .vitem "&$n0$& &-- &$n9$&"
11412 These variables are counters that can be incremented by means
11413 of the &%add%& command in filter files.
11414
11415 .vitem &$original_domain$&
11416 .vindex "&$domain$&"
11417 .vindex "&$original_domain$&"
11418 When a top-level address is being processed for delivery, this contains the
11419 same value as &$domain$&. However, if a &"child"& address (for example,
11420 generated by an alias, forward, or filter file) is being processed, this
11421 variable contains the domain of the original address (lower cased). This
11422 differs from &$parent_domain$& only when there is more than one level of
11423 aliasing or forwarding. When more than one address is being delivered in a
11424 single transport run, &$original_domain$& is not set.
11425
11426 If a new address is created by means of a &%deliver%& command in a system
11427 filter, it is set up with an artificial &"parent"& address. This has the local
11428 part &'system-filter'& and the default qualify domain.
11429
11430 .vitem &$original_local_part$&
11431 .vindex "&$local_part$&"
11432 .vindex "&$original_local_part$&"
11433 When a top-level address is being processed for delivery, this contains the
11434 same value as &$local_part$&, unless a prefix or suffix was removed from the
11435 local part, because &$original_local_part$& always contains the full local
11436 part. When a &"child"& address (for example, generated by an alias, forward, or
11437 filter file) is being processed, this variable contains the full local part of
11438 the original address.
11439
11440 If the router that did the redirection processed the local part
11441 case-insensitively, the value in &$original_local_part$& is in lower case.
11442 This variable differs from &$parent_local_part$& only when there is more than
11443 one level of aliasing or forwarding. When more than one address is being
11444 delivered in a single transport run, &$original_local_part$& is not set.
11445
11446 If a new address is created by means of a &%deliver%& command in a system
11447 filter, it is set up with an artificial &"parent"& address. This has the local
11448 part &'system-filter'& and the default qualify domain.
11449
11450 .vitem &$originator_gid$&
11451 .cindex "gid (group id)" "of originating user"
11452 .cindex "sender" "gid"
11453 .vindex "&$caller_gid$&"
11454 .vindex "&$originator_gid$&"
11455 This variable contains the value of &$caller_gid$& that was set when the
11456 message was received. For messages received via the command line, this is the
11457 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11458 normally the gid of the Exim user.
11459
11460 .vitem &$originator_uid$&
11461 .cindex "uid (user id)" "of originating user"
11462 .cindex "sender" "uid"
11463 .vindex "&$caller_uid$&"
11464 .vindex "&$originaltor_uid$&"
11465 The value of &$caller_uid$& that was set when the message was received. For
11466 messages received via the command line, this is the uid of the sending user.
11467 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11468 user.
11469
11470 .vitem &$parent_domain$&
11471 .vindex "&$parent_domain$&"
11472 This variable is similar to &$original_domain$& (see
11473 above), except that it refers to the immediately preceding parent address.
11474
11475 .vitem &$parent_local_part$&
11476 .vindex "&$parent_local_part$&"
11477 This variable is similar to &$original_local_part$&
11478 (see above), except that it refers to the immediately preceding parent address.
11479
11480 .vitem &$pid$&
11481 .cindex "pid (process id)" "of current process"
11482 .vindex "&$pid$&"
11483 This variable contains the current process id.
11484
11485 .vitem &$pipe_addresses$&
11486 .cindex "filter" "transport filter"
11487 .cindex "transport" "filter"
11488 .vindex "&$pipe_addresses$&"
11489 This is not an expansion variable, but is mentioned here because the string
11490 &`$pipe_addresses`& is handled specially in the command specification for the
11491 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11492 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11493 It cannot be used in general expansion strings, and provokes an &"unknown
11494 variable"& error if encountered.
11495
11496 .vitem &$primary_hostname$&
11497 .vindex "&$primary_hostname$&"
11498 This variable contains the value set by &%primary_hostname%& in the
11499 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11500 a single-component name, Exim calls &[gethostbyname()]& (or
11501 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11502 qualified host name. See also &$smtp_active_hostname$&.
11503
11504
11505 .vitem &$prvscheck_address$&
11506 This variable is used in conjunction with the &%prvscheck%& expansion item,
11507 which is described in sections &<<SECTexpansionitems>>& and
11508 &<<SECTverifyPRVS>>&.
11509
11510 .vitem &$prvscheck_keynum$&
11511 This variable is used in conjunction with the &%prvscheck%& expansion item,
11512 which is described in sections &<<SECTexpansionitems>>& and
11513 &<<SECTverifyPRVS>>&.
11514
11515 .vitem &$prvscheck_result$&
11516 This variable is used in conjunction with the &%prvscheck%& expansion item,
11517 which is described in sections &<<SECTexpansionitems>>& and
11518 &<<SECTverifyPRVS>>&.
11519
11520 .vitem &$qualify_domain$&
11521 .vindex "&$qualify_domain$&"
11522 The value set for the &%qualify_domain%& option in the configuration file.
11523
11524 .vitem &$qualify_recipient$&
11525 .vindex "&$qualify_recipient$&"
11526 The value set for the &%qualify_recipient%& option in the configuration file,
11527 or if not set, the value of &$qualify_domain$&.
11528
11529 .vitem &$rcpt_count$&
11530 .vindex "&$rcpt_count$&"
11531 When a message is being received by SMTP, this variable contains the number of
11532 RCPT commands received for the current message. If this variable is used in a
11533 RCPT ACL, its value includes the current command.
11534
11535 .vitem &$rcpt_defer_count$&
11536 .vindex "&$rcpt_defer_count$&"
11537 .cindex "4&'xx'& responses" "count of"
11538 When a message is being received by SMTP, this variable contains the number of
11539 RCPT commands in the current message that have previously been rejected with a
11540 temporary (4&'xx'&) response.
11541
11542 .vitem &$rcpt_fail_count$&
11543 .vindex "&$rcpt_fail_count$&"
11544 When a message is being received by SMTP, this variable contains the number of
11545 RCPT commands in the current message that have previously been rejected with a
11546 permanent (5&'xx'&) response.
11547
11548 .vitem &$received_count$&
11549 .vindex "&$received_count$&"
11550 This variable contains the number of &'Received:'& header lines in the message,
11551 including the one added by Exim (so its value is always greater than zero). It
11552 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11553 delivering.
11554
11555 .vitem &$received_for$&
11556 .vindex "&$received_for$&"
11557 If there is only a single recipient address in an incoming message, this
11558 variable contains that address when the &'Received:'& header line is being
11559 built. The value is copied after recipient rewriting has happened, but before
11560 the &[local_scan()]& function is run.
11561
11562 .vitem &$received_ip_address$&
11563 .vindex "&$received_ip_address$&"
11564 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11565 variable is set to the address of the local IP interface, and &$received_port$&
11566 is set to the local port number. (The remote IP address and port are in
11567 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11568 the port value is -1 unless it has been set using the &%-oMi%& command line
11569 option.
11570
11571 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11572 could be used, for example, to make the file name for a TLS certificate depend
11573 on which interface and/or port is being used for the incoming connection. The
11574 values of &$received_ip_address$& and &$received_port$& are saved with any
11575 messages that are received, thus making these variables available at delivery
11576 time.
11577
11578 &*Note:*& There are no equivalent variables for outgoing connections, because
11579 the values are unknown (unless they are explicitly set by options of the
11580 &(smtp)& transport).
11581
11582 .vitem &$received_port$&
11583 .vindex "&$received_port$&"
11584 See &$received_ip_address$&.
11585
11586 .vitem &$received_protocol$&
11587 .vindex "&$received_protocol$&"
11588 When a message is being processed, this variable contains the name of the
11589 protocol by which it was received. Most of the names used by Exim are defined
11590 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11591 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11592 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11593 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11594 connection and the client was successfully authenticated.
11595
11596 Exim uses the protocol name &"smtps"& for the case when encryption is
11597 automatically set up on connection without the use of STARTTLS (see
11598 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11599 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11600 where the client initially uses EHLO, sets up an encrypted connection using
11601 STARTTLS, and then uses HELO afterwards.
11602
11603 The &%-oMr%& option provides a way of specifying a custom protocol name for
11604 messages that are injected locally by trusted callers. This is commonly used to
11605 identify messages that are being re-injected after some kind of scanning.
11606
11607 .vitem &$received_time$&
11608 .vindex "&$received_time$&"
11609 This variable contains the date and time when the current message was received,
11610 as a number of seconds since the start of the Unix epoch.
11611
11612 .vitem &$recipient_data$&
11613 .vindex "&$recipient_data$&"
11614 This variable is set after an indexing lookup success in an ACL &%recipients%&
11615 condition. It contains the data from the lookup, and the value remains set
11616 until the next &%recipients%& test. Thus, you can do things like this:
11617 .display
11618 &`require recipients  = cdb*@;/some/file`&
11619 &`deny    `&&'some further test involving'& &`$recipient_data`&
11620 .endd
11621 &*Warning*&: This variable is set only when a lookup is used as an indexing
11622 method in the address list, using the semicolon syntax as in the example above.
11623 The variable is not set for a lookup that is used as part of the string
11624 expansion that all such lists undergo before being interpreted.
11625
11626 .vitem &$recipient_verify_failure$&
11627 .vindex "&$recipient_verify_failure$&"
11628 In an ACL, when a recipient verification fails, this variable contains
11629 information about the failure. It is set to one of the following words:
11630
11631 .ilist
11632 &"qualify"&: The address was unqualified (no domain), and the message
11633 was neither local nor came from an exempted host.
11634
11635 .next
11636 &"route"&: Routing failed.
11637
11638 .next
11639 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11640 or before the MAIL command (that is, on initial connection, HELO, or
11641 MAIL).
11642
11643 .next
11644 &"recipient"&: The RCPT command in a callout was rejected.
11645 .next
11646
11647 &"postmaster"&: The postmaster check in a callout was rejected.
11648 .endlist
11649
11650 The main use of this variable is expected to be to distinguish between
11651 rejections of MAIL and rejections of RCPT.
11652
11653 .vitem &$recipients$&
11654 .vindex "&$recipients$&"
11655 This variable contains a list of envelope recipients for a message. A comma and
11656 a space separate the addresses in the replacement text. However, the variable
11657 is not generally available, to prevent exposure of Bcc recipients in
11658 unprivileged users' filter files. You can use &$recipients$& only in these
11659 cases:
11660
11661 .olist
11662 In a system filter file.
11663 .next
11664 In the ACLs associated with the DATA command and with non-SMTP messages, that
11665 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11666 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11667 &%acl_not_smtp_mime%&.
11668 .next
11669 From within a &[local_scan()]& function.
11670 .endlist
11671
11672
11673 .vitem &$recipients_count$&
11674 .vindex "&$recipients_count$&"
11675 When a message is being processed, this variable contains the number of
11676 envelope recipients that came with the message. Duplicates are not excluded
11677 from the count. While a message is being received over SMTP, the number
11678 increases for each accepted recipient. It can be referenced in an ACL.
11679
11680
11681 .vitem &$regex_match_string$&
11682 .vindex "&$regex_match_string$&"
11683 This variable is set to contain the matching regular expression after a
11684 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11685
11686
11687 .vitem &$reply_address$&
11688 .vindex "&$reply_address$&"
11689 When a message is being processed, this variable contains the contents of the
11690 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11691 contents of the &'From:'& header line. Apart from the removal of leading
11692 white space, the value is not processed in any way. In particular, no RFC 2047
11693 decoding or character code translation takes place.
11694
11695 .vitem &$return_path$&
11696 .vindex "&$return_path$&"
11697 When a message is being delivered, this variable contains the return path &--
11698 the sender field that will be sent as part of the envelope. It is not enclosed
11699 in <> characters. At the start of routing an address, &$return_path$& has the
11700 same value as &$sender_address$&, but if, for example, an incoming message to a
11701 mailing list has been expanded by a router which specifies a different address
11702 for bounce messages, &$return_path$& subsequently contains the new bounce
11703 address, whereas &$sender_address$& always contains the original sender address
11704 that was received with the message. In other words, &$sender_address$& contains
11705 the incoming envelope sender, and &$return_path$& contains the outgoing
11706 envelope sender.
11707
11708 .vitem &$return_size_limit$&
11709 .vindex "&$return_size_limit$&"
11710 This is an obsolete name for &$bounce_return_size_limit$&.
11711
11712 .vitem &$runrc$&
11713 .cindex "return code" "from &%run%& expansion"
11714 .vindex "&$runrc$&"
11715 This variable contains the return code from a command that is run by the
11716 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11717 assume the order in which option values are expanded, except for those
11718 preconditions whose order of testing is documented. Therefore, you cannot
11719 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11720 another.
11721
11722 .vitem &$self_hostname$&
11723 .oindex "&%self%&" "value of host name"
11724 .vindex "&$self_hostname$&"
11725 When an address is routed to a supposedly remote host that turns out to be the
11726 local host, what happens is controlled by the &%self%& generic router option.
11727 One of its values causes the address to be passed to another router. When this
11728 happens, &$self_hostname$& is set to the name of the local host that the
11729 original router encountered. In other circumstances its contents are null.
11730
11731 .vitem &$sender_address$&
11732 .vindex "&$sender_address$&"
11733 When a message is being processed, this variable contains the sender's address
11734 that was received in the message's envelope. The case of letters in the address
11735 is retained, in both the local part and the domain. For bounce messages, the
11736 value of this variable is the empty string. See also &$return_path$&.
11737
11738 .vitem &$sender_address_data$&
11739 .vindex "&$address_data$&"
11740 .vindex "&$sender_address_data$&"
11741 If &$address_data$& is set when the routers are called from an ACL to verify a
11742 sender address, the final value is preserved in &$sender_address_data$&, to
11743 distinguish it from data from a recipient address. The value does not persist
11744 after the end of the current ACL statement. If you want to preserve it for
11745 longer, you can save it in an ACL variable.
11746
11747 .vitem &$sender_address_domain$&
11748 .vindex "&$sender_address_domain$&"
11749 The domain portion of &$sender_address$&.
11750
11751 .vitem &$sender_address_local_part$&
11752 .vindex "&$sender_address_local_part$&"
11753 The local part portion of &$sender_address$&.
11754
11755 .vitem &$sender_data$&
11756 .vindex "&$sender_data$&"
11757 This variable is set after a lookup success in an ACL &%senders%& condition or
11758 in a router &%senders%& option. It contains the data from the lookup, and the
11759 value remains set until the next &%senders%& test. Thus, you can do things like
11760 this:
11761 .display
11762 &`require senders      = cdb*@;/some/file`&
11763 &`deny    `&&'some further test involving'& &`$sender_data`&
11764 .endd
11765 &*Warning*&: This variable is set only when a lookup is used as an indexing
11766 method in the address list, using the semicolon syntax as in the example above.
11767 The variable is not set for a lookup that is used as part of the string
11768 expansion that all such lists undergo before being interpreted.
11769
11770 .vitem &$sender_fullhost$&
11771 .vindex "&$sender_fullhost$&"
11772 When a message is received from a remote host, this variable contains the host
11773 name and IP address in a single string. It ends with the IP address in square
11774 brackets, followed by a colon and a port number if the logging of ports is
11775 enabled. The format of the rest of the string depends on whether the host
11776 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11777 looking up its IP address. (Looking up the IP address can be forced by the
11778 &%host_lookup%& option, independent of verification.) A plain host name at the
11779 start of the string is a verified host name; if this is not present,
11780 verification either failed or was not requested. A host name in parentheses is
11781 the argument of a HELO or EHLO command. This is omitted if it is identical to
11782 the verified host name or to the host's IP address in square brackets.
11783
11784 .vitem &$sender_helo_name$&
11785 .vindex "&$sender_helo_name$&"
11786 When a message is received from a remote host that has issued a HELO or EHLO
11787 command, the argument of that command is placed in this variable. It is also
11788 set if HELO or EHLO is used when a message is received using SMTP locally via
11789 the &%-bs%& or &%-bS%& options.
11790
11791 .vitem &$sender_host_address$&
11792 .vindex "&$sender_host_address$&"
11793 When a message is received from a remote host, this variable contains that
11794 host's IP address. For locally submitted messages, it is empty.
11795
11796 .vitem &$sender_host_authenticated$&
11797 .vindex "&$sender_host_authenticated$&"
11798 This variable contains the name (not the public name) of the authenticator
11799 driver that successfully authenticated the client from which the message was
11800 received. It is empty if there was no successful authentication. See also
11801 &$authenticated_id$&.
11802
11803 .new
11804 .vitem &$sender_host_dnssec$&
11805 .vindex "&$sender_host_dnssec$&"
11806 If &$sender_host_name$& has been populated (by reference, &%hosts_lookup%& or
11807 otherwise) then this boolean will have been set true if, and only if, the
11808 resolver library states that the reverse DNS was authenticated data.  At all
11809 other times, this variable is false.
11810
11811 It is likely that you will need to coerce DNSSEC support on in the resolver
11812 library, by setting:
11813 .code
11814 dns_use_dnssec = 1
11815 .endd
11816
11817 Exim does not perform DNSSEC validation itself, instead leaving that to a
11818 validating resolver (eg, unbound, or bind with suitable configuration).
11819
11820 Exim does not (currently) check to see if the forward DNS was also secured
11821 with DNSSEC, only the reverse DNS.
11822
11823 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
11824 mechanism in the list, then this variable will be false.
11825 .wen
11826
11827
11828 .vitem &$sender_host_name$&
11829 .vindex "&$sender_host_name$&"
11830 When a message is received from a remote host, this variable contains the
11831 host's name as obtained by looking up its IP address. For messages received by
11832 other means, this variable is empty.
11833
11834 .vindex "&$host_lookup_failed$&"
11835 If the host name has not previously been looked up, a reference to
11836 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11837 A looked up name is accepted only if it leads back to the original IP address
11838 via a forward lookup. If either the reverse or the forward lookup fails to find
11839 any data, or if the forward lookup does not yield the original IP address,
11840 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11841
11842 .vindex "&$host_lookup_deferred$&"
11843 However, if either of the lookups cannot be completed (for example, there is a
11844 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11845 &$host_lookup_failed$& remains set to &"0"&.
11846
11847 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11848 host name again if there is a subsequent reference to &$sender_host_name$&
11849 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11850 is set to &"1"&.
11851
11852 Exim does not automatically look up every calling host's name. If you want
11853 maximum efficiency, you should arrange your configuration so that it avoids
11854 these lookups altogether. The lookup happens only if one or more of the
11855 following are true:
11856
11857 .ilist
11858 A string containing &$sender_host_name$& is expanded.
11859 .next
11860 The calling host matches the list in &%host_lookup%&. In the default
11861 configuration, this option is set to *, so it must be changed if lookups are
11862 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11863 .next
11864 Exim needs the host name in order to test an item in a host list. The items
11865 that require this are described in sections &<<SECThoslispatnam>>& and
11866 &<<SECThoslispatnamsk>>&.
11867 .next
11868 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11869 In this case, the host name is required to compare with the name quoted in any
11870 EHLO or HELO commands that the client issues.
11871 .next
11872 The remote host issues a EHLO or HELO command that quotes one of the
11873 domains in &%helo_lookup_domains%&. The default value of this option is
11874 . ==== As this is a nested list, any displays it contains must be indented
11875 . ==== as otherwise they are too far to the left.
11876 .code
11877   helo_lookup_domains = @ : @[]
11878 .endd
11879 which causes a lookup if a remote host (incorrectly) gives the server's name or
11880 IP address in an EHLO or HELO command.
11881 .endlist
11882
11883
11884 .vitem &$sender_host_port$&
11885 .vindex "&$sender_host_port$&"
11886 When a message is received from a remote host, this variable contains the port
11887 number that was used on the remote host.
11888
11889 .vitem &$sender_ident$&
11890 .vindex "&$sender_ident$&"
11891 When a message is received from a remote host, this variable contains the
11892 identification received in response to an RFC 1413 request. When a message has
11893 been received locally, this variable contains the login name of the user that
11894 called Exim.
11895
11896 .vitem &$sender_rate_$&&'xxx'&
11897 A number of variables whose names begin &$sender_rate_$& are set as part of the
11898 &%ratelimit%& ACL condition. Details are given in section
11899 &<<SECTratelimiting>>&.
11900
11901 .vitem &$sender_rcvhost$&
11902 .cindex "DNS" "reverse lookup"
11903 .cindex "reverse DNS lookup"
11904 .vindex "&$sender_rcvhost$&"
11905 This is provided specifically for use in &'Received:'& headers. It starts with
11906 either the verified host name (as obtained from a reverse DNS lookup) or, if
11907 there is no verified host name, the IP address in square brackets. After that
11908 there may be text in parentheses. When the first item is a verified host name,
11909 the first thing in the parentheses is the IP address in square brackets,
11910 followed by a colon and a port number if port logging is enabled. When the
11911 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11912 the parentheses.
11913
11914 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11915 was used and its argument was not identical to the real host name or IP
11916 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11917 all three items are present in the parentheses, a newline and tab are inserted
11918 into the string, to improve the formatting of the &'Received:'& header.
11919
11920 .vitem &$sender_verify_failure$&
11921 .vindex "&$sender_verify_failure$&"
11922 In an ACL, when a sender verification fails, this variable contains information
11923 about the failure. The details are the same as for
11924 &$recipient_verify_failure$&.
11925
11926 .vitem &$sending_ip_address$&
11927 .vindex "&$sending_ip_address$&"
11928 This variable is set whenever an outgoing SMTP connection to another host has
11929 been set up. It contains the IP address of the local interface that is being
11930 used. This is useful if a host that has more than one IP address wants to take
11931 on different personalities depending on which one is being used. For incoming
11932 connections, see &$received_ip_address$&.
11933
11934 .vitem &$sending_port$&
11935 .vindex "&$sending_port$&"
11936 This variable is set whenever an outgoing SMTP connection to another host has
11937 been set up. It contains the local port that is being used. For incoming
11938 connections, see &$received_port$&.
11939
11940 .vitem &$smtp_active_hostname$&
11941 .vindex "&$smtp_active_hostname$&"
11942 During an incoming SMTP session, this variable contains the value of the active
11943 host name, as specified by the &%smtp_active_hostname%& option. The value of
11944 &$smtp_active_hostname$& is saved with any message that is received, so its
11945 value can be consulted during routing and delivery.
11946
11947 .vitem &$smtp_command$&
11948 .vindex "&$smtp_command$&"
11949 During the processing of an incoming SMTP command, this variable contains the
11950 entire command. This makes it possible to distinguish between HELO and EHLO in
11951 the HELO ACL, and also to distinguish between commands such as these:
11952 .code
11953 MAIL FROM:<>
11954 MAIL FROM: <>
11955 .endd
11956 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11957 command, the address in &$smtp_command$& is the original address before any
11958 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11959 the address after SMTP-time rewriting.
11960
11961 .vitem &$smtp_command_argument$&
11962 .cindex "SMTP" "command, argument for"
11963 .vindex "&$smtp_command_argument$&"
11964 While an ACL is running to check an SMTP command, this variable contains the
11965 argument, that is, the text that follows the command name, with leading white
11966 space removed. Following the introduction of &$smtp_command$&, this variable is
11967 somewhat redundant, but is retained for backwards compatibility.
11968
11969 .vitem &$smtp_count_at_connection_start$&
11970 .vindex "&$smtp_count_at_connection_start$&"
11971 This variable is set greater than zero only in processes spawned by the Exim
11972 daemon for handling incoming SMTP connections. The name is deliberately long,
11973 in order to emphasize what the contents are. When the daemon accepts a new
11974 connection, it increments this variable. A copy of the variable is passed to
11975 the child process that handles the connection, but its value is fixed, and
11976 never changes. It is only an approximation of how many incoming connections
11977 there actually are, because many other connections may come and go while a
11978 single connection is being processed. When a child process terminates, the
11979 daemon decrements its copy of the variable.
11980
11981 .vitem "&$sn0$& &-- &$sn9$&"
11982 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11983 that were current at the end of the system filter file. This allows a system
11984 filter file to set values that can be tested in users' filter files. For
11985 example, a system filter could set a value indicating how likely it is that a
11986 message is junk mail.
11987
11988 .vitem &$spam_$&&'xxx'&
11989 A number of variables whose names start with &$spam$& are available when Exim
11990 is compiled with the content-scanning extension. For details, see section
11991 &<<SECTscanspamass>>&.
11992
11993
11994 .vitem &$spool_directory$&
11995 .vindex "&$spool_directory$&"
11996 The name of Exim's spool directory.
11997
11998 .vitem &$spool_inodes$&
11999 .vindex "&$spool_inodes$&"
12000 The number of free inodes in the disk partition where Exim's spool files are
12001 being written. The value is recalculated whenever the variable is referenced.
12002 If the relevant file system does not have the concept of inodes, the value of
12003 is -1. See also the &%check_spool_inodes%& option.
12004
12005 .vitem &$spool_space$&
12006 .vindex "&$spool_space$&"
12007 The amount of free space (as a number of kilobytes) in the disk partition where
12008 Exim's spool files are being written. The value is recalculated whenever the
12009 variable is referenced. If the operating system does not have the ability to
12010 find the amount of free space (only true for experimental systems), the space
12011 value is -1. For example, to check in an ACL that there is at least 50
12012 megabytes free on the spool, you could write:
12013 .code
12014 condition = ${if > {$spool_space}{50000}}
12015 .endd
12016 See also the &%check_spool_space%& option.
12017
12018
12019 .vitem &$thisaddress$&
12020 .vindex "&$thisaddress$&"
12021 This variable is set only during the processing of the &%foranyaddress%&
12022 command in a filter file. Its use is explained in the description of that
12023 command, which can be found in the separate document entitled &'Exim's
12024 interfaces to mail filtering'&.
12025
12026 .vitem &$tls_in_bits$&
12027 .vindex "&$tls_in_bits$&"
12028 Contains an approximation of the TLS cipher's bit-strength
12029 on the inbound connection; the meaning of
12030 this depends upon the TLS implementation used.
12031 If TLS has not been negotiated, the value will be 0.
12032 The value of this is automatically fed into the Cyrus SASL authenticator
12033 when acting as a server, to specify the "external SSF" (a SASL term).
12034
12035 The deprecated &$tls_bits$& variable refers to the inbound side
12036 except when used in the context of an outbound SMTP delivery, when it refers to
12037 the outbound.
12038
12039 .vitem &$tls_out_bits$&
12040 .vindex "&$tls_out_bits$&"
12041 Contains an approximation of the TLS cipher's bit-strength
12042 on an outbound SMTP connection; the meaning of
12043 this depends upon the TLS implementation used.
12044 If TLS has not been negotiated, the value will be 0.
12045
12046 .vitem &$tls_in_certificate_verified$&
12047 .vindex "&$tls_in_certificate_verified$&"
12048 This variable is set to &"1"& if a TLS certificate was verified when the
12049 message was received, and &"0"& otherwise.
12050
12051 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12052 except when used in the context of an outbound SMTP delivery, when it refers to
12053 the outbound.
12054
12055 .vitem &$tls_out_certificate_verified$&
12056 .vindex "&$tls_out_certificate_verified$&"
12057 This variable is set to &"1"& if a TLS certificate was verified when an
12058 outbound SMTP connection was made,
12059 and &"0"& otherwise.
12060
12061 .vitem &$tls_in_cipher$&
12062 .vindex "&$tls_in_cipher$&"
12063 .vindex "&$tls_cipher$&"
12064 When a message is received from a remote host over an encrypted SMTP
12065 connection, this variable is set to the cipher suite that was negotiated, for
12066 example DES-CBC3-SHA. In other circumstances, in particular, for message
12067 received over unencrypted connections, the variable is empty. Testing
12068 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12069 non-encrypted connections during ACL processing.
12070
12071 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12072 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12073 becomes the same as &$tls_out_cipher$&.
12074
12075 .vitem &$tls_out_cipher$&
12076 .vindex "&$tls_out_cipher$&"
12077 This variable is
12078 cleared before any outgoing SMTP connection is made,
12079 and then set to the outgoing cipher suite if one is negotiated. See chapter
12080 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12081 details of the &(smtp)& transport.
12082
12083 .vitem &$tls_in_peerdn$&
12084 .vindex "&$tls_in_peerdn$&"
12085 .vindex "&$tls_peerdn$&"
12086 When a message is received from a remote host over an encrypted SMTP
12087 connection, and Exim is configured to request a certificate from the client,
12088 the value of the Distinguished Name of the certificate is made available in the
12089 &$tls_in_peerdn$& during subsequent processing.
12090
12091 The deprecated &$tls_peerdn$& variable refers to the inbound side
12092 except when used in the context of an outbound SMTP delivery, when it refers to
12093 the outbound.
12094
12095 .vitem &$tls_out_peerdn$&
12096 .vindex "&$tls_out_peerdn$&"
12097 When a message is being delivered to a remote host over an encrypted SMTP
12098 connection, and Exim is configured to request a certificate from the server,
12099 the value of the Distinguished Name of the certificate is made available in the
12100 &$tls_out_peerdn$& during subsequent processing.
12101
12102 .vitem &$tls_in_sni$&
12103 .vindex "&$tls_in_sni$&"
12104 .vindex "&$tls_sni$&"
12105 .cindex "TLS" "Server Name Indication"
12106 When a TLS session is being established, if the client sends the Server
12107 Name Indication extension, the value will be placed in this variable.
12108 If the variable appears in &%tls_certificate%& then this option and
12109 some others, described in &<<SECTtlssni>>&,
12110 will be re-expanded early in the TLS session, to permit
12111 a different certificate to be presented (and optionally a different key to be
12112 used) to the client, based upon the value of the SNI extension.
12113
12114 The deprecated &$tls_sni$& variable refers to the inbound side
12115 except when used in the context of an outbound SMTP delivery, when it refers to
12116 the outbound.
12117
12118 .vitem &$tls_out_sni$&
12119 .vindex "&$tls_out_sni$&"
12120 .cindex "TLS" "Server Name Indication"
12121 During outbound
12122 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12123 the transport.
12124
12125 .vitem &$tod_bsdinbox$&
12126 .vindex "&$tod_bsdinbox$&"
12127 The time of day and the date, in the format required for BSD-style mailbox
12128 files, for example: Thu Oct 17 17:14:09 1995.
12129
12130 .vitem &$tod_epoch$&
12131 .vindex "&$tod_epoch$&"
12132 The time and date as a number of seconds since the start of the Unix epoch.
12133
12134 .vitem &$tod_epoch_l$&
12135 .vindex "&$tod_epoch_l$&"
12136 The time and date as a number of microseconds since the start of the Unix epoch.
12137
12138 .vitem &$tod_full$&
12139 .vindex "&$tod_full$&"
12140 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12141 +0100. The timezone is always given as a numerical offset from UTC, with
12142 positive values used for timezones that are ahead (east) of UTC, and negative
12143 values for those that are behind (west).
12144
12145 .vitem &$tod_log$&
12146 .vindex "&$tod_log$&"
12147 The time and date in the format used for writing Exim's log files, for example:
12148 1995-10-12 15:32:29, but without a timezone.
12149
12150 .vitem &$tod_logfile$&
12151 .vindex "&$tod_logfile$&"
12152 This variable contains the date in the format yyyymmdd. This is the format that
12153 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12154 flag.
12155
12156 .vitem &$tod_zone$&
12157 .vindex "&$tod_zone$&"
12158 This variable contains the numerical value of the local timezone, for example:
12159 -0500.
12160
12161 .vitem &$tod_zulu$&
12162 .vindex "&$tod_zulu$&"
12163 This variable contains the UTC date and time in &"Zulu"& format, as specified
12164 by ISO 8601, for example: 20030221154023Z.
12165
12166 .vitem &$value$&
12167 .vindex "&$value$&"
12168 This variable contains the result of an expansion lookup, extraction operation,
12169 or external command, as described above. It is also used during a
12170 &*reduce*& expansion.
12171
12172 .vitem &$version_number$&
12173 .vindex "&$version_number$&"
12174 The version number of Exim.
12175
12176 .vitem &$warn_message_delay$&
12177 .vindex "&$warn_message_delay$&"
12178 This variable is set only during the creation of a message warning about a
12179 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12180
12181 .vitem &$warn_message_recipients$&
12182 .vindex "&$warn_message_recipients$&"
12183 This variable is set only during the creation of a message warning about a
12184 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12185 .endlist
12186 .ecindex IIDstrexp
12187
12188
12189
12190 . ////////////////////////////////////////////////////////////////////////////
12191 . ////////////////////////////////////////////////////////////////////////////
12192
12193 .chapter "Embedded Perl" "CHAPperl"
12194 .scindex IIDperl "Perl" "calling from Exim"
12195 Exim can be built to include an embedded Perl interpreter. When this is done,
12196 Perl subroutines can be called as part of the string expansion process. To make
12197 use of the Perl support, you need version 5.004 or later of Perl installed on
12198 your system. To include the embedded interpreter in the Exim binary, include
12199 the line
12200 .code
12201 EXIM_PERL = perl.o
12202 .endd
12203 in your &_Local/Makefile_& and then build Exim in the normal way.
12204
12205
12206 .section "Setting up so Perl can be used" "SECID85"
12207 .oindex "&%perl_startup%&"
12208 Access to Perl subroutines is via a global configuration option called
12209 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12210 no &%perl_startup%& option in the Exim configuration file then no Perl
12211 interpreter is started and there is almost no overhead for Exim (since none of
12212 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12213 option then the associated value is taken to be Perl code which is executed in
12214 a newly created Perl interpreter.
12215
12216 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12217 need backslashes before any characters to escape special meanings. The option
12218 should usually be something like
12219 .code
12220 perl_startup = do '/etc/exim.pl'
12221 .endd
12222 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12223 use from Exim. Exim can be configured either to start up a Perl interpreter as
12224 soon as it is entered, or to wait until the first time it is needed. Starting
12225 the interpreter at the beginning ensures that it is done while Exim still has
12226 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12227 fact used in a particular run. Also, note that this does not mean that Exim is
12228 necessarily running as root when Perl is called at a later time. By default,
12229 the interpreter is started only when it is needed, but this can be changed in
12230 two ways:
12231
12232 .ilist
12233 .oindex "&%perl_at_start%&"
12234 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12235 a startup when Exim is entered.
12236 .next
12237 The command line option &%-ps%& also requests a startup when Exim is entered,
12238 overriding the setting of &%perl_at_start%&.
12239 .endlist
12240
12241 There is also a command line option &%-pd%& (for delay) which suppresses the
12242 initial startup, even if &%perl_at_start%& is set.
12243
12244
12245 .section "Calling Perl subroutines" "SECID86"
12246 When the configuration file includes a &%perl_startup%& option you can make use
12247 of the string expansion item to call the Perl subroutines that are defined
12248 by the &%perl_startup%& code. The operator is used in any of the following
12249 forms:
12250 .code
12251 ${perl{foo}}
12252 ${perl{foo}{argument}}
12253 ${perl{foo}{argument1}{argument2} ... }
12254 .endd
12255 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12256 arguments may be passed. Passing more than this results in an expansion failure
12257 with an error message of the form
12258 .code
12259 Too many arguments passed to Perl subroutine "foo" (max is 8)
12260 .endd
12261 The return value of the Perl subroutine is evaluated in a scalar context before
12262 it is passed back to Exim to be inserted into the expanded string. If the
12263 return value is &'undef'&, the expansion is forced to fail in the same way as
12264 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12265 by obeying Perl's &%die%& function, the expansion fails with the error message
12266 that was passed to &%die%&.
12267
12268
12269 .section "Calling Exim functions from Perl" "SECID87"
12270 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12271 is available to call back into Exim's string expansion function. For example,
12272 the Perl code
12273 .code
12274 my $lp = Exim::expand_string('$local_part');
12275 .endd
12276 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12277 Note those are single quotes and not double quotes to protect against
12278 &$local_part$& being interpolated as a Perl variable.
12279
12280 If the string expansion is forced to fail by a &"fail"& item, the result of
12281 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12282 expansion string, the Perl call from the original expansion string fails with
12283 an appropriate error message, in the same way as if &%die%& were used.
12284
12285 .cindex "debugging" "from embedded Perl"
12286 .cindex "log" "writing from embedded Perl"
12287 Two other Exim functions are available for use from within Perl code.
12288 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12289 debugging is enabled. If you want a newline at the end, you must supply it.
12290 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12291 timestamp. In this case, you should not supply a terminating newline.
12292
12293
12294 .section "Use of standard output and error by Perl" "SECID88"
12295 .cindex "Perl" "standard output and error"
12296 You should not write to the standard error or output streams from within your
12297 Perl code, as it is not defined how these are set up. In versions of Exim
12298 before 4.50, it is possible for the standard output or error to refer to the
12299 SMTP connection during message reception via the daemon. Writing to this stream
12300 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12301 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12302 avoided, but the output is lost.
12303
12304 .cindex "Perl" "use of &%warn%&"
12305 The Perl &%warn%& statement writes to the standard error stream by default.
12306 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12307 you have no control. When Exim starts up the Perl interpreter, it arranges for
12308 output from the &%warn%& statement to be written to the Exim main log. You can
12309 change this by including appropriate Perl magic somewhere in your Perl code.
12310 For example, to discard &%warn%& output completely, you need this:
12311 .code
12312 $SIG{__WARN__} = sub { };
12313 .endd
12314 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12315 example, the code for the subroutine is empty, so it does nothing, but you can
12316 include any Perl code that you like. The text of the &%warn%& message is passed
12317 as the first subroutine argument.
12318 .ecindex IIDperl
12319
12320
12321 . ////////////////////////////////////////////////////////////////////////////
12322 . ////////////////////////////////////////////////////////////////////////////
12323
12324 .chapter "Starting the daemon and the use of network interfaces" &&&
12325          "CHAPinterfaces" &&&
12326          "Starting the daemon"
12327 .cindex "daemon" "starting"
12328 .cindex "interface" "listening"
12329 .cindex "network interface"
12330 .cindex "interface" "network"
12331 .cindex "IP address" "for listening"
12332 .cindex "daemon" "listening IP addresses"
12333 .cindex "TCP/IP" "setting listening interfaces"
12334 .cindex "TCP/IP" "setting listening ports"
12335 A host that is connected to a TCP/IP network may have one or more physical
12336 hardware network interfaces. Each of these interfaces may be configured as one
12337 or more &"logical"& interfaces, which are the entities that a program actually
12338 works with. Each of these logical interfaces is associated with an IP address.
12339 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12340 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12341 knowledge about the host's interfaces for use in three different circumstances:
12342
12343 .olist
12344 When a listening daemon is started, Exim needs to know which interfaces
12345 and ports to listen on.
12346 .next
12347 When Exim is routing an address, it needs to know which IP addresses
12348 are associated with local interfaces. This is required for the correct
12349 processing of MX lists by removing the local host and others with the
12350 same or higher priority values. Also, Exim needs to detect cases
12351 when an address is routed to an IP address that in fact belongs to the
12352 local host. Unless the &%self%& router option or the &%allow_localhost%&
12353 option of the smtp transport is set (as appropriate), this is treated
12354 as an error situation.
12355 .next
12356 When Exim connects to a remote host, it may need to know which interface to use
12357 for the outgoing connection.
12358 .endlist
12359
12360
12361 Exim's default behaviour is likely to be appropriate in the vast majority
12362 of cases. If your host has only one interface, and you want all its IP
12363 addresses to be treated in the same way, and you are using only the
12364 standard SMTP port, you should not need to take any special action. The
12365 rest of this chapter does not apply to you.
12366
12367 In a more complicated situation you may want to listen only on certain
12368 interfaces, or on different ports, and for this reason there are a number of
12369 options that can be used to influence Exim's behaviour. The rest of this
12370 chapter describes how they operate.
12371
12372 When a message is received over TCP/IP, the interface and port that were
12373 actually used are set in &$received_ip_address$& and &$received_port$&.
12374
12375
12376
12377 .section "Starting a listening daemon" "SECID89"
12378 When a listening daemon is started (by means of the &%-bd%& command line
12379 option), the interfaces and ports on which it listens are controlled by the
12380 following options:
12381
12382 .ilist
12383 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12384 compatibility, this option can also be specified in the singular.)
12385 .next
12386 &%local_interfaces%& contains list of interface IP addresses on which to
12387 listen. Each item may optionally also specify a port.
12388 .endlist
12389
12390 The default list separator in both cases is a colon, but this can be changed as
12391 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12392 it is usually best to change the separator to avoid having to double all the
12393 colons. For example:
12394 .code
12395 local_interfaces = <; 127.0.0.1 ; \
12396                       192.168.23.65 ; \
12397                       ::1 ; \
12398                       3ffe:ffff:836f::fe86:a061
12399 .endd
12400 There are two different formats for specifying a port along with an IP address
12401 in &%local_interfaces%&:
12402
12403 .olist
12404 The port is added onto the address with a dot separator. For example, to listen
12405 on port 1234 on two different IP addresses:
12406 .code
12407 local_interfaces = <; 192.168.23.65.1234 ; \
12408                       3ffe:ffff:836f::fe86:a061.1234
12409 .endd
12410 .next
12411 The IP address is enclosed in square brackets, and the port is added
12412 with a colon separator, for example:
12413 .code
12414 local_interfaces = <; [192.168.23.65]:1234 ; \
12415                       [3ffe:ffff:836f::fe86:a061]:1234
12416 .endd
12417 .endlist
12418
12419 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12420 default setting contains just one port:
12421 .code
12422 daemon_smtp_ports = smtp
12423 .endd
12424 If more than one port is listed, each interface that does not have its own port
12425 specified listens on all of them. Ports that are listed in
12426 &%daemon_smtp_ports%& can be identified either by name (defined in
12427 &_/etc/services_&) or by number. However, when ports are given with individual
12428 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12429
12430
12431
12432 .section "Special IP listening addresses" "SECID90"
12433 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12434 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12435 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12436 instead of setting up separate listening sockets for each interface. The
12437 default value of &%local_interfaces%& is
12438 .code
12439 local_interfaces = 0.0.0.0
12440 .endd
12441 when Exim is built without IPv6 support; otherwise it is:
12442 .code
12443 local_interfaces = <; ::0 ; 0.0.0.0
12444 .endd
12445 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12446
12447
12448
12449 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12450 The &%-oX%& command line option can be used to override the values of
12451 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12452 instance. Another way of doing this would be to use macros and the &%-D%&
12453 option. However, &%-oX%& can be used by any admin user, whereas modification of
12454 the runtime configuration by &%-D%& is allowed only when the caller is root or
12455 exim.
12456
12457 The value of &%-oX%& is a list of items. The default colon separator can be
12458 changed in the usual way if required. If there are any items that do not
12459 contain dots or colons (that is, are not IP addresses), the value of
12460 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12461 items that do contain dots or colons, the value of &%local_interfaces%& is
12462 replaced by those items. Thus, for example,
12463 .code
12464 -oX 1225
12465 .endd
12466 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12467 whereas
12468 .code
12469 -oX 192.168.34.5.1125
12470 .endd
12471 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12472 (However, since &%local_interfaces%& now contains no items without ports, the
12473 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12474
12475
12476
12477 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12478 .cindex "ssmtp protocol"
12479 .cindex "smtps protocol"
12480 .cindex "SMTP" "ssmtp protocol"
12481 .cindex "SMTP" "smtps protocol"
12482 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12483 before the STARTTLS command was standardized for SMTP. Some legacy clients
12484 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12485 list of port numbers, connections to those ports must use SSMTP. The most
12486 common use of this option is expected to be
12487 .code
12488 tls_on_connect_ports = 465
12489 .endd
12490 because 465 is the usual port number used by the legacy clients. There is also
12491 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12492 this way when a daemon is started.
12493
12494 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12495 daemon to listen on those ports. You must still specify them in
12496 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12497 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12498 connections via the daemon.)
12499
12500
12501
12502
12503 .section "IPv6 address scopes" "SECID92"
12504 .cindex "IPv6" "address scopes"
12505 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12506 can, in principle, have the same link-local IPv6 address on different
12507 interfaces. Thus, additional information is needed, over and above the IP
12508 address, to distinguish individual interfaces. A convention of using a
12509 percent sign followed by something (often the interface name) has been
12510 adopted in some cases, leading to addresses like this:
12511 .code
12512 fe80::202:b3ff:fe03:45c1%eth0
12513 .endd
12514 To accommodate this usage, a percent sign followed by an arbitrary string is
12515 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12516 to convert a textual IPv6 address for actual use. This function recognizes the
12517 percent convention in operating systems that support it, and it processes the
12518 address appropriately. Unfortunately, some older libraries have problems with
12519 &[getaddrinfo()]&. If
12520 .code
12521 IPV6_USE_INET_PTON=yes
12522 .endd
12523 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12524 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12525 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12526 function.) Of course, this means that the additional functionality of
12527 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12528
12529 .section "Disabling IPv6" "SECID93"
12530 .cindex "IPv6" "disabling"
12531 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12532 run on a host whose kernel does not support IPv6. The binary will fall back to
12533 using IPv4, but it may waste resources looking up AAAA records, and trying to
12534 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12535 .oindex "&%disable_ipv6%&"
12536 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12537 activities take place. AAAA records are never looked up, and any IPv6 addresses
12538 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12539 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12540 to handle IPv6 literal addresses.
12541
12542 On the other hand, when IPv6 is in use, there may be times when you want to
12543 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12544 option to globally suppress the lookup of AAAA records for specified domains,
12545 and you can use the &%ignore_target_hosts%& generic router option to ignore
12546 IPv6 addresses in an individual router.
12547
12548
12549
12550 .section "Examples of starting a listening daemon" "SECID94"
12551 The default case in an IPv6 environment is
12552 .code
12553 daemon_smtp_ports = smtp
12554 local_interfaces = <; ::0 ; 0.0.0.0
12555 .endd
12556 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12557 Either one or two sockets may be used, depending on the characteristics of
12558 the TCP/IP stack. (This is complicated and messy; for more information,
12559 read the comments in the &_daemon.c_& source file.)
12560
12561 To specify listening on ports 25 and 26 on all interfaces:
12562 .code
12563 daemon_smtp_ports = 25 : 26
12564 .endd
12565 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12566 .code
12567 local_interfaces = <; ::0.25     ; ::0.26 \
12568                       0.0.0.0.25 ; 0.0.0.0.26
12569 .endd
12570 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12571 IPv4 loopback address only:
12572 .code
12573 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12574 .endd
12575 To specify listening on the default port on specific interfaces only:
12576 .code
12577 local_interfaces = 10.0.0.67 : 192.168.34.67
12578 .endd
12579 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12580
12581
12582
12583 .section "Recognizing the local host" "SECTreclocipadd"
12584 The &%local_interfaces%& option is also used when Exim needs to determine
12585 whether or not an IP address refers to the local host. That is, the IP
12586 addresses of all the interfaces on which a daemon is listening are always
12587 treated as local.
12588
12589 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12590 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12591 available interfaces from the operating system, and extracts the relevant
12592 (that is, IPv4 or IPv6) addresses to use for checking.
12593
12594 Some systems set up large numbers of virtual interfaces in order to provide
12595 many virtual web servers. In this situation, you may want to listen for
12596 email on only a few of the available interfaces, but nevertheless treat all
12597 interfaces as local when routing. You can do this by setting
12598 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12599 &"all"& wildcard values. These addresses are recognized as local, but are not
12600 used for listening. Consider this example:
12601 .code
12602 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12603                       192.168.53.235 ; \
12604                       3ffe:2101:12:1:a00:20ff:fe86:a061
12605
12606 extra_local_interfaces = <; ::0 ; 0.0.0.0
12607 .endd
12608 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12609 address, but all available interface addresses are treated as local when
12610 Exim is routing.
12611
12612 In some environments the local host name may be in an MX list, but with an IP
12613 address that is not assigned to any local interface. In other cases it may be
12614 desirable to treat other host names as if they referred to the local host. Both
12615 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12616 This contains host names rather than IP addresses. When a host is referenced
12617 during routing, either via an MX record or directly, it is treated as the local
12618 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12619 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12620
12621
12622
12623 .section "Delivering to a remote host" "SECID95"
12624 Delivery to a remote host is handled by the smtp transport. By default, it
12625 allows the system's TCP/IP functions to choose which interface to use (if
12626 there is more than one) when connecting to a remote host. However, the
12627 &%interface%& option can be set to specify which interface is used. See the
12628 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12629 details.
12630
12631
12632
12633
12634 . ////////////////////////////////////////////////////////////////////////////
12635 . ////////////////////////////////////////////////////////////////////////////
12636
12637 .chapter "Main configuration" "CHAPmainconfig"
12638 .scindex IIDconfima "configuration file" "main section"
12639 .scindex IIDmaiconf "main configuration"
12640 The first part of the run time configuration file contains three types of item:
12641
12642 .ilist
12643 Macro definitions: These lines start with an upper case letter. See section
12644 &<<SECTmacrodefs>>& for details of macro processing.
12645 .next
12646 Named list definitions: These lines start with one of the words &"domainlist"&,
12647 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12648 section &<<SECTnamedlists>>&.
12649 .next
12650 Main configuration settings: Each setting occupies one line of the file
12651 (with possible continuations). If any setting is preceded by the word
12652 &"hide"&, the &%-bP%& command line option displays its value to admin users
12653 only. See section &<<SECTcos>>& for a description of the syntax of these option
12654 settings.
12655 .endlist
12656
12657 This chapter specifies all the main configuration options, along with their
12658 types and default values. For ease of finding a particular option, they appear
12659 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12660 are now so many options, they are first listed briefly in functional groups, as
12661 an aid to finding the name of the option you are looking for. Some options are
12662 listed in more than one group.
12663
12664 .section "Miscellaneous" "SECID96"
12665 .table2
12666 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12667 .row &%disable_ipv6%&                "do no IPv6 processing"
12668 .row &%keep_malformed%&              "for broken files &-- should not happen"
12669 .row &%localhost_number%&            "for unique message ids in clusters"
12670 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12671 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12672 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12673 .row &%print_topbitchars%&           "top-bit characters are printing"
12674 .row &%timezone%&                    "force time zone"
12675 .endtable
12676
12677
12678 .section "Exim parameters" "SECID97"
12679 .table2
12680 .row &%exim_group%&                  "override compiled-in value"
12681 .row &%exim_path%&                   "override compiled-in value"
12682 .row &%exim_user%&                   "override compiled-in value"
12683 .row &%primary_hostname%&            "default from &[uname()]&"
12684 .row &%split_spool_directory%&       "use multiple directories"
12685 .row &%spool_directory%&             "override compiled-in value"
12686 .endtable
12687
12688
12689
12690 .section "Privilege controls" "SECID98"
12691 .table2
12692 .row &%admin_groups%&                "groups that are Exim admin users"
12693 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12694 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12695 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12696 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12697 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12698 .row &%never_users%&                 "do not run deliveries as these"
12699 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12700 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12701 .row &%trusted_groups%&              "groups that are trusted"
12702 .row &%trusted_users%&               "users that are trusted"
12703 .endtable
12704
12705
12706
12707 .section "Logging" "SECID99"
12708 .table2
12709 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12710 .row &%log_file_path%&               "override compiled-in value"
12711 .row &%log_selector%&                "set/unset optional logging"
12712 .row &%log_timezone%&                "add timezone to log lines"
12713 .row &%message_logs%&                "create per-message logs"
12714 .row &%preserve_message_logs%&       "after message completion"
12715 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12716 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12717 .row &%syslog_facility%&             "set syslog &""facility""& field"
12718 .row &%syslog_processname%&          "set syslog &""ident""& field"
12719 .row &%syslog_timestamp%&            "timestamp syslog lines"
12720 .row &%write_rejectlog%&             "control use of message log"
12721 .endtable
12722
12723
12724
12725 .section "Frozen messages" "SECID100"
12726 .table2
12727 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12728 .row &%freeze_tell%&                 "send message when freezing"
12729 .row &%move_frozen_messages%&        "to another directory"
12730 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12731 .endtable
12732
12733
12734
12735 .section "Data lookups" "SECID101"
12736 .table2
12737 .row &%ibase_servers%&               "InterBase servers"
12738 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12739 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12740 .row &%ldap_cert_file%&              "client cert file for LDAP"
12741 .row &%ldap_cert_key%&               "client key file for LDAP"
12742 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12743 .row &%ldap_default_servers%&        "used if no server in query"
12744 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12745 .row &%ldap_start_tls%&              "require TLS within LDAP"
12746 .row &%ldap_version%&                "set protocol version"
12747 .row &%lookup_open_max%&             "lookup files held open"
12748 .row &%mysql_servers%&               "default MySQL servers"
12749 .row &%oracle_servers%&              "Oracle servers"
12750 .row &%pgsql_servers%&               "default PostgreSQL servers"
12751 .row &%sqlite_lock_timeout%&         "as it says"
12752 .endtable
12753
12754
12755
12756 .section "Message ids" "SECID102"
12757 .table2
12758 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12759 .row &%message_id_header_text%&      "ditto"
12760 .endtable
12761
12762
12763
12764 .section "Embedded Perl Startup" "SECID103"
12765 .table2
12766 .row &%perl_at_start%&               "always start the interpreter"
12767 .row &%perl_startup%&                "code to obey when starting Perl"
12768 .endtable
12769
12770
12771
12772 .section "Daemon" "SECID104"
12773 .table2
12774 .row &%daemon_smtp_ports%&           "default ports"
12775 .row &%daemon_startup_retries%&      "number of times to retry"
12776 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12777 .row &%extra_local_interfaces%&      "not necessarily listened on"
12778 .row &%local_interfaces%&            "on which to listen, with optional ports"
12779 .row &%pid_file_path%&               "override compiled-in value"
12780 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12781 .endtable
12782
12783
12784
12785 .section "Resource control" "SECID105"
12786 .table2
12787 .row &%check_log_inodes%&            "before accepting a message"
12788 .row &%check_log_space%&             "before accepting a message"
12789 .row &%check_spool_inodes%&          "before accepting a message"
12790 .row &%check_spool_space%&           "before accepting a message"
12791 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12792 .row &%queue_only_load%&             "queue incoming if load high"
12793 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12794 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12795 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12796 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12797 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12798 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12799 .row &%smtp_accept_max_per_connection%& "messages per connection"
12800 .row &%smtp_accept_max_per_host%&    "connections from one host"
12801 .row &%smtp_accept_queue%&           "queue mail if more connections"
12802 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12803                                            connection"
12804 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12805 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12806 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12807 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12808 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12809 .endtable
12810
12811
12812
12813 .section "Policy controls" "SECID106"
12814 .table2
12815 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12816 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12817 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12818 .row &%acl_smtp_auth%&               "ACL for AUTH"
12819 .row &%acl_smtp_connect%&            "ACL for connection"
12820 .row &%acl_smtp_data%&               "ACL for DATA"
12821 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12822 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12823 .row &%acl_smtp_expn%&               "ACL for EXPN"
12824 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12825 .row &%acl_smtp_mail%&               "ACL for MAIL"
12826 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12827 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12828 .row &%acl_smtp_predata%&            "ACL for start of data"
12829 .row &%acl_smtp_quit%&               "ACL for QUIT"
12830 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12831 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12832 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12833 .row &%av_scanner%&                  "specify virus scanner"
12834 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12835                                       words""&"
12836 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12837 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12838 .row &%header_maxsize%&              "total size of message header"
12839 .row &%header_line_maxsize%&         "individual header line limit"
12840 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12841 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12842 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12843 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12844 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12845 .row &%host_lookup%&                 "host name looked up for these hosts"
12846 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12847 .row &%host_reject_connection%&      "reject connection from these hosts"
12848 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12849 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12850 .row &%message_size_limit%&          "for all messages"
12851 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12852 .row &%spamd_address%&               "set interface to SpamAssassin"
12853 .row &%strict_acl_vars%&             "object to unset ACL variables"
12854 .endtable
12855
12856
12857
12858 .section "Callout cache" "SECID107"
12859 .table2
12860 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12861                                          item"
12862 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12863                                          item"
12864 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12865 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12866 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12867 .endtable
12868
12869
12870
12871 .section "TLS" "SECID108"
12872 .table2
12873 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12874 .new
12875 .row &%gnutls_enable_pkcs11%&        "allow GnuTLS to autoload PKCS11 modules"
12876 .wen
12877 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12878 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12879 .row &%tls_certificate%&             "location of server certificate"
12880 .row &%tls_crl%&                     "certificate revocation list"
12881 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
12882 .row &%tls_dhparam%&                 "DH parameters for server"
12883 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12884 .row &%tls_privatekey%&              "location of server private key"
12885 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12886 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12887 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12888 .row &%tls_verify_certificates%&     "expected client certificates"
12889 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12890 .endtable
12891
12892
12893
12894 .section "Local user handling" "SECID109"
12895 .table2
12896 .row &%finduser_retries%&            "useful in NIS environments"
12897 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12898 .row &%gecos_pattern%&               "ditto"
12899 .row &%max_username_length%&         "for systems that truncate"
12900 .row &%unknown_login%&               "used when no login name found"
12901 .row &%unknown_username%&            "ditto"
12902 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12903 .row &%uucp_from_sender%&            "ditto"
12904 .endtable
12905
12906
12907
12908 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12909 .table2
12910 .row &%header_maxsize%&              "total size of message header"
12911 .row &%header_line_maxsize%&         "individual header line limit"
12912 .row &%message_size_limit%&          "applies to all messages"
12913 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12914 .row &%received_header_text%&        "expanded to make &'Received:'&"
12915 .row &%received_headers_max%&        "for mail loop detection"
12916 .row &%recipients_max%&              "limit per message"
12917 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12918 .endtable
12919
12920
12921
12922
12923 .section "Non-SMTP incoming messages" "SECID111"
12924 .table2
12925 .row &%receive_timeout%&             "for non-SMTP messages"
12926 .endtable
12927
12928
12929
12930
12931
12932 .section "Incoming SMTP messages" "SECID112"
12933 See also the &'Policy controls'& section above.
12934
12935 .table2
12936 .row &%host_lookup%&                 "host name looked up for these hosts"
12937 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12938 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12939 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12940 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12941 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12942 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12943 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12944 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12945 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12946 .row &%smtp_accept_max_per_connection%& "messages per connection"
12947 .row &%smtp_accept_max_per_host%&    "connections from one host"
12948 .row &%smtp_accept_queue%&           "queue mail if more connections"
12949 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12950                                            connection"
12951 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12952 .row &%smtp_active_hostname%&        "host name to use in messages"
12953 .row &%smtp_banner%&                 "text for welcome banner"
12954 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12955 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12956 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12957 .row &%smtp_etrn_command%&           "what to run for ETRN"
12958 .row &%smtp_etrn_serialize%&         "only one at once"
12959 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12960 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12961 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12962 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12963 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12964 .row &%smtp_receive_timeout%&        "per command or data line"
12965 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12966 .row &%smtp_return_error_details%&   "give detail on rejections"
12967 .endtable
12968
12969
12970
12971 .section "SMTP extensions" "SECID113"
12972 .table2
12973 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12974 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12975 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12976 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12977 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12978 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12979 .endtable
12980
12981
12982
12983 .section "Processing messages" "SECID114"
12984 .table2
12985 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12986 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12987 .row &%allow_utf8_domains%&          "in addresses"
12988 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12989                                       words""&"
12990 .row &%delivery_date_remove%&        "from incoming messages"
12991 .row &%envelope_to_remove%&          "from incoming messages"
12992 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12993 .row &%headers_charset%&             "default for translations"
12994 .row &%qualify_domain%&              "default for senders"
12995 .row &%qualify_recipient%&           "default for recipients"
12996 .row &%return_path_remove%&          "from incoming messages"
12997 .row &%strip_excess_angle_brackets%& "in addresses"
12998 .row &%strip_trailing_dot%&          "at end of addresses"
12999 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13000 .endtable
13001
13002
13003
13004 .section "System filter" "SECID115"
13005 .table2
13006 .row &%system_filter%&               "locate system filter"
13007 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13008                                             directory"
13009 .row &%system_filter_file_transport%& "transport for delivery to a file"
13010 .row &%system_filter_group%&         "group for filter running"
13011 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13012 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13013 .row &%system_filter_user%&          "user for filter running"
13014 .endtable
13015
13016
13017
13018 .section "Routing and delivery" "SECID116"
13019 .table2
13020 .row &%disable_ipv6%&                "do no IPv6 processing"
13021 .row &%dns_again_means_nonexist%&    "for broken domains"
13022 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13023 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13024 .row &%dns_retrans%&                 "parameter for resolver"
13025 .row &%dns_retry%&                   "parameter for resolver"
13026 .new
13027 .row &%dns_use_dnssec%&              "parameter for resolver"
13028 .wen
13029 .row &%dns_use_edns0%&               "parameter for resolver"
13030 .row &%hold_domains%&                "hold delivery for these domains"
13031 .row &%local_interfaces%&            "for routing checks"
13032 .row &%queue_domains%&               "no immediate delivery for these"
13033 .row &%queue_only%&                  "no immediate delivery at all"
13034 .row &%queue_only_file%&             "no immediate delivery if file exists"
13035 .row &%queue_only_load%&             "no immediate delivery if load is high"
13036 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13037 .row &%queue_only_override%&         "allow command line to override"
13038 .row &%queue_run_in_order%&          "order of arrival"
13039 .row &%queue_run_max%&               "of simultaneous queue runners"
13040 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13041 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13042 .row &%remote_sort_domains%&         "order of remote deliveries"
13043 .row &%retry_data_expire%&           "timeout for retry data"
13044 .row &%retry_interval_max%&          "safety net for retry rules"
13045 .endtable
13046
13047
13048
13049 .section "Bounce and warning messages" "SECID117"
13050 .table2
13051 .row &%bounce_message_file%&         "content of bounce"
13052 .row &%bounce_message_text%&         "content of bounce"
13053 .row &%bounce_return_body%&          "include body if returning message"
13054 .row &%bounce_return_message%&       "include original message in bounce"
13055 .row &%bounce_return_size_limit%&    "limit on returned message"
13056 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13057 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13058 .row &%errors_copy%&                 "copy bounce messages"
13059 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13060 .row &%delay_warning%&               "time schedule"
13061 .row &%delay_warning_condition%&     "condition for warning messages"
13062 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13063 .row &%smtp_return_error_details%&   "give detail on rejections"
13064 .row &%warn_message_file%&           "content of warning message"
13065 .endtable
13066
13067
13068
13069 .section "Alphabetical list of main options" "SECTalomo"
13070 Those options that undergo string expansion before use are marked with
13071 &dagger;.
13072
13073 .option accept_8bitmime main boolean true
13074 .cindex "8BITMIME"
13075 .cindex "8-bit characters"
13076 This option causes Exim to send 8BITMIME in its response to an SMTP
13077 EHLO command, and to accept the BODY= parameter on MAIL commands.
13078 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13079 takes no steps to do anything special with messages received by this route.
13080
13081 Historically Exim kept this option off by default, but the maintainers
13082 feel that in today's Internet, this causes more problems than it solves.
13083 It now defaults to true.
13084 A more detailed analysis of the issues is provided by Dan Bernstein:
13085 .display
13086 &url(http://cr.yp.to/smtp/8bitmime.html)
13087 .endd
13088
13089 .option acl_not_smtp main string&!! unset
13090 .cindex "&ACL;" "for non-SMTP messages"
13091 .cindex "non-SMTP messages" "ACLs for"
13092 This option defines the ACL that is run when a non-SMTP message has been
13093 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13094 further details.
13095
13096 .option acl_not_smtp_mime main string&!! unset
13097 This option defines the ACL that is run for individual MIME parts of non-SMTP
13098 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13099 SMTP messages.
13100
13101 .option acl_not_smtp_start main string&!! unset
13102 .cindex "&ACL;" "at start of non-SMTP message"
13103 .cindex "non-SMTP messages" "ACLs for"
13104 This option defines the ACL that is run before Exim starts reading a
13105 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13106
13107 .option acl_smtp_auth main string&!! unset
13108 .cindex "&ACL;" "setting up for SMTP commands"
13109 .cindex "AUTH" "ACL for"
13110 This option defines the ACL that is run when an SMTP AUTH command is
13111 received. See chapter &<<CHAPACL>>& for further details.
13112
13113 .option acl_smtp_connect main string&!! unset
13114 .cindex "&ACL;" "on SMTP connection"
13115 This option defines the ACL that is run when an SMTP connection is received.
13116 See chapter &<<CHAPACL>>& for further details.
13117
13118 .option acl_smtp_data main string&!! unset
13119 .cindex "DATA" "ACL for"
13120 This option defines the ACL that is run after an SMTP DATA command has been
13121 processed and the message itself has been received, but before the final
13122 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13123
13124 .option acl_smtp_etrn main string&!! unset
13125 .cindex "ETRN" "ACL for"
13126 This option defines the ACL that is run when an SMTP ETRN command is
13127 received. See chapter &<<CHAPACL>>& for further details.
13128
13129 .option acl_smtp_expn main string&!! unset
13130 .cindex "EXPN" "ACL for"
13131 This option defines the ACL that is run when an SMTP EXPN command is
13132 received. See chapter &<<CHAPACL>>& for further details.
13133
13134 .option acl_smtp_helo main string&!! unset
13135 .cindex "EHLO" "ACL for"
13136 .cindex "HELO" "ACL for"
13137 This option defines the ACL that is run when an SMTP EHLO or HELO
13138 command is received. See chapter &<<CHAPACL>>& for further details.
13139
13140
13141 .option acl_smtp_mail main string&!! unset
13142 .cindex "MAIL" "ACL for"
13143 This option defines the ACL that is run when an SMTP MAIL command is
13144 received. See chapter &<<CHAPACL>>& for further details.
13145
13146 .option acl_smtp_mailauth main string&!! unset
13147 .cindex "AUTH" "on MAIL command"
13148 This option defines the ACL that is run when there is an AUTH parameter on
13149 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13150 &<<CHAPSMTPAUTH>>& for details of authentication.
13151
13152 .option acl_smtp_mime main string&!! unset
13153 .cindex "MIME content scanning" "ACL for"
13154 This option is available when Exim is built with the content-scanning
13155 extension. It defines the ACL that is run for each MIME part in a message. See
13156 section &<<SECTscanmimepart>>& for details.
13157
13158 .option acl_smtp_predata main string&!! unset
13159 This option defines the ACL that is run when an SMTP DATA command is
13160 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13161 further details.
13162
13163 .option acl_smtp_quit main string&!! unset
13164 .cindex "QUIT, ACL for"
13165 This option defines the ACL that is run when an SMTP QUIT command is
13166 received. See chapter &<<CHAPACL>>& for further details.
13167
13168 .option acl_smtp_rcpt main string&!! unset
13169 .cindex "RCPT" "ACL for"
13170 This option defines the ACL that is run when an SMTP RCPT command is
13171 received. See chapter &<<CHAPACL>>& for further details.
13172
13173 .option acl_smtp_starttls main string&!! unset
13174 .cindex "STARTTLS, ACL for"
13175 This option defines the ACL that is run when an SMTP STARTTLS command is
13176 received. See chapter &<<CHAPACL>>& for further details.
13177
13178 .option acl_smtp_vrfy main string&!! unset
13179 .cindex "VRFY" "ACL for"
13180 This option defines the ACL that is run when an SMTP VRFY command is
13181 received. See chapter &<<CHAPACL>>& for further details.
13182
13183 .option admin_groups main "string list&!!" unset
13184 .cindex "admin user"
13185 This option is expanded just once, at the start of Exim's processing. If the
13186 current group or any of the supplementary groups of an Exim caller is in this
13187 colon-separated list, the caller has admin privileges. If all your system
13188 programmers are in a specific group, for example, you can give them all Exim
13189 admin privileges by putting that group in &%admin_groups%&. However, this does
13190 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13191 To permit this, you have to add individuals to the Exim group.
13192
13193 .option allow_domain_literals main boolean false
13194 .cindex "domain literal"
13195 If this option is set, the RFC 2822 domain literal format is permitted in
13196 email addresses. The option is not set by default, because the domain literal
13197 format is not normally required these days, and few people know about it. It
13198 has, however, been exploited by mail abusers.
13199
13200 Unfortunately, it seems that some DNS black list maintainers are using this
13201 format to report black listing to postmasters. If you want to accept messages
13202 addressed to your hosts by IP address, you need to set
13203 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13204 domains (defined in the named domain list &%local_domains%& in the default
13205 configuration). This &"magic string"& matches the domain literal form of all
13206 the local host's IP addresses.
13207
13208
13209 .option allow_mx_to_ip main boolean false
13210 .cindex "MX record" "pointing to IP address"
13211 It appears that more and more DNS zone administrators are breaking the rules
13212 and putting domain names that look like IP addresses on the right hand side of
13213 MX records. Exim follows the rules and rejects this, giving an error message
13214 that explains the mis-configuration. However, some other MTAs support this
13215 practice, so to avoid &"Why can't Exim do this?"& complaints,
13216 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13217 recommended, except when you have no other choice.
13218
13219 .option allow_utf8_domains main boolean false
13220 .cindex "domain" "UTF-8 characters in"
13221 .cindex "UTF-8" "in domain name"
13222 Lots of discussion is going on about internationalized domain names. One
13223 camp is strongly in favour of just using UTF-8 characters, and it seems
13224 that at least two other MTAs permit this. This option allows Exim users to
13225 experiment if they wish.
13226
13227 If it is set true, Exim's domain parsing function allows valid
13228 UTF-8 multicharacters to appear in domain name components, in addition to
13229 letters, digits, and hyphens. However, just setting this option is not
13230 enough; if you want to look up these domain names in the DNS, you must also
13231 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13232 suitable setting is:
13233 .code
13234 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13235   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13236 .endd
13237 Alternatively, you can just disable this feature by setting
13238 .code
13239 dns_check_names_pattern =
13240 .endd
13241 That is, set the option to an empty string so that no check is done.
13242
13243
13244 .option auth_advertise_hosts main "host list&!!" *
13245 .cindex "authentication" "advertising"
13246 .cindex "AUTH" "advertising"
13247 If any server authentication mechanisms are configured, Exim advertises them in
13248 response to an EHLO command only if the calling host matches this list.
13249 Otherwise, Exim does not advertise AUTH.
13250 Exim does not accept AUTH commands from clients to which it has not
13251 advertised the availability of AUTH. The advertising of individual
13252 authentication mechanisms can be controlled by the use of the
13253 &%server_advertise_condition%& generic authenticator option on the individual
13254 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13255
13256 Certain mail clients (for example, Netscape) require the user to provide a name
13257 and password for authentication if AUTH is advertised, even though it may
13258 not be needed (the host may accept messages from hosts on its local LAN without
13259 authentication, for example). The &%auth_advertise_hosts%& option can be used
13260 to make these clients more friendly by excluding them from the set of hosts to
13261 which Exim advertises AUTH.
13262
13263 .cindex "AUTH" "advertising when encrypted"
13264 If you want to advertise the availability of AUTH only when the connection
13265 is encrypted using TLS, you can make use of the fact that the value of this
13266 option is expanded, with a setting like this:
13267 .code
13268 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13269 .endd
13270 .vindex "&$tls_in_cipher$&"
13271 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13272 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13273 expansion is *, which matches all hosts.
13274
13275
13276 .option auto_thaw main time 0s
13277 .cindex "thawing messages"
13278 .cindex "unfreezing messages"
13279 If this option is set to a time greater than zero, a queue runner will try a
13280 new delivery attempt on any frozen message, other than a bounce message, if
13281 this much time has passed since it was frozen. This may result in the message
13282 being re-frozen if nothing has changed since the last attempt. It is a way of
13283 saying &"keep on trying, even though there are big problems"&.
13284
13285 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13286 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13287 thought to be very useful any more, and its use should probably be avoided.
13288
13289
13290 .option av_scanner main string "see below"
13291 This option is available if Exim is built with the content-scanning extension.
13292 It specifies which anti-virus scanner to use. The default value is:
13293 .code
13294 sophie:/var/run/sophie
13295 .endd
13296 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13297 before use. See section &<<SECTscanvirus>>& for further details.
13298
13299
13300 .option bi_command main string unset
13301 .oindex "&%-bi%&"
13302 This option supplies the name of a command that is run when Exim is called with
13303 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13304 just the command name, it is not a complete command line. If an argument is
13305 required, it must come from the &%-oA%& command line option.
13306
13307
13308 .option bounce_message_file main string unset
13309 .cindex "bounce message" "customizing"
13310 .cindex "customizing" "bounce message"
13311 This option defines a template file containing paragraphs of text to be used
13312 for constructing bounce messages.  Details of the file's contents are given in
13313 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13314
13315
13316 .option bounce_message_text main string unset
13317 When this option is set, its contents are included in the default bounce
13318 message immediately after &"This message was created automatically by mail
13319 delivery software."& It is not used if &%bounce_message_file%& is set.
13320
13321 .option bounce_return_body main boolean true
13322 .cindex "bounce message" "including body"
13323 This option controls whether the body of an incoming message is included in a
13324 bounce message when &%bounce_return_message%& is true. The default setting
13325 causes the entire message, both header and body, to be returned (subject to the
13326 value of &%bounce_return_size_limit%&). If this option is false, only the
13327 message header is included. In the case of a non-SMTP message containing an
13328 error that is detected during reception, only those header lines preceding the
13329 point at which the error was detected are returned.
13330 .cindex "bounce message" "including original"
13331
13332 .option bounce_return_message main boolean true
13333 If this option is set false, none of the original message is included in
13334 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13335 &%bounce_return_body%&.
13336
13337
13338 .option bounce_return_size_limit main integer 100K
13339 .cindex "size" "of bounce, limit"
13340 .cindex "bounce message" "size limit"
13341 .cindex "limit" "bounce message size"
13342 This option sets a limit in bytes on the size of messages that are returned to
13343 senders as part of bounce messages when &%bounce_return_message%& is true. The
13344 limit should be less than the value of the global &%message_size_limit%& and of
13345 any &%message_size_limit%& settings on transports, to allow for the bounce text
13346 that Exim generates. If this option is set to zero there is no limit.
13347
13348 When the body of any message that is to be included in a bounce message is
13349 greater than the limit, it is truncated, and a comment pointing this out is
13350 added at the top. The actual cutoff may be greater than the value given, owing
13351 to the use of buffering for transferring the message in chunks (typically 8K in
13352 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13353 messages.
13354
13355 .option bounce_sender_authentication main string unset
13356 .cindex "bounce message" "sender authentication"
13357 .cindex "authentication" "bounce message"
13358 .cindex "AUTH" "on bounce message"
13359 This option provides an authenticated sender address that is sent with any
13360 bounce messages generated by Exim that are sent over an authenticated SMTP
13361 connection. A typical setting might be:
13362 .code
13363 bounce_sender_authentication = mailer-daemon@my.domain.example
13364 .endd
13365 which would cause bounce messages to be sent using the SMTP command:
13366 .code
13367 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13368 .endd
13369 The value of &%bounce_sender_authentication%& must always be a complete email
13370 address.
13371
13372 .option callout_domain_negative_expire main time 3h
13373 .cindex "caching" "callout timeouts"
13374 .cindex "callout" "caching timeouts"
13375 This option specifies the expiry time for negative callout cache data for a
13376 domain. See section &<<SECTcallver>>& for details of callout verification, and
13377 section &<<SECTcallvercache>>& for details of the caching.
13378
13379
13380 .option callout_domain_positive_expire main time 7d
13381 This option specifies the expiry time for positive callout cache data for a
13382 domain. See section &<<SECTcallver>>& for details of callout verification, and
13383 section &<<SECTcallvercache>>& for details of the caching.
13384
13385
13386 .option callout_negative_expire main time 2h
13387 This option specifies the expiry time for negative callout cache data for an
13388 address. See section &<<SECTcallver>>& for details of callout verification, and
13389 section &<<SECTcallvercache>>& for details of the caching.
13390
13391
13392 .option callout_positive_expire main time 24h
13393 This option specifies the expiry time for positive callout cache data for an
13394 address. See section &<<SECTcallver>>& for details of callout verification, and
13395 section &<<SECTcallvercache>>& for details of the caching.
13396
13397
13398 .option callout_random_local_part main string&!! "see below"
13399 This option defines the &"random"& local part that can be used as part of
13400 callout verification. The default value is
13401 .code
13402 $primary_hostname-$tod_epoch-testing
13403 .endd
13404 See section &<<CALLaddparcall>>& for details of how this value is used.
13405
13406
13407 .option check_log_inodes main integer 0
13408 See &%check_spool_space%& below.
13409
13410
13411 .option check_log_space main integer 0
13412 See &%check_spool_space%& below.
13413
13414 .oindex "&%check_rfc2047_length%&"
13415 .cindex "RFC 2047" "disabling length check"
13416 .option check_rfc2047_length main boolean true
13417 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13418 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13419 word; strings to be encoded that exceed this length are supposed to use
13420 multiple encoded words. By default, Exim does not recognize encoded words that
13421 exceed the maximum length. However, it seems that some software, in violation
13422 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13423 set false, Exim recognizes encoded words of any length.
13424
13425
13426 .option check_spool_inodes main integer 0
13427 See &%check_spool_space%& below.
13428
13429
13430 .option check_spool_space main integer 0
13431 .cindex "checking disk space"
13432 .cindex "disk space, checking"
13433 .cindex "spool directory" "checking space"
13434 The four &%check_...%& options allow for checking of disk resources before a
13435 message is accepted.
13436
13437 .vindex "&$log_inodes$&"
13438 .vindex "&$log_space$&"
13439 .vindex "&$spool_inodes$&"
13440 .vindex "&$spool_space$&"
13441 When any of these options are set, they apply to all incoming messages. If you
13442 want to apply different checks to different kinds of message, you can do so by
13443 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13444 &$spool_space$& in an ACL with appropriate additional conditions.
13445
13446
13447 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13448 either value is greater than zero, for example:
13449 .code
13450 check_spool_space = 10M
13451 check_spool_inodes = 100
13452 .endd
13453 The spool partition is the one that contains the directory defined by
13454 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13455 transit.
13456
13457 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13458 files are written if either is greater than zero. These should be set only if
13459 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13460
13461 If there is less space or fewer inodes than requested, Exim refuses to accept
13462 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13463 error response to the MAIL command. If ESMTP is in use and there was a
13464 SIZE parameter on the MAIL command, its value is added to the
13465 &%check_spool_space%& value, and the check is performed even if
13466 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13467
13468 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13469 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13470
13471 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13472 failure a message is written to stderr and Exim exits with a non-zero code, as
13473 it obviously cannot send an error message of any kind.
13474
13475 .option daemon_smtp_ports main string &`smtp`&
13476 .cindex "port" "for daemon"
13477 .cindex "TCP/IP" "setting listening ports"
13478 This option specifies one or more default SMTP ports on which the Exim daemon
13479 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13480 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13481
13482 .option daemon_startup_retries main integer 9
13483 .cindex "daemon startup, retrying"
13484 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13485 the daemon at startup when it cannot immediately bind a listening socket
13486 (typically because the socket is already in use): &%daemon_startup_retries%&
13487 defines the number of retries after the first failure, and
13488 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13489
13490 .option daemon_startup_sleep main time 30s
13491 See &%daemon_startup_retries%&.
13492
13493 .option delay_warning main "time list" 24h
13494 .cindex "warning of delay"
13495 .cindex "delay warning, specifying"
13496 When a message is delayed, Exim sends a warning message to the sender at
13497 intervals specified by this option. The data is a colon-separated list of times
13498 after which to send warning messages. If the value of the option is an empty
13499 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13500 message has been on the queue for longer than the last time, the last interval
13501 between the times is used to compute subsequent warning times. For example,
13502 with
13503 .code
13504 delay_warning = 4h:8h:24h
13505 .endd
13506 the first message is sent after 4 hours, the second after 8 hours, and
13507 the third one after 24 hours. After that, messages are sent every 16 hours,
13508 because that is the interval between the last two times on the list. If you set
13509 just one time, it specifies the repeat interval. For example, with:
13510 .code
13511 delay_warning = 6h
13512 .endd
13513 messages are repeated every six hours. To stop warnings after a given time, set
13514 a very large time at the end of the list. For example:
13515 .code
13516 delay_warning = 2h:12h:99d
13517 .endd
13518
13519 .option delay_warning_condition main string&!! "see below"
13520 .vindex "&$domain$&"
13521 The string is expanded at the time a warning message might be sent. If all the
13522 deferred addresses have the same domain, it is set in &$domain$& during the
13523 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13524 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13525 &"false"& (the comparison being done caselessly) then the warning message is
13526 not sent. The default is:
13527 .code
13528 delay_warning_condition = ${if or {\
13529   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13530   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13531   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13532   } {no}{yes}}
13533 .endd
13534 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13535 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13536 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13537 &"auto-replied"& in an &'Auto-Submitted:'& header.
13538
13539 .option deliver_drop_privilege main boolean false
13540 .cindex "unprivileged delivery"
13541 .cindex "delivery" "unprivileged"
13542 If this option is set true, Exim drops its root privilege at the start of a
13543 delivery process, and runs as the Exim user throughout. This severely restricts
13544 the kinds of local delivery that are possible, but is viable in certain types
13545 of configuration. There is a discussion about the use of root privilege in
13546 chapter &<<CHAPsecurity>>&.
13547
13548 .option deliver_queue_load_max main fixed-point unset
13549 .cindex "load average"
13550 .cindex "queue runner" "abandoning"
13551 When this option is set, a queue run is abandoned if the system load average
13552 becomes greater than the value of the option. The option has no effect on
13553 ancient operating systems on which Exim cannot determine the load average.
13554 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13555
13556
13557 .option delivery_date_remove main boolean true
13558 .cindex "&'Delivery-date:'& header line"
13559 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13560 message when it is delivered, in exactly the same way as &'Return-path:'& is
13561 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13562 should not be present in incoming messages, and this option causes them to be
13563 removed at the time the message is received, to avoid any problems that might
13564 occur when a delivered message is subsequently sent on to some other recipient.
13565
13566 .option disable_fsync main boolean false
13567 .cindex "&[fsync()]&, disabling"
13568 This option is available only if Exim was built with the compile-time option
13569 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13570 a runtime configuration generates an &"unknown option"& error. You should not
13571 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13572 really, really, really understand what you are doing. &'No pre-compiled
13573 distributions of Exim should ever make this option available.'&
13574
13575 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13576 updated files' data to be written to disc before continuing. Unexpected events
13577 such as crashes and power outages may cause data to be lost or scrambled.
13578 Here be Dragons. &*Beware.*&
13579
13580
13581 .option disable_ipv6 main boolean false
13582 .cindex "IPv6" "disabling"
13583 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13584 activities take place. AAAA records are never looked up, and any IPv6 addresses
13585 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13586 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13587 to handle IPv6 literal addresses.
13588
13589
13590 .option dns_again_means_nonexist main "domain list&!!" unset
13591 .cindex "DNS" "&""try again""& response; overriding"
13592 DNS lookups give a &"try again"& response for the DNS errors
13593 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13594 keep trying to deliver a message, or to give repeated temporary errors to
13595 incoming mail. Sometimes the effect is caused by a badly set up name server and
13596 may persist for a long time. If a domain which exhibits this problem matches
13597 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13598 This option should be used with care. You can make it apply to reverse lookups
13599 by a setting such as this:
13600 .code
13601 dns_again_means_nonexist = *.in-addr.arpa
13602 .endd
13603 This option applies to all DNS lookups that Exim does. It also applies when the
13604 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13605 since these are most likely to be caused by DNS lookup problems. The
13606 &(dnslookup)& router has some options of its own for controlling what happens
13607 when lookups for MX or SRV records give temporary errors. These more specific
13608 options are applied after this global option.
13609
13610 .option dns_check_names_pattern main string "see below"
13611 .cindex "DNS" "pre-check of name syntax"
13612 When this option is set to a non-empty string, it causes Exim to check domain
13613 names for characters that are not allowed in host names before handing them to
13614 the DNS resolver, because some resolvers give temporary errors for names that
13615 contain unusual characters. If a domain name contains any unwanted characters,
13616 a &"not found"& result is forced, and the resolver is not called. The check is
13617 done by matching the domain name against a regular expression, which is the
13618 value of this option. The default pattern is
13619 .code
13620 dns_check_names_pattern = \
13621   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13622 .endd
13623 which permits only letters, digits, slashes, and hyphens in components, but
13624 they must start and end with a letter or digit. Slashes are not, in fact,
13625 permitted in host names, but they are found in certain NS records (which can be
13626 accessed in Exim by using a &%dnsdb%& lookup). If you set
13627 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13628 empty string.
13629
13630 .option dns_csa_search_limit main integer 5
13631 This option controls the depth of parental searching for CSA SRV records in the
13632 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13633
13634 .option dns_csa_use_reverse main boolean true
13635 This option controls whether or not an IP address, given as a CSA domain, is
13636 reversed and looked up in the reverse DNS, as described in more detail in
13637 section &<<SECTverifyCSA>>&.
13638
13639 .option dns_ipv4_lookup main "domain list&!!" unset
13640 .cindex "IPv6" "DNS lookup for AAAA records"
13641 .cindex "DNS" "IPv6 lookup for AAAA records"
13642 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13643 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13644 (A records) when trying to find IP addresses for hosts, unless the host's
13645 domain matches this list.
13646
13647 This is a fudge to help with name servers that give big delays or otherwise do
13648 not work for the AAAA record type. In due course, when the world's name
13649 servers have all been upgraded, there should be no need for this option.
13650
13651
13652 .option dns_retrans main time 0s
13653 .cindex "DNS" "resolver options"
13654 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13655 retransmission and retry parameters for DNS lookups. Values of zero (the
13656 defaults) leave the system default settings unchanged. The first value is the
13657 time between retries, and the second is the number of retries. It isn't
13658 totally clear exactly how these settings affect the total time a DNS lookup may
13659 take. I haven't found any documentation about timeouts on DNS lookups; these
13660 parameter values are available in the external resolver interface structure,
13661 but nowhere does it seem to describe how they are used or what you might want
13662 to set in them.
13663
13664
13665 .option dns_retry main integer 0
13666 See &%dns_retrans%& above.
13667
13668
13669 .new
13670 .option dns_use_dnssec main integer -1
13671 .cindex "DNS" "resolver options"
13672 .cindex "DNS" "DNSSEC"
13673 If this option is set to a non-negative number then Exim will initialise the
13674 DNS resolver library to either use or not use DNSSEC, overriding the system
13675 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
13676
13677 If the resolver library does not support DNSSEC then this option has no effect.
13678 .wen
13679
13680
13681 .option dns_use_edns0 main integer -1
13682 .cindex "DNS" "resolver options"
13683 .cindex "DNS" "EDNS0"
13684 If this option is set to a non-negative number then Exim will initialise the
13685 DNS resolver library to either use or not use EDNS0 extensions, overriding
13686 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13687 on.
13688
13689 If the resolver library does not support EDNS0 then this option has no effect.
13690
13691
13692 .option drop_cr main boolean false
13693 This is an obsolete option that is now a no-op. It used to affect the way Exim
13694 handled CR and LF characters in incoming messages. What happens now is
13695 described in section &<<SECTlineendings>>&.
13696
13697 .option dsn_from main "string&!!" "see below"
13698 .cindex "&'From:'& header line" "in bounces"
13699 .cindex "bounce messages" "&'From:'& line, specifying"
13700 This option can be used to vary the contents of &'From:'& header lines in
13701 bounces and other automatically generated messages (&"Delivery Status
13702 Notifications"& &-- hence the name of the option). The default setting is:
13703 .code
13704 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13705 .endd
13706 The value is expanded every time it is needed. If the expansion fails, a
13707 panic is logged, and the default value is used.
13708
13709 .option envelope_to_remove main boolean true
13710 .cindex "&'Envelope-to:'& header line"
13711 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13712 message when it is delivered, in exactly the same way as &'Return-path:'& is
13713 handled. &'Envelope-to:'& records the original recipient address from the
13714 messages's envelope that caused the delivery to happen. Such headers should not
13715 be present in incoming messages, and this option causes them to be removed at
13716 the time the message is received, to avoid any problems that might occur when a
13717 delivered message is subsequently sent on to some other recipient.
13718
13719
13720 .option errors_copy main "string list&!!" unset
13721 .cindex "bounce message" "copy to other address"
13722 .cindex "copy of bounce message"
13723 Setting this option causes Exim to send bcc copies of bounce messages that it
13724 generates to other addresses. &*Note*&: This does not apply to bounce messages
13725 coming from elsewhere. The value of the option is a colon-separated list of
13726 items. Each item consists of a pattern, terminated by white space, followed by
13727 a comma-separated list of email addresses. If a pattern contains spaces, it
13728 must be enclosed in double quotes.
13729
13730 Each pattern is processed in the same way as a single item in an address list
13731 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13732 the bounce message, the message is copied to the addresses on the list. The
13733 items are scanned in order, and once a matching one is found, no further items
13734 are examined. For example:
13735 .code
13736 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13737               rqps@mydomain   hostmaster@mydomain.example,\
13738                               postmaster@mydomain.example
13739 .endd
13740 .vindex "&$domain$&"
13741 .vindex "&$local_part$&"
13742 The address list is expanded before use. The expansion variables &$local_part$&
13743 and &$domain$& are set from the original recipient of the error message, and if
13744 there was any wildcard matching in the pattern, the expansion
13745 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13746 variables &$0$&, &$1$&, etc. are set in the normal way.
13747
13748
13749 .option errors_reply_to main string unset
13750 .cindex "bounce message" "&'Reply-to:'& in"
13751 By default, Exim's bounce and delivery warning messages contain the header line
13752 .display
13753 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13754 .endd
13755 .oindex &%quota_warn_message%&
13756 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13757 A warning message that is generated by the &%quota_warn_message%& option in an
13758 &(appendfile)& transport may contain its own &'From:'& header line that
13759 overrides the default.
13760
13761 Experience shows that people reply to bounce messages. If the
13762 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13763 and warning messages. For example:
13764 .code
13765 errors_reply_to = postmaster@my.domain.example
13766 .endd
13767 The value of the option is not expanded. It must specify a valid RFC 2822
13768 address. However, if a warning message that is generated by the
13769 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13770 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13771 not used.
13772
13773
13774 .option exim_group main string "compile-time configured"
13775 .cindex "gid (group id)" "Exim's own"
13776 .cindex "Exim group"
13777 This option changes the gid under which Exim runs when it gives up root
13778 privilege. The default value is compiled into the binary. The value of this
13779 option is used only when &%exim_user%& is also set. Unless it consists entirely
13780 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13781 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13782 security issues.
13783
13784
13785 .option exim_path main string "see below"
13786 .cindex "Exim binary, path name"
13787 This option specifies the path name of the Exim binary, which is used when Exim
13788 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13789 the directory configured at compile time by the BIN_DIRECTORY setting. It
13790 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13791 other place.
13792 &*Warning*&: Do not use a macro to define the value of this option, because
13793 you will break those Exim utilities that scan the configuration file to find
13794 where the binary is. (They then use the &%-bP%& option to extract option
13795 settings such as the value of &%spool_directory%&.)
13796
13797
13798 .option exim_user main string "compile-time configured"
13799 .cindex "uid (user id)" "Exim's own"
13800 .cindex "Exim user"
13801 This option changes the uid under which Exim runs when it gives up root
13802 privilege. The default value is compiled into the binary. Ownership of the run
13803 time configuration file and the use of the &%-C%& and &%-D%& command line
13804 options is checked against the values in the binary, not what is set here.
13805
13806 Unless it consists entirely of digits, the string is looked up using
13807 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13808 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13809 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13810
13811
13812 .option extra_local_interfaces main "string list" unset
13813 This option defines network interfaces that are to be considered local when
13814 routing, but which are not used for listening by the daemon. See section
13815 &<<SECTreclocipadd>>& for details.
13816
13817
13818 . Allow this long option name to split; give it unsplit as a fifth argument
13819 . for the automatic .oindex that is generated by .option.
13820
13821 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13822          extract_addresses_remove_arguments
13823 .oindex "&%-t%&"
13824 .cindex "command line" "addresses with &%-t%&"
13825 .cindex "Sendmail compatibility" "&%-t%& option"
13826 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13827 are present on the command line when the &%-t%& option is used to build an
13828 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13829 line addresses are removed from the recipients list. This is also how Smail
13830 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13831 command line addresses are added to those obtained from the header lines. When
13832 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13833 argument headers. If it is set false, Exim adds rather than removes argument
13834 addresses.
13835
13836
13837 .option finduser_retries main integer 0
13838 .cindex "NIS, retrying user lookups"
13839 On systems running NIS or other schemes in which user and group information is
13840 distributed from a remote system, there can be times when &[getpwnam()]& and
13841 related functions fail, even when given valid data, because things time out.
13842 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13843 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13844 many extra times to find a user or a group, waiting for one second between
13845 retries.
13846
13847 .cindex "&_/etc/passwd_&" "multiple reading of"
13848 You should not set this option greater than zero if your user information is in
13849 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13850 search the file multiple times for non-existent users, and also cause delay.
13851
13852
13853
13854 .option freeze_tell main "string list, comma separated" unset
13855 .cindex "freezing messages" "sending a message when freezing"
13856 On encountering certain errors, or when configured to do so in a system filter,
13857 ACL, or special router, Exim freezes a message. This means that no further
13858 delivery attempts take place until an administrator thaws the message, or the
13859 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13860 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13861 warning message whenever it freezes something, unless the message it is
13862 freezing is a locally-generated bounce message. (Without this exception there
13863 is the possibility of looping.) The warning message is sent to the addresses
13864 supplied as the comma-separated value of this option. If several of the
13865 message's addresses cause freezing, only a single message is sent. If the
13866 freezing was automatic, the reason(s) for freezing can be found in the message
13867 log. If you configure freezing in a filter or ACL, you must arrange for any
13868 logging that you require.
13869
13870
13871 .option gecos_name main string&!! unset
13872 .cindex "HP-UX"
13873 .cindex "&""gecos""& field, parsing"
13874 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13875 password file to hold other information in addition to users' real names. Exim
13876 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13877 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13878 of the field are used unchanged, except that, if an ampersand is encountered,
13879 it is replaced by the user's login name with the first character forced to
13880 upper case, since this is a convention that is observed on many systems.
13881
13882 When these options are set, &%gecos_pattern%& is treated as a regular
13883 expression that is to be applied to the field (again with && replaced by the
13884 login name), and if it matches, &%gecos_name%& is expanded and used as the
13885 user's name.
13886
13887 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13888 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13889 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13890 name terminates at the first comma, the following can be used:
13891 .code
13892 gecos_pattern = ([^,]*)
13893 gecos_name = $1
13894 .endd
13895
13896 .option gecos_pattern main string unset
13897 See &%gecos_name%& above.
13898
13899
13900 .option gnutls_compat_mode main boolean unset
13901 This option controls whether GnuTLS is used in compatibility mode in an Exim
13902 server. This reduces security slightly, but improves interworking with older
13903 implementations of TLS.
13904
13905
13906 .new
13907 option gnutls_enable_pkcs11 main boolean unset
13908 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
13909 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
13910
13911 See
13912 &url(http://www.gnu.org/software/gnutls/manual/gnutls.html#Smart-cards-and-HSMs)
13913 for documentation.
13914 .wen
13915
13916
13917
13918 .option headers_charset main string "see below"
13919 This option sets a default character set for translating from encoded MIME
13920 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13921 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13922 ultimate default is ISO-8859-1. For more details see the description of header
13923 insertions in section &<<SECTexpansionitems>>&.
13924
13925
13926
13927 .option header_maxsize main integer "see below"
13928 .cindex "header section" "maximum size of"
13929 .cindex "limit" "size of message header section"
13930 This option controls the overall maximum size of a message's header
13931 section. The default is the value of HEADER_MAXSIZE in
13932 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13933 sections are rejected.
13934
13935
13936 .option header_line_maxsize main integer 0
13937 .cindex "header lines" "maximum size of"
13938 .cindex "limit" "size of one header line"
13939 This option limits the length of any individual header line in a message, after
13940 all the continuations have been joined together. Messages with individual
13941 header lines that are longer than the limit are rejected. The default value of
13942 zero means &"no limit"&.
13943
13944
13945
13946
13947 .option helo_accept_junk_hosts main "host list&!!" unset
13948 .cindex "HELO" "accepting junk data"
13949 .cindex "EHLO" "accepting junk data"
13950 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13951 mail, and gives an error response for invalid data. Unfortunately, there are
13952 some SMTP clients that send syntactic junk. They can be accommodated by setting
13953 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13954 if you want to do semantic checking.
13955 See also &%helo_allow_chars%& for a way of extending the permitted character
13956 set.
13957
13958
13959 .option helo_allow_chars main string unset
13960 .cindex "HELO" "underscores in"
13961 .cindex "EHLO" "underscores in"
13962 .cindex "underscore in EHLO/HELO"
13963 This option can be set to a string of rogue characters that are permitted in
13964 all EHLO and HELO names in addition to the standard letters, digits,
13965 hyphens, and dots. If you really must allow underscores, you can set
13966 .code
13967 helo_allow_chars = _
13968 .endd
13969 Note that the value is one string, not a list.
13970
13971
13972 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13973 .cindex "HELO" "forcing reverse lookup"
13974 .cindex "EHLO" "forcing reverse lookup"
13975 If the domain given by a client in a HELO or EHLO command matches this
13976 list, a reverse lookup is done in order to establish the host's true name. The
13977 default forces a lookup if the client host gives the server's name or any of
13978 its IP addresses (in brackets), something that broken clients have been seen to
13979 do.
13980
13981
13982 .option helo_try_verify_hosts main "host list&!!" unset
13983 .cindex "HELO verifying" "optional"
13984 .cindex "EHLO" "verifying, optional"
13985 By default, Exim just checks the syntax of HELO and EHLO commands (see
13986 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13987 to do more extensive checking of the data supplied by these commands. The ACL
13988 condition &`verify = helo`& is provided to make this possible.
13989 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13990 to force the check to occur. From release 4.53 onwards, this is no longer
13991 necessary. If the check has not been done before &`verify = helo`& is
13992 encountered, it is done at that time. Consequently, this option is obsolete.
13993 Its specification is retained here for backwards compatibility.
13994
13995 When an EHLO or HELO command is received, if the calling host matches
13996 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13997 EHLO command either:
13998
13999 .ilist
14000 is an IP literal matching the calling address of the host, or
14001 .next
14002 .cindex "DNS" "reverse lookup"
14003 .cindex "reverse DNS lookup"
14004 matches the host name that Exim obtains by doing a reverse lookup of the
14005 calling host address, or
14006 .next
14007 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14008 available) yields the calling host address.
14009 .endlist
14010
14011 However, the EHLO or HELO command is not rejected if any of the checks
14012 fail. Processing continues, but the result of the check is remembered, and can
14013 be detected later in an ACL by the &`verify = helo`& condition.
14014
14015 .option helo_verify_hosts main "host list&!!" unset
14016 .cindex "HELO verifying" "mandatory"
14017 .cindex "EHLO" "verifying, mandatory"
14018 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14019 backwards compatibility. For hosts that match this option, Exim checks the host
14020 name given in the HELO or EHLO in the same way as for
14021 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14022 rejected with a 550 error, and entries are written to the main and reject logs.
14023 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14024 error.
14025
14026 .option hold_domains main "domain list&!!" unset
14027 .cindex "domain" "delaying delivery"
14028 .cindex "delivery" "delaying certain domains"
14029 This option allows mail for particular domains to be held on the queue
14030 manually. The option is overridden if a message delivery is forced with the
14031 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14032 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14033 item in &%hold_domains%&, no routing or delivery for that address is done, and
14034 it is deferred every time the message is looked at.
14035
14036 This option is intended as a temporary operational measure for delaying the
14037 delivery of mail while some problem is being sorted out, or some new
14038 configuration tested. If you just want to delay the processing of some
14039 domains until a queue run occurs, you should use &%queue_domains%& or
14040 &%queue_smtp_domains%&, not &%hold_domains%&.
14041
14042 A setting of &%hold_domains%& does not override Exim's code for removing
14043 messages from the queue if they have been there longer than the longest retry
14044 time in any retry rule. If you want to hold messages for longer than the normal
14045 retry times, insert a dummy retry rule with a long retry time.
14046
14047
14048 .option host_lookup main "host list&!!" unset
14049 .cindex "host name" "lookup, forcing"
14050 Exim does not look up the name of a calling host from its IP address unless it
14051 is required to compare against some host list, or the host matches
14052 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14053 option (which normally contains IP addresses rather than host names). The
14054 default configuration file contains
14055 .code
14056 host_lookup = *
14057 .endd
14058 which causes a lookup to happen for all hosts. If the expense of these lookups
14059 is felt to be too great, the setting can be changed or removed.
14060
14061 After a successful reverse lookup, Exim does a forward lookup on the name it
14062 has obtained, to verify that it yields the IP address that it started with. If
14063 this check fails, Exim behaves as if the name lookup failed.
14064
14065 .vindex "&$host_lookup_failed$&"
14066 .vindex "&$sender_host_name$&"
14067 After any kind of failure, the host name (in &$sender_host_name$&) remains
14068 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14069 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14070 &`verify = reverse_host_lookup`& in ACLs.
14071
14072
14073 .option host_lookup_order main "string list" &`bydns:byaddr`&
14074 This option specifies the order of different lookup methods when Exim is trying
14075 to find a host name from an IP address. The default is to do a DNS lookup
14076 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14077 if that fails. You can change the order of these lookups, or omit one entirely,
14078 if you want.
14079
14080 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14081 multiple PTR records in the DNS and the IP address is not listed in
14082 &_/etc/hosts_&. Different operating systems give different results in this
14083 case. That is why the default tries a DNS lookup first.
14084
14085
14086
14087 .option host_reject_connection main "host list&!!" unset
14088 .cindex "host" "rejecting connections from"
14089 If this option is set, incoming SMTP calls from the hosts listed are rejected
14090 as soon as the connection is made.
14091 This option is obsolete, and retained only for backward compatibility, because
14092 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14093 connections immediately.
14094
14095 The ability to give an immediate rejection (either by this option or using an
14096 ACL) is provided for use in unusual cases. Many hosts will just try again,
14097 sometimes without much delay. Normally, it is better to use an ACL to reject
14098 incoming messages at a later stage, such as after RCPT commands. See
14099 chapter &<<CHAPACL>>&.
14100
14101
14102 .option hosts_connection_nolog main "host list&!!" unset
14103 .cindex "host" "not logging connections from"
14104 This option defines a list of hosts for which connection logging does not
14105 happen, even though the &%smtp_connection%& log selector is set. For example,
14106 you might want not to log SMTP connections from local processes, or from
14107 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14108 the daemon; you should therefore strive to restrict its value to a short inline
14109 list of IP addresses and networks. To disable logging SMTP connections from
14110 local processes, you must create a host list with an empty item. For example:
14111 .code
14112 hosts_connection_nolog = :
14113 .endd
14114 If the &%smtp_connection%& log selector is not set, this option has no effect.
14115
14116
14117
14118 .option hosts_treat_as_local main "domain list&!!" unset
14119 .cindex "local host" "domains treated as"
14120 .cindex "host" "treated as local"
14121 If this option is set, any host names that match the domain list are treated as
14122 if they were the local host when Exim is scanning host lists obtained from MX
14123 records
14124 or other sources. Note that the value of this option is a domain list, not a
14125 host list, because it is always used to check host names, not IP addresses.
14126
14127 This option also applies when Exim is matching the special items
14128 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14129 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14130 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14131 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14132 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14133 interfaces and recognizing the local host.
14134
14135
14136 .option ibase_servers main "string list" unset
14137 .cindex "InterBase" "server list"
14138 This option provides a list of InterBase servers and associated connection data,
14139 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14140 The option is available only if Exim has been built with InterBase support.
14141
14142
14143
14144 .option ignore_bounce_errors_after main time 10w
14145 .cindex "bounce message" "discarding"
14146 .cindex "discarding bounce message"
14147 This option affects the processing of bounce messages that cannot be delivered,
14148 that is, those that suffer a permanent delivery failure. (Bounce messages that
14149 suffer temporary delivery failures are of course retried in the usual way.)
14150
14151 After a permanent delivery failure, bounce messages are frozen,
14152 because there is no sender to whom they can be returned. When a frozen bounce
14153 message has been on the queue for more than the given time, it is unfrozen at
14154 the next queue run, and a further delivery is attempted. If delivery fails
14155 again, the bounce message is discarded. This makes it possible to keep failed
14156 bounce messages around for a shorter time than the normal maximum retry time
14157 for frozen messages. For example,
14158 .code
14159 ignore_bounce_errors_after = 12h
14160 .endd
14161 retries failed bounce message deliveries after 12 hours, discarding any further
14162 failures. If the value of this option is set to a zero time period, bounce
14163 failures are discarded immediately. Setting a very long time (as in the default
14164 value) has the effect of disabling this option. For ways of automatically
14165 dealing with other kinds of frozen message, see &%auto_thaw%& and
14166 &%timeout_frozen_after%&.
14167
14168
14169 .option ignore_fromline_hosts main "host list&!!" unset
14170 .cindex "&""From""& line"
14171 .cindex "UUCP" "&""From""& line"
14172 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14173 the headers of a message. By default this is treated as the start of the
14174 message's body, which means that any following headers are not recognized as
14175 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14176 match those hosts that insist on sending it. If the sender is actually a local
14177 process rather than a remote host, and is using &%-bs%& to inject the messages,
14178 &%ignore_fromline_local%& must be set to achieve this effect.
14179
14180
14181 .option ignore_fromline_local main boolean false
14182 See &%ignore_fromline_hosts%& above.
14183
14184
14185 .option keep_malformed main time 4d
14186 This option specifies the length of time to keep messages whose spool files
14187 have been corrupted in some way. This should, of course, never happen. At the
14188 next attempt to deliver such a message, it gets removed. The incident is
14189 logged.
14190
14191
14192 .option ldap_ca_cert_dir main string unset
14193 .cindex "LDAP", "TLS CA certificate directory"
14194 This option indicates which directory contains CA certificates for verifying
14195 a TLS certificate presented by an LDAP server.
14196 While Exim does not provide a default value, your SSL library may.
14197 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14198 and constrained to be a directory.
14199
14200
14201 .option ldap_ca_cert_file main string unset
14202 .cindex "LDAP", "TLS CA certificate file"
14203 This option indicates which file contains CA certificates for verifying
14204 a TLS certificate presented by an LDAP server.
14205 While Exim does not provide a default value, your SSL library may.
14206 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14207 and constrained to be a file.
14208
14209
14210 .option ldap_cert_file main string unset
14211 .cindex "LDAP" "TLS client certificate file"
14212 This option indicates which file contains an TLS client certificate which
14213 Exim should present to the LDAP server during TLS negotiation.
14214 Should be used together with &%ldap_cert_key%&.
14215
14216
14217 .option ldap_cert_key main string unset
14218 .cindex "LDAP" "TLS client key file"
14219 This option indicates which file contains the secret/private key to use
14220 to prove identity to the LDAP server during TLS negotiation.
14221 Should be used together with &%ldap_cert_file%&, which contains the
14222 identity to be proven.
14223
14224
14225 .option ldap_cipher_suite main string unset
14226 .cindex "LDAP" "TLS cipher suite"
14227 This controls the TLS cipher-suite negotiation during TLS negotiation with
14228 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14229 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14230
14231
14232 .option ldap_default_servers main "string list" unset
14233 .cindex "LDAP" "default servers"
14234 This option provides a list of LDAP servers which are tried in turn when an
14235 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14236 details of LDAP queries. This option is available only when Exim has been built
14237 with LDAP support.
14238
14239
14240 .option ldap_require_cert main string unset.
14241 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14242 This should be one of the values "hard", "demand", "allow", "try" or "never".
14243 A value other than one of these is interpreted as "never".
14244 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14245 Although Exim does not set a default, the LDAP library probably defaults
14246 to hard/demand.
14247
14248
14249 .option ldap_start_tls main boolean false
14250 .cindex "LDAP" "whether or not to negotiate TLS"
14251 If set, Exim will attempt to negotiate TLS with the LDAP server when
14252 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14253 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14254 of SSL-on-connect.
14255 In the event of failure to negotiate TLS, the action taken is controlled
14256 by &%ldap_require_cert%&.
14257
14258
14259 .option ldap_version main integer unset
14260 .cindex "LDAP" "protocol version, forcing"
14261 This option can be used to force Exim to set a specific protocol version for
14262 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14263 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14264 the LDAP headers; otherwise it is 2. This option is available only when Exim
14265 has been built with LDAP support.
14266
14267
14268
14269 .option local_from_check main boolean true
14270 .cindex "&'Sender:'& header line" "disabling addition of"
14271 .cindex "&'From:'& header line" "disabling checking of"
14272 When a message is submitted locally (that is, not over a TCP/IP connection) by
14273 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14274 checks that the &'From:'& header line matches the login of the calling user and
14275 the domain specified by &%qualify_domain%&.
14276
14277 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14278 locally submitted message is automatically qualified by Exim, unless the
14279 &%-bnq%& command line option is used.
14280
14281 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14282 on the local part. If the &'From:'& header line does not match, Exim adds a
14283 &'Sender:'& header with an address constructed from the calling user's login
14284 and the default qualify domain.
14285
14286 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14287 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14288 &'Sender:'& header lines supplied by untrusted users, you must also set
14289 &%local_sender_retain%& to be true.
14290
14291 .cindex "envelope sender"
14292 These options affect only the header lines in the message. The envelope sender
14293 is still forced to be the login id at the qualify domain unless
14294 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14295
14296 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14297 request similar header line checking. See section &<<SECTthesenhea>>&, which
14298 has more details about &'Sender:'& processing.
14299
14300
14301
14302
14303 .option local_from_prefix main string unset
14304 When Exim checks the &'From:'& header line of locally submitted messages for
14305 matching the login id (see &%local_from_check%& above), it can be configured to
14306 ignore certain prefixes and suffixes in the local part of the address. This is
14307 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14308 appropriate lists, in the same form as the &%local_part_prefix%& and
14309 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14310 example, if
14311 .code
14312 local_from_prefix = *-
14313 .endd
14314 is set, a &'From:'& line containing
14315 .code
14316 From: anything-user@your.domain.example
14317 .endd
14318 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14319 matches the actual sender address that is constructed from the login name and
14320 qualify domain.
14321
14322
14323 .option local_from_suffix main string unset
14324 See &%local_from_prefix%& above.
14325
14326
14327 .option local_interfaces main "string list" "see below"
14328 This option controls which network interfaces are used by the daemon for
14329 listening; they are also used to identify the local host when routing. Chapter
14330 &<<CHAPinterfaces>>& contains a full description of this option and the related
14331 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14332 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14333 &%local_interfaces%& is
14334 .code
14335 local_interfaces = 0.0.0.0
14336 .endd
14337 when Exim is built without IPv6 support; otherwise it is
14338 .code
14339 local_interfaces = <; ::0 ; 0.0.0.0
14340 .endd
14341
14342 .option local_scan_timeout main time 5m
14343 .cindex "timeout" "for &[local_scan()]& function"
14344 .cindex "&[local_scan()]& function" "timeout"
14345 This timeout applies to the &[local_scan()]& function (see chapter
14346 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14347 the incoming message is rejected with a temporary error if it is an SMTP
14348 message. For a non-SMTP message, the message is dropped and Exim ends with a
14349 non-zero code. The incident is logged on the main and reject logs.
14350
14351
14352
14353 .option local_sender_retain main boolean false
14354 .cindex "&'Sender:'& header line" "retaining from local submission"
14355 When a message is submitted locally (that is, not over a TCP/IP connection) by
14356 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14357 do not want this to happen, you must set &%local_sender_retain%&, and you must
14358 also set &%local_from_check%& to be false (Exim will complain if you do not).
14359 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14360 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14361
14362
14363
14364
14365 .option localhost_number main string&!! unset
14366 .cindex "host" "locally unique number for"
14367 .cindex "message ids" "with multiple hosts"
14368 .vindex "&$localhost_number$&"
14369 Exim's message ids are normally unique only within the local host. If
14370 uniqueness among a set of hosts is required, each host must set a different
14371 value for the &%localhost_number%& option. The string is expanded immediately
14372 after reading the configuration file (so that a number can be computed from the
14373 host name, for example) and the result of the expansion must be a number in the
14374 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14375 systems). This is available in subsequent string expansions via the variable
14376 &$localhost_number$&. When &%localhost_number is set%&, the final two
14377 characters of the message id, instead of just being a fractional part of the
14378 time, are computed from the time and the local host number as described in
14379 section &<<SECTmessiden>>&.
14380
14381
14382
14383 .option log_file_path main "string list&!!" "set at compile time"
14384 .cindex "log" "file path for"
14385 This option sets the path which is used to determine the names of Exim's log
14386 files, or indicates that logging is to be to syslog, or both. It is expanded
14387 when Exim is entered, so it can, for example, contain a reference to the host
14388 name. If no specific path is set for the log files at compile or run time, they
14389 are written in a sub-directory called &_log_& in Exim's spool directory.
14390 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14391 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14392 used. If this string is fixed at your installation (contains no expansion
14393 variables) it is recommended that you do not set this option in the
14394 configuration file, but instead supply the path using LOG_FILE_PATH in
14395 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14396 early on &-- in particular, failure to read the configuration file.
14397
14398
14399 .option log_selector main string unset
14400 .cindex "log" "selectors"
14401 This option can be used to reduce or increase the number of things that Exim
14402 writes to its log files. Its argument is made up of names preceded by plus or
14403 minus characters. For example:
14404 .code
14405 log_selector = +arguments -retry_defer
14406 .endd
14407 A list of possible names and what they control is given in the chapter on
14408 logging, in section &<<SECTlogselector>>&.
14409
14410
14411 .option log_timezone main boolean false
14412 .cindex "log" "timezone for entries"
14413 .vindex "&$tod_log$&"
14414 .vindex "&$tod_zone$&"
14415 By default, the timestamps on log lines are in local time without the
14416 timezone. This means that if your timezone changes twice a year, the timestamps
14417 in log lines are ambiguous for an hour when the clocks go back. One way of
14418 avoiding this problem is to set the timezone to UTC. An alternative is to set
14419 &%log_timezone%& true. This turns on the addition of the timezone offset to
14420 timestamps in log lines. Turning on this option can add quite a lot to the size
14421 of log files because each line is extended by 6 characters. Note that the
14422 &$tod_log$& variable contains the log timestamp without the zone, but there is
14423 another variable called &$tod_zone$& that contains just the timezone offset.
14424
14425
14426 .option lookup_open_max main integer 25
14427 .cindex "too many open files"
14428 .cindex "open files, too many"
14429 .cindex "file" "too many open"
14430 .cindex "lookup" "maximum open files"
14431 .cindex "limit" "open files for lookups"
14432 This option limits the number of simultaneously open files for single-key
14433 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14434 Exim normally keeps these files open during routing, because often the same
14435 file is required several times. If the limit is reached, Exim closes the least
14436 recently used file. Note that if you are using the &'ndbm'& library, it
14437 actually opens two files for each logical DBM database, though it still counts
14438 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14439 open files"& errors with NDBM, you need to reduce the value of
14440 &%lookup_open_max%&.
14441
14442
14443 .option max_username_length main integer 0
14444 .cindex "length of login name"
14445 .cindex "user name" "maximum length"
14446 .cindex "limit" "user name length"
14447 Some operating systems are broken in that they truncate long arguments to
14448 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14449 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14450 an argument that is longer behaves as if &[getpwnam()]& failed.
14451
14452
14453 .option message_body_newlines main bool false
14454 .cindex "message body" "newlines in variables"
14455 .cindex "newline" "in message body variables"
14456 .vindex "&$message_body$&"
14457 .vindex "&$message_body_end$&"
14458 By default, newlines in the message body are replaced by spaces when setting
14459 the &$message_body$& and &$message_body_end$& expansion variables. If this
14460 option is set true, this no longer happens.
14461
14462
14463 .option message_body_visible main integer 500
14464 .cindex "body of message" "visible size"
14465 .cindex "message body" "visible size"
14466 .vindex "&$message_body$&"
14467 .vindex "&$message_body_end$&"
14468 This option specifies how much of a message's body is to be included in the
14469 &$message_body$& and &$message_body_end$& expansion variables.
14470
14471
14472 .option message_id_header_domain main string&!! unset
14473 .cindex "&'Message-ID:'& header line"
14474 If this option is set, the string is expanded and used as the right hand side
14475 (domain) of the &'Message-ID:'& header that Exim creates if a
14476 locally-originated incoming message does not have one. &"Locally-originated"&
14477 means &"not received over TCP/IP."&
14478 Otherwise, the primary host name is used.
14479 Only letters, digits, dot and hyphen are accepted; any other characters are
14480 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14481 empty string, the option is ignored.
14482
14483
14484 .option message_id_header_text main string&!! unset
14485 If this variable is set, the string is expanded and used to augment the text of
14486 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14487 message does not have one. The text of this header is required by RFC 2822 to
14488 take the form of an address. By default, Exim uses its internal message id as
14489 the local part, and the primary host name as the domain. If this option is set,
14490 it is expanded, and provided the expansion is not forced to fail, and does not
14491 yield an empty string, the result is inserted into the header immediately
14492 before the @, separated from the internal message id by a dot. Any characters
14493 that are illegal in an address are automatically converted into hyphens. This
14494 means that variables such as &$tod_log$& can be used, because the spaces and
14495 colons will become hyphens.
14496
14497
14498 .option message_logs main boolean true
14499 .cindex "message logs" "disabling"
14500 .cindex "log" "message log; disabling"
14501 If this option is turned off, per-message log files are not created in the
14502 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14503 Exim, by reducing the number of files involved in handling a message from a
14504 minimum of four (header spool file, body spool file, delivery journal, and
14505 per-message log) to three. The other major I/O activity is Exim's main log,
14506 which is not affected by this option.
14507
14508
14509 .option message_size_limit main string&!! 50M
14510 .cindex "message" "size limit"
14511 .cindex "limit" "message size"
14512 .cindex "size" "of message, limit"
14513 This option limits the maximum size of message that Exim will process. The
14514 value is expanded for each incoming connection so, for example, it can be made
14515 to depend on the IP address of the remote host for messages arriving via
14516 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14517 optionally followed by K or M.
14518
14519 &*Note*&: This limit cannot be made to depend on a message's sender or any
14520 other properties of an individual message, because it has to be advertised in
14521 the server's response to EHLO. String expansion failure causes a temporary
14522 error. A value of zero means no limit, but its use is not recommended. See also
14523 &%bounce_return_size_limit%&.
14524
14525 Incoming SMTP messages are failed with a 552 error if the limit is
14526 exceeded; locally-generated messages either get a stderr message or a delivery
14527 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14528 an oversized message is logged in both the main and the reject logs. See also
14529 the generic transport option &%message_size_limit%&, which limits the size of
14530 message that an individual transport can process.
14531
14532 If you use a virus-scanner and set this option to to a value larger than the
14533 maximum size that your virus-scanner is configured to support, you may get
14534 failures triggered by large mails.  The right size to configure for the
14535 virus-scanner depends upon what data is passed and the options in use but it's
14536 probably safest to just set it to a little larger than this value.  Eg, with a
14537 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14538 some problems may result.
14539
14540 A value of 0 will disable size limit checking; Exim will still advertise the
14541 SIZE extension in an EHLO response, but without a limit, so as to permit
14542 SMTP clients to still indicate the message size along with the MAIL verb.
14543
14544
14545 .option move_frozen_messages main boolean false
14546 .cindex "frozen messages" "moving"
14547 This option, which is available only if Exim has been built with the setting
14548 .code
14549 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14550 .endd
14551 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14552 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14553 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14554 standard utilities for handling such moved messages, and they do not show up in
14555 lists generated by &%-bp%& or by the Exim monitor.
14556
14557
14558 .option mua_wrapper main boolean false
14559 Setting this option true causes Exim to run in a very restrictive mode in which
14560 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14561 contains a full description of this facility.
14562
14563
14564
14565 .option mysql_servers main "string list" unset
14566 .cindex "MySQL" "server list"
14567 This option provides a list of MySQL servers and associated connection data, to
14568 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14569 option is available only if Exim has been built with MySQL support.
14570
14571
14572 .option never_users main "string list&!!" unset
14573 This option is expanded just once, at the start of Exim's processing. Local
14574 message deliveries are normally run in processes that are setuid to the
14575 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14576 It is usually desirable to prevent any deliveries from running as root, as a
14577 safety precaution.
14578
14579 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14580 list of users that must not be used for local deliveries. This list is fixed in
14581 the binary and cannot be overridden by the configuration file. By default, it
14582 contains just the single user name &"root"&. The &%never_users%& runtime option
14583 can be used to add more users to the fixed list.
14584
14585 If a message is to be delivered as one of the users on the fixed list or the
14586 &%never_users%& list, an error occurs, and delivery is deferred. A common
14587 example is
14588 .code
14589 never_users = root:daemon:bin
14590 .endd
14591 Including root is redundant if it is also on the fixed list, but it does no
14592 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14593 transport driver.
14594
14595
14596 .option openssl_options main "string list" "+no_sslv2"
14597 .cindex "OpenSSL "compatibility options"
14598 This option allows an administrator to adjust the SSL options applied
14599 by OpenSSL to connections.  It is given as a space-separated list of items,
14600 each one to be +added or -subtracted from the current value.
14601
14602 This option is only available if Exim is built against OpenSSL.  The values
14603 available for this option vary according to the age of your OpenSSL install.
14604 The &"all"& value controls a subset of flags which are available, typically
14605 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14606 list the values known on your system and Exim should support all the
14607 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14608 names lose the leading &"SSL_OP_"& and are lower-cased.
14609
14610 Note that adjusting the options can have severe impact upon the security of
14611 SSL as used by Exim.  It is possible to disable safety checks and shoot
14612 yourself in the foot in various unpleasant ways.  This option should not be
14613 adjusted lightly.  An unrecognised item will be detected at startup, by
14614 invoking Exim with the &%-bV%& flag.
14615
14616 Historical note: prior to release 4.80, Exim defaulted this value to
14617 "+dont_insert_empty_fragments", which may still be needed for compatibility
14618 with some clients, but which lowers security by increasing exposure to
14619 some now infamous attacks.
14620
14621 An example:
14622 .code
14623 # Make both old MS and old Eudora happy:
14624 openssl_options = -all +microsoft_big_sslv3_buffer \
14625                        +dont_insert_empty_fragments
14626 .endd
14627
14628 Possible options may include:
14629 .ilist
14630 &`all`&
14631 .next
14632 &`allow_unsafe_legacy_renegotiation`&
14633 .next
14634 &`cipher_server_preference`&
14635 .next
14636 &`dont_insert_empty_fragments`&
14637 .next
14638 &`ephemeral_rsa`&
14639 .next
14640 &`legacy_server_connect`&
14641 .next
14642 &`microsoft_big_sslv3_buffer`&
14643 .next
14644 &`microsoft_sess_id_bug`&
14645 .next
14646 &`msie_sslv2_rsa_padding`&
14647 .next
14648 &`netscape_challenge_bug`&
14649 .next
14650 &`netscape_reuse_cipher_change_bug`&
14651 .next
14652 &`no_compression`&
14653 .next
14654 &`no_session_resumption_on_renegotiation`&
14655 .next
14656 &`no_sslv2`&
14657 .next
14658 &`no_sslv3`&
14659 .next
14660 &`no_ticket`&
14661 .next
14662 &`no_tlsv1`&
14663 .next
14664 &`no_tlsv1_1`&
14665 .next
14666 &`no_tlsv1_2`&
14667 .next
14668 &`single_dh_use`&
14669 .next
14670 &`single_ecdh_use`&
14671 .next
14672 &`ssleay_080_client_dh_bug`&
14673 .next
14674 &`sslref2_reuse_cert_type_bug`&
14675 .next
14676 &`tls_block_padding_bug`&
14677 .next
14678 &`tls_d5_bug`&
14679 .next
14680 &`tls_rollback_bug`&
14681 .endlist
14682
14683
14684 .option oracle_servers main "string list" unset
14685 .cindex "Oracle" "server list"
14686 This option provides a list of Oracle servers and associated connection data,
14687 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14688 The option is available only if Exim has been built with Oracle support.
14689
14690
14691 .option percent_hack_domains main "domain list&!!" unset
14692 .cindex "&""percent hack""&"
14693 .cindex "source routing" "in email address"
14694 .cindex "address" "source-routed"
14695 The &"percent hack"& is the convention whereby a local part containing a
14696 percent sign is re-interpreted as a new email address, with the percent
14697 replaced by @. This is sometimes called &"source routing"&, though that term is
14698 also applied to RFC 2822 addresses that begin with an @ character. If this
14699 option is set, Exim implements the percent facility for those domains listed,
14700 but no others. This happens before an incoming SMTP address is tested against
14701 an ACL.
14702
14703 &*Warning*&: The &"percent hack"& has often been abused by people who are
14704 trying to get round relaying restrictions. For this reason, it is best avoided
14705 if at all possible. Unfortunately, a number of less security-conscious MTAs
14706 implement it unconditionally. If you are running Exim on a gateway host, and
14707 routing mail through to internal MTAs without processing the local parts, it is
14708 a good idea to reject recipient addresses with percent characters in their
14709 local parts. Exim's default configuration does this.
14710
14711
14712 .option perl_at_start main boolean false
14713 This option is available only when Exim is built with an embedded Perl
14714 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14715
14716
14717 .option perl_startup main string unset
14718 This option is available only when Exim is built with an embedded Perl
14719 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14720
14721
14722 .option pgsql_servers main "string list" unset
14723 .cindex "PostgreSQL lookup type" "server list"
14724 This option provides a list of PostgreSQL servers and associated connection
14725 data, to be used in conjunction with &(pgsql)& lookups (see section
14726 &<<SECID72>>&). The option is available only if Exim has been built with
14727 PostgreSQL support.
14728
14729
14730 .option pid_file_path main string&!! "set at compile time"
14731 .cindex "daemon" "pid file path"
14732 .cindex "pid file, path for"
14733 This option sets the name of the file to which the Exim daemon writes its
14734 process id. The string is expanded, so it can contain, for example, references
14735 to the host name:
14736 .code
14737 pid_file_path = /var/log/$primary_hostname/exim.pid
14738 .endd
14739 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14740 spool directory.
14741 The value set by the option can be overridden by the &%-oP%& command line
14742 option. A pid file is not written if a &"non-standard"& daemon is run by means
14743 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14744
14745
14746 .option pipelining_advertise_hosts main "host list&!!" *
14747 .cindex "PIPELINING" "suppressing advertising"
14748 This option can be used to suppress the advertisement of the SMTP
14749 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14750 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14751 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14752 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14753 that clients will use it; &"out of order"& commands that are &"expected"& do
14754 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14755
14756
14757 .option preserve_message_logs main boolean false
14758 .cindex "message logs" "preserving"
14759 If this option is set, message log files are not deleted when messages are
14760 completed. Instead, they are moved to a sub-directory of the spool directory
14761 called &_msglog.OLD_&, where they remain available for statistical or debugging
14762 purposes. This is a dangerous option to set on systems with any appreciable
14763 volume of mail. Use with care!
14764
14765
14766 .option primary_hostname main string "see below"
14767 .cindex "name" "of local host"
14768 .cindex "host" "name of local"
14769 .cindex "local host" "name of"
14770 .vindex "&$primary_hostname$&"
14771 This specifies the name of the current host. It is used in the default EHLO or
14772 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14773 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14774 The value is also used by default in some SMTP response messages from an Exim
14775 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14776
14777 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14778 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14779 contains only one component, Exim passes it to &[gethostbyname()]& (or
14780 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14781 version. The variable &$primary_hostname$& contains the host name, whether set
14782 explicitly by this option, or defaulted.
14783
14784
14785 .option print_topbitchars main boolean false
14786 .cindex "printing characters"
14787 .cindex "8-bit characters"
14788 By default, Exim considers only those characters whose codes lie in the range
14789 32&--126 to be printing characters. In a number of circumstances (for example,
14790 when writing log entries) non-printing characters are converted into escape
14791 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14792 is set, code values of 128 and above are also considered to be printing
14793 characters.
14794
14795 This option also affects the header syntax checks performed by the
14796 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14797 the user's full name when constructing From: and Sender: addresses (as
14798 described in section &<<SECTconstr>>&). Setting this option can cause
14799 Exim to generate eight bit message headers that do not conform to the
14800 standards.
14801
14802
14803 .option process_log_path main string unset
14804 .cindex "process log path"
14805 .cindex "log" "process log"
14806 .cindex "&'exiwhat'&"
14807 This option sets the name of the file to which an Exim process writes its
14808 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14809 utility script. If this option is unset, the file called &_exim-process.info_&
14810 in Exim's spool directory is used. The ability to specify the name explicitly
14811 can be useful in environments where two different Exims are running, using
14812 different spool directories.
14813
14814
14815 .option prod_requires_admin main boolean true
14816 .oindex "&%-M%&"
14817 .oindex "&%-R%&"
14818 .oindex "&%-q%&"
14819 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14820 admin user unless &%prod_requires_admin%& is set false. See also
14821 &%queue_list_requires_admin%&.
14822
14823
14824 .option qualify_domain main string "see below"
14825 .cindex "domain" "for qualifying addresses"
14826 .cindex "address" "qualification"
14827 This option specifies the domain name that is added to any envelope sender
14828 addresses that do not have a domain qualification. It also applies to
14829 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14830 are accepted by default only for locally-generated messages. Qualification is
14831 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14832 locally-generated messages, unless the &%-bnq%& command line option is used.
14833
14834 Messages from external sources must always contain fully qualified addresses,
14835 unless the sending host matches &%sender_unqualified_hosts%& or
14836 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14837 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14838 necessary. Internally, Exim always works with fully qualified envelope
14839 addresses. If &%qualify_domain%& is not set, it defaults to the
14840 &%primary_hostname%& value.
14841
14842
14843 .option qualify_recipient main string "see below"
14844 This option allows you to specify a different domain for qualifying recipient
14845 addresses to the one that is used for senders. See &%qualify_domain%& above.
14846
14847
14848
14849 .option queue_domains main "domain list&!!" unset
14850 .cindex "domain" "specifying non-immediate delivery"
14851 .cindex "queueing incoming messages"
14852 .cindex "message" "queueing certain domains"
14853 This option lists domains for which immediate delivery is not required.
14854 A delivery process is started whenever a message is received, but only those
14855 domains that do not match are processed. All other deliveries wait until the
14856 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14857
14858
14859 .option queue_list_requires_admin main boolean true
14860 .oindex "&%-bp%&"
14861 The &%-bp%& command-line option, which lists the messages that are on the
14862 queue, requires the caller to be an admin user unless
14863 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14864
14865
14866 .option queue_only main boolean false
14867 .cindex "queueing incoming messages"
14868 .cindex "message" "queueing unconditionally"
14869 If &%queue_only%& is set, a delivery process is not automatically started
14870 whenever a message is received. Instead, the message waits on the queue for the
14871 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14872 delivered immediately when certain conditions (such as heavy load) occur.
14873
14874 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14875 and &%-odi%& command line options override &%queue_only%& unless
14876 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14877 &%queue_only_load%&, and &%smtp_accept_queue%&.
14878
14879
14880 .option queue_only_file main string unset
14881 .cindex "queueing incoming messages"
14882 .cindex "message" "queueing by file existence"
14883 This option can be set to a colon-separated list of absolute path names, each
14884 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14885 it tests for the existence of each listed path using a call to &[stat()]&. For
14886 each path that exists, the corresponding queueing option is set.
14887 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14888 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14889 .code
14890 queue_only_file = smtp/some/file
14891 .endd
14892 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14893 &_/some/file_& exists.
14894
14895
14896 .option queue_only_load main fixed-point unset
14897 .cindex "load average"
14898 .cindex "queueing incoming messages"
14899 .cindex "message" "queueing by load"
14900 If the system load average is higher than this value, incoming messages from
14901 all sources are queued, and no automatic deliveries are started. If this
14902 happens during local or remote SMTP input, all subsequent messages received on
14903 the same SMTP connection are queued by default, whatever happens to the load in
14904 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14905 false.
14906
14907 Deliveries will subsequently be performed by queue runner processes. This
14908 option has no effect on ancient operating systems on which Exim cannot
14909 determine the load average. See also &%deliver_queue_load_max%& and
14910 &%smtp_load_reserve%&.
14911
14912
14913 .option queue_only_load_latch main boolean true
14914 .cindex "load average" "re-evaluating per message"
14915 When this option is true (the default), once one message has been queued
14916 because the load average is higher than the value set by &%queue_only_load%&,
14917 all subsequent messages received on the same SMTP connection are also queued.
14918 This is a deliberate choice; even though the load average may fall below the
14919 threshold, it doesn't seem right to deliver later messages on the same
14920 connection when not delivering earlier ones. However, there are special
14921 circumstances such as very long-lived connections from scanning appliances
14922 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14923 should be set false. This causes the value of the load average to be
14924 re-evaluated for each message.
14925
14926
14927 .option queue_only_override main boolean true
14928 .cindex "queueing incoming messages"
14929 When this option is true, the &%-od%&&'x'& command line options override the
14930 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14931 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14932 to override; they are accepted, but ignored.
14933
14934
14935 .option queue_run_in_order main boolean false
14936 .cindex "queue runner" "processing messages in order"
14937 If this option is set, queue runs happen in order of message arrival instead of
14938 in an arbitrary order. For this to happen, a complete list of the entire queue
14939 must be set up before the deliveries start. When the queue is all held in a
14940 single directory (the default), a single list is created for both the ordered
14941 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14942 single list is not created when &%queue_run_in_order%& is false. In this case,
14943 the sub-directories are processed one at a time (in a random order), and this
14944 avoids setting up one huge list for the whole queue. Thus, setting
14945 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14946 when the queue is large, because of the extra work in setting up the single,
14947 large list. In most situations, &%queue_run_in_order%& should not be set.
14948
14949
14950
14951 .option queue_run_max main integer 5
14952 .cindex "queue runner" "maximum number of"
14953 This controls the maximum number of queue runner processes that an Exim daemon
14954 can run simultaneously. This does not mean that it starts them all at once,
14955 but rather that if the maximum number are still running when the time comes to
14956 start another one, it refrains from starting another one. This can happen with
14957 very large queues and/or very sluggish deliveries. This option does not,
14958 however, interlock with other processes, so additional queue runners can be
14959 started by other means, or by killing and restarting the daemon.
14960
14961 Setting this option to zero does not suppress queue runs; rather, it disables
14962 the limit, allowing any number of simultaneous queue runner processes to be
14963 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14964 the daemon's command line.
14965
14966 .option queue_smtp_domains main "domain list&!!" unset
14967 .cindex "queueing incoming messages"
14968 .cindex "message" "queueing remote deliveries"
14969 When this option is set, a delivery process is started whenever a message is
14970 received, routing is performed, and local deliveries take place.
14971 However, if any SMTP deliveries are required for domains that match
14972 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14973 message waits on the queue for the next queue run. Since routing of the message
14974 has taken place, Exim knows to which remote hosts it must be delivered, and so
14975 when the queue run happens, multiple messages for the same host are delivered
14976 over a single SMTP connection. The &%-odqs%& command line option causes all
14977 SMTP deliveries to be queued in this way, and is equivalent to setting
14978 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14979 &%queue_domains%&.
14980
14981
14982 .option receive_timeout main time 0s
14983 .cindex "timeout" "for non-SMTP input"
14984 This option sets the timeout for accepting a non-SMTP message, that is, the
14985 maximum time that Exim waits when reading a message on the standard input. If
14986 the value is zero, it will wait for ever. This setting is overridden by the
14987 &%-or%& command line option. The timeout for incoming SMTP messages is
14988 controlled by &%smtp_receive_timeout%&.
14989
14990 .option received_header_text main string&!! "see below"
14991 .cindex "customizing" "&'Received:'& header"
14992 .cindex "&'Received:'& header line" "customizing"
14993 This string defines the contents of the &'Received:'& message header that is
14994 added to each message, except for the timestamp, which is automatically added
14995 on at the end (preceded by a semicolon). The string is expanded each time it is
14996 used. If the expansion yields an empty string, no &'Received:'& header line is
14997 added to the message. Otherwise, the string should start with the text
14998 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14999 header lines. The default setting is:
15000
15001 .code
15002 received_header_text = Received: \
15003   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15004   {${if def:sender_ident \
15005   {from ${quote_local_part:$sender_ident} }}\
15006   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15007   by $primary_hostname \
15008   ${if def:received_protocol {with $received_protocol}} \
15009   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15010   (Exim $version_number)\n\t\
15011   ${if def:sender_address \
15012   {(envelope-from <$sender_address>)\n\t}}\
15013   id $message_exim_id\
15014   ${if def:received_for {\n\tfor $received_for}}
15015 .endd
15016
15017 The reference to the TLS cipher is omitted when Exim is built without TLS
15018 support. The use of conditional expansions ensures that this works for both
15019 locally generated messages and messages received from remote hosts, giving
15020 header lines such as the following:
15021 .code
15022 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15023 by marley.carol.example with esmtp (Exim 4.00)
15024 (envelope-from <bob@carol.example>)
15025 id 16IOWa-00019l-00
15026 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15027 Received: by scrooge.carol.example with local (Exim 4.00)
15028 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15029 .endd
15030 Until the body of the message has been received, the timestamp is the time when
15031 the message started to be received. Once the body has arrived, and all policy
15032 checks have taken place, the timestamp is updated to the time at which the
15033 message was accepted.
15034
15035
15036 .option received_headers_max main integer 30
15037 .cindex "loop" "prevention"
15038 .cindex "mail loop prevention"
15039 .cindex "&'Received:'& header line" "counting"
15040 When a message is to be delivered, the number of &'Received:'& headers is
15041 counted, and if it is greater than this parameter, a mail loop is assumed to
15042 have occurred, the delivery is abandoned, and an error message is generated.
15043 This applies to both local and remote deliveries.
15044
15045
15046 .option recipient_unqualified_hosts main "host list&!!" unset
15047 .cindex "unqualified addresses"
15048 .cindex "host" "unqualified addresses from"
15049 This option lists those hosts from which Exim is prepared to accept unqualified
15050 recipient addresses in message envelopes. The addresses are made fully
15051 qualified by the addition of the &%qualify_recipient%& value. This option also
15052 affects message header lines. Exim does not reject unqualified recipient
15053 addresses in headers, but it qualifies them only if the message came from a
15054 host that matches &%recipient_unqualified_hosts%&,
15055 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15056 option was not set.
15057
15058
15059 .option recipients_max main integer 0
15060 .cindex "limit" "number of recipients"
15061 .cindex "recipient" "maximum number"
15062 If this option is set greater than zero, it specifies the maximum number of
15063 original recipients for any message. Additional recipients that are generated
15064 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15065 all recipients over the limit; earlier recipients are delivered as normal.
15066 Non-SMTP messages with too many recipients are failed, and no deliveries are
15067 done.
15068
15069 .cindex "RCPT" "maximum number of incoming"
15070 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15071 RCPT commands in a single message.
15072
15073
15074 .option recipients_max_reject main boolean false
15075 If this option is set true, Exim rejects SMTP messages containing too many
15076 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15077 error to the eventual DATA command. Otherwise (the default) it gives a 452
15078 error to the surplus RCPT commands and accepts the message on behalf of the
15079 initial set of recipients. The remote server should then re-send the message
15080 for the remaining recipients at a later time.
15081
15082
15083 .option remote_max_parallel main integer 2
15084 .cindex "delivery" "parallelism for remote"
15085 This option controls parallel delivery of one message to a number of remote
15086 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15087 does all the remote deliveries for a message one by one. Otherwise, if a single
15088 message has to be delivered to more than one remote host, or if several copies
15089 have to be sent to the same remote host, up to &%remote_max_parallel%&
15090 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15091 deliveries are required, the maximum number of processes are started, and as
15092 each one finishes, another is begun. The order of starting processes is the
15093 same as if sequential delivery were being done, and can be controlled by the
15094 &%remote_sort_domains%& option. If parallel delivery takes place while running
15095 with debugging turned on, the debugging output from each delivery process is
15096 tagged with its process id.
15097
15098 This option controls only the maximum number of parallel deliveries for one
15099 message in one Exim delivery process. Because Exim has no central queue
15100 manager, there is no way of controlling the total number of simultaneous
15101 deliveries if the configuration allows a delivery attempt as soon as a message
15102 is received.
15103
15104 .cindex "number of deliveries"
15105 .cindex "delivery" "maximum number of"
15106 If you want to control the total number of deliveries on the system, you
15107 need to set the &%queue_only%& option. This ensures that all incoming messages
15108 are added to the queue without starting a delivery process. Then set up an Exim
15109 daemon to start queue runner processes at appropriate intervals (probably
15110 fairly often, for example, every minute), and limit the total number of queue
15111 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15112 delivers only one message at a time, the maximum number of deliveries that can
15113 then take place at once is &%queue_run_max%& multiplied by
15114 &%remote_max_parallel%&.
15115
15116 If it is purely remote deliveries you want to control, use
15117 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15118 doing the SMTP routing before queueing, so that several messages for the same
15119 host will eventually get delivered down the same connection.
15120
15121
15122 .option remote_sort_domains main "domain list&!!" unset
15123 .cindex "sorting remote deliveries"
15124 .cindex "delivery" "sorting remote"
15125 When there are a number of remote deliveries for a message, they are sorted by
15126 domain into the order given by this list. For example,
15127 .code
15128 remote_sort_domains = *.cam.ac.uk:*.uk
15129 .endd
15130 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15131 then to those in the &%uk%& domain, then to any others.
15132
15133
15134 .option retry_data_expire main time 7d
15135 .cindex "hints database" "data expiry"
15136 This option sets a &"use before"& time on retry information in Exim's hints
15137 database. Any older retry data is ignored. This means that, for example, once a
15138 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15139 past failures.
15140
15141
15142 .option retry_interval_max main time 24h
15143 .cindex "retry" "limit on interval"
15144 .cindex "limit" "on retry interval"
15145 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15146 intervals between delivery attempts for messages that cannot be delivered
15147 straight away. This option sets an overall limit to the length of time between
15148 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15149 the default value.
15150
15151
15152 .option return_path_remove main boolean true
15153 .cindex "&'Return-path:'& header line" "removing"
15154 RFC 2821, section 4.4, states that an SMTP server must insert a
15155 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15156 The &'Return-path:'& header preserves the sender address as received in the
15157 MAIL command. This description implies that this header should not be present
15158 in an incoming message. If &%return_path_remove%& is true, any existing
15159 &'Return-path:'& headers are removed from messages at the time they are
15160 received. Exim's transports have options for adding &'Return-path:'& headers at
15161 the time of delivery. They are normally used only for final local deliveries.
15162
15163
15164 .option return_size_limit main integer 100K
15165 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15166
15167
15168 .option rfc1413_hosts main "host list&!!" *
15169 .cindex "RFC 1413"
15170 .cindex "host" "for RFC 1413 calls"
15171 RFC 1413 identification calls are made to any client host which matches an item
15172 in the list.
15173
15174 .option rfc1413_query_timeout main time 5s
15175 .cindex "RFC 1413" "query timeout"
15176 .cindex "timeout" "for RFC 1413 call"
15177 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15178 no RFC 1413 calls are ever made.
15179
15180
15181 .option sender_unqualified_hosts main "host list&!!" unset
15182 .cindex "unqualified addresses"
15183 .cindex "host" "unqualified addresses from"
15184 This option lists those hosts from which Exim is prepared to accept unqualified
15185 sender addresses. The addresses are made fully qualified by the addition of
15186 &%qualify_domain%&. This option also affects message header lines. Exim does
15187 not reject unqualified addresses in headers that contain sender addresses, but
15188 it qualifies them only if the message came from a host that matches
15189 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15190 using TCP/IP), and the &%-bnq%& option was not set.
15191
15192
15193 .option smtp_accept_keepalive main boolean true
15194 .cindex "keepalive" "on incoming connection"
15195 This option controls the setting of the SO_KEEPALIVE option on incoming
15196 TCP/IP socket connections. When set, it causes the kernel to probe idle
15197 connections periodically, by sending packets with &"old"& sequence numbers. The
15198 other end of the connection should send an acknowledgment if the connection is
15199 still okay or a reset if the connection has been aborted. The reason for doing
15200 this is that it has the beneficial effect of freeing up certain types of
15201 connection that can get stuck when the remote host is disconnected without
15202 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15203 hours to detect unreachable hosts.
15204
15205
15206
15207 .option smtp_accept_max main integer 20
15208 .cindex "limit" "incoming SMTP connections"
15209 .cindex "SMTP" "incoming connection count"
15210 .cindex "inetd"
15211 This option specifies the maximum number of simultaneous incoming SMTP calls
15212 that Exim will accept. It applies only to the listening daemon; there is no
15213 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15214 value is set to zero, no limit is applied. However, it is required to be
15215 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15216 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15217
15218 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15219 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15220 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15221 and &%smtp_load_reserve%& are then checked before accepting the connection.
15222
15223
15224 .option smtp_accept_max_nonmail main integer 10
15225 .cindex "limit" "non-mail SMTP commands"
15226 .cindex "SMTP" "limiting non-mail commands"
15227 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15228 the connection if there are too many. This option defines &"too many"&. The
15229 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15230 client looping sending EHLO, for example. The check is applied only if the
15231 client host matches &%smtp_accept_max_nonmail_hosts%&.
15232
15233 When a new message is expected, one occurrence of RSET is not counted. This
15234 allows a client to send one RSET between messages (this is not necessary,
15235 but some clients do it). Exim also allows one uncounted occurrence of HELO
15236 or EHLO, and one occurrence of STARTTLS between messages. After
15237 starting up a TLS session, another EHLO is expected, and so it too is not
15238 counted. The first occurrence of AUTH in a connection, or immediately
15239 following STARTTLS is not counted. Otherwise, all commands other than
15240 MAIL, RCPT, DATA, and QUIT are counted.
15241
15242
15243 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15244 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15245 check by setting this option. The default value makes it apply to all hosts. By
15246 changing the value, you can exclude any badly-behaved hosts that you have to
15247 live with.
15248
15249
15250 . Allow this long option name to split; give it unsplit as a fifth argument
15251 . for the automatic .oindex that is generated by .option.
15252
15253 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15254          smtp_accept_max_per_connection
15255 .cindex "SMTP" "limiting incoming message count"
15256 .cindex "limit" "messages per SMTP connection"
15257 The value of this option limits the number of MAIL commands that Exim is
15258 prepared to accept over a single SMTP connection, whether or not each command
15259 results in the transfer of a message. After the limit is reached, a 421
15260 response is given to subsequent MAIL commands. This limit is a safety
15261 precaution against a client that goes mad (incidents of this type have been
15262 seen).
15263
15264
15265 .option smtp_accept_max_per_host main string&!! unset
15266 .cindex "limit" "SMTP connections from one host"
15267 .cindex "host" "limiting SMTP connections from"
15268 This option restricts the number of simultaneous IP connections from a single
15269 host (strictly, from a single IP address) to the Exim daemon. The option is
15270 expanded, to enable different limits to be applied to different hosts by
15271 reference to &$sender_host_address$&. Once the limit is reached, additional
15272 connection attempts from the same host are rejected with error code 421. This
15273 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15274 of zero imposes no limit. If this option is set greater than zero, it is
15275 required that &%smtp_accept_max%& be non-zero.
15276
15277 &*Warning*&: When setting this option you should not use any expansion
15278 constructions that take an appreciable amount of time. The expansion and test
15279 happen in the main daemon loop, in order to reject additional connections
15280 without forking additional processes (otherwise a denial-of-service attack
15281 could cause a vast number or processes to be created). While the daemon is
15282 doing this processing, it cannot accept any other incoming connections.
15283
15284
15285
15286 .option smtp_accept_queue main integer 0
15287 .cindex "SMTP" "incoming connection count"
15288 .cindex "queueing incoming messages"
15289 .cindex "message" "queueing by SMTP connection count"
15290 If the number of simultaneous incoming SMTP connections being handled via the
15291 listening daemon exceeds this value, messages received by SMTP are just placed
15292 on the queue; no delivery processes are started automatically. The count is
15293 fixed at the start of an SMTP connection. It cannot be updated in the
15294 subprocess that receives messages, and so the queueing or not queueing applies
15295 to all messages received in the same connection.
15296
15297 A value of zero implies no limit, and clearly any non-zero value is useful only
15298 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15299 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15300 various &%-od%&&'x'& command line options.
15301
15302
15303 . Allow this long option name to split; give it unsplit as a fifth argument
15304 . for the automatic .oindex that is generated by .option.
15305
15306 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
15307          smtp_accept_queue_per_connection
15308 .cindex "queueing incoming messages"
15309 .cindex "message" "queueing by message count"
15310 This option limits the number of delivery processes that Exim starts
15311 automatically when receiving messages via SMTP, whether via the daemon or by
15312 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15313 and the number of messages received in a single SMTP session exceeds this
15314 number, subsequent messages are placed on the queue, but no delivery processes
15315 are started. This helps to limit the number of Exim processes when a server
15316 restarts after downtime and there is a lot of mail waiting for it on other
15317 systems. On large systems, the default should probably be increased, and on
15318 dial-in client systems it should probably be set to zero (that is, disabled).
15319
15320
15321 .option smtp_accept_reserve main integer 0
15322 .cindex "SMTP" "incoming call count"
15323 .cindex "host" "reserved"
15324 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15325 number of SMTP connections that are reserved for connections from the hosts
15326 that are specified in &%smtp_reserve_hosts%&. The value set in
15327 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15328 restricted to this number of connections; the option specifies a minimum number
15329 of connection slots for them, not a maximum. It is a guarantee that this group
15330 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15331 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15332 individual host.
15333
15334 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15335 set to 5, once there are 45 active connections (from any hosts), new
15336 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15337 provided the other criteria for acceptance are met.
15338
15339
15340 .option smtp_active_hostname main string&!! unset
15341 .cindex "host" "name in SMTP responses"
15342 .cindex "SMTP" "host name in responses"
15343 .vindex "&$primary_hostname$&"
15344 This option is provided for multi-homed servers that want to masquerade as
15345 several different hosts. At the start of an incoming SMTP connection, its value
15346 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15347 responses. For example, it is used as domain name in the response to an
15348 incoming HELO or EHLO command.
15349
15350 .vindex "&$smtp_active_hostname$&"
15351 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15352 is saved with any messages that are received. It is therefore available for use
15353 in routers and transports when the message is later delivered.
15354
15355 If this option is unset, or if its expansion is forced to fail, or if the
15356 expansion results in an empty string, the value of &$primary_hostname$& is
15357 used. Other expansion failures cause a message to be written to the main and
15358 panic logs, and the SMTP command receives a temporary error. Typically, the
15359 value of &%smtp_active_hostname%& depends on the incoming interface address.
15360 For example:
15361 .code
15362 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15363   {cox.mydomain}{box.mydomain}}
15364 .endd
15365
15366 Although &$smtp_active_hostname$& is primarily concerned with incoming
15367 messages, it is also used as the default for HELO commands in callout
15368 verification if there is no remote transport from which to obtain a
15369 &%helo_data%& value.
15370
15371 .option smtp_banner main string&!! "see below"
15372 .cindex "SMTP" "welcome banner"
15373 .cindex "banner for SMTP"
15374 .cindex "welcome banner for SMTP"
15375 .cindex "customizing" "SMTP banner"
15376 This string, which is expanded every time it is used, is output as the initial
15377 positive response to an SMTP connection. The default setting is:
15378 .code
15379 smtp_banner = $smtp_active_hostname ESMTP Exim \
15380   $version_number $tod_full
15381 .endd
15382 Failure to expand the string causes a panic error. If you want to create a
15383 multiline response to the initial SMTP connection, use &"\n"& in the string at
15384 appropriate points, but not at the end. Note that the 220 code is not included
15385 in this string. Exim adds it automatically (several times in the case of a
15386 multiline response).
15387
15388
15389 .option smtp_check_spool_space main boolean true
15390 .cindex "checking disk space"
15391 .cindex "disk space, checking"
15392 .cindex "spool directory" "checking space"
15393 When this option is set, if an incoming SMTP session encounters the SIZE
15394 option on a MAIL command, it checks that there is enough space in the
15395 spool directory's partition to accept a message of that size, while still
15396 leaving free the amount specified by &%check_spool_space%& (even if that value
15397 is zero). If there isn't enough space, a temporary error code is returned.
15398
15399
15400 .option smtp_connect_backlog main integer 20
15401 .cindex "connection backlog"
15402 .cindex "SMTP" "connection backlog"
15403 .cindex "backlog of connections"
15404 This option specifies a maximum number of waiting SMTP connections. Exim passes
15405 this value to the TCP/IP system when it sets up its listener. Once this number
15406 of connections are waiting for the daemon's attention, subsequent connection
15407 attempts are refused at the TCP/IP level. At least, that is what the manuals
15408 say; in some circumstances such connection attempts have been observed to time
15409 out instead. For large systems it is probably a good idea to increase the
15410 value (to 50, say). It also gives some protection against denial-of-service
15411 attacks by SYN flooding.
15412
15413
15414 .option smtp_enforce_sync main boolean true
15415 .cindex "SMTP" "synchronization checking"
15416 .cindex "synchronization checking in SMTP"
15417 The SMTP protocol specification requires the client to wait for a response from
15418 the server at certain points in the dialogue. Without PIPELINING these
15419 synchronization points are after every command; with PIPELINING they are
15420 fewer, but they still exist.
15421
15422 Some spamming sites send out a complete set of SMTP commands without waiting
15423 for any response. Exim protects against this by rejecting a message if the
15424 client has sent further input when it should not have. The error response &"554
15425 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15426 for this error cannot be perfect because of transmission delays (unexpected
15427 input may be on its way but not yet received when Exim checks). However, it
15428 does detect many instances.
15429
15430 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15431 If you want to disable the check selectively (for example, only for certain
15432 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15433 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15434
15435
15436
15437 .option smtp_etrn_command main string&!! unset
15438 .cindex "ETRN" "command to be run"
15439 .vindex "&$domain$&"
15440 If this option is set, the given command is run whenever an SMTP ETRN
15441 command is received from a host that is permitted to issue such commands (see
15442 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15443 are independently expanded. The expansion variable &$domain$& is set to the
15444 argument of the ETRN command, and no syntax checking is done on it. For
15445 example:
15446 .code
15447 smtp_etrn_command = /etc/etrn_command $domain \
15448                     $sender_host_address
15449 .endd
15450 A new process is created to run the command, but Exim does not wait for it to
15451 complete. Consequently, its status cannot be checked. If the command cannot be
15452 run, a line is written to the panic log, but the ETRN caller still receives
15453 a 250 success response. Exim is normally running under its own uid when
15454 receiving SMTP, so it is not possible for it to change the uid before running
15455 the command.
15456
15457
15458 .option smtp_etrn_serialize main boolean true
15459 .cindex "ETRN" "serializing"
15460 When this option is set, it prevents the simultaneous execution of more than
15461 one identical command as a result of ETRN in an SMTP connection. See
15462 section &<<SECTETRN>>& for details.
15463
15464
15465 .option smtp_load_reserve main fixed-point unset
15466 .cindex "load average"
15467 If the system load average ever gets higher than this, incoming SMTP calls are
15468 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15469 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15470 the load is over the limit. The option has no effect on ancient operating
15471 systems on which Exim cannot determine the load average. See also
15472 &%deliver_queue_load_max%& and &%queue_only_load%&.
15473
15474
15475
15476 .option smtp_max_synprot_errors main integer 3
15477 .cindex "SMTP" "limiting syntax and protocol errors"
15478 .cindex "limit" "SMTP syntax and protocol errors"
15479 Exim rejects SMTP commands that contain syntax or protocol errors. In
15480 particular, a syntactically invalid email address, as in this command:
15481 .code
15482 RCPT TO:<abc xyz@a.b.c>
15483 .endd
15484 causes immediate rejection of the command, before any other tests are done.
15485 (The ACL cannot be run if there is no valid address to set up for it.) An
15486 example of a protocol error is receiving RCPT before MAIL. If there are
15487 too many syntax or protocol errors in one SMTP session, the connection is
15488 dropped. The limit is set by this option.
15489
15490 .cindex "PIPELINING" "expected errors"
15491 When the PIPELINING extension to SMTP is in use, some protocol errors are
15492 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15493 Exim assumes that PIPELINING will be used if it advertises it (see
15494 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15495 not count towards the limit.
15496
15497
15498
15499 .option smtp_max_unknown_commands main integer 3
15500 .cindex "SMTP" "limiting unknown commands"
15501 .cindex "limit" "unknown SMTP commands"
15502 If there are too many unrecognized commands in an incoming SMTP session, an
15503 Exim server drops the connection. This is a defence against some kinds of abuse
15504 that subvert web
15505 clients
15506 into making connections to SMTP ports; in these circumstances, a number of
15507 non-SMTP command lines are sent first.
15508
15509
15510
15511 .option smtp_ratelimit_hosts main "host list&!!" unset
15512 .cindex "SMTP" "rate limiting"
15513 .cindex "limit" "rate of message arrival"
15514 .cindex "RCPT" "rate limiting"
15515 Some sites find it helpful to be able to limit the rate at which certain hosts
15516 can send them messages, and the rate at which an individual message can specify
15517 recipients.
15518
15519 Exim has two rate-limiting facilities. This section describes the older
15520 facility, which can limit rates within a single connection. The newer
15521 &%ratelimit%& ACL condition can limit rates across all connections. See section
15522 &<<SECTratelimiting>>& for details of the newer facility.
15523
15524 When a host matches &%smtp_ratelimit_hosts%&, the values of
15525 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15526 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15527 respectively. Each option, if set, must contain a set of four comma-separated
15528 values:
15529
15530 .ilist
15531 A threshold, before which there is no rate limiting.
15532 .next
15533 An initial time delay. Unlike other times in Exim, numbers with decimal
15534 fractional parts are allowed here.
15535 .next
15536 A factor by which to increase the delay each time.
15537 .next
15538 A maximum value for the delay. This should normally be less than 5 minutes,
15539 because after that time, the client is liable to timeout the SMTP command.
15540 .endlist
15541
15542 For example, these settings have been used successfully at the site which
15543 first suggested this feature, for controlling mail from their customers:
15544 .code
15545 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15546 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15547 .endd
15548 The first setting specifies delays that are applied to MAIL commands after
15549 two have been received over a single connection. The initial delay is 0.5
15550 seconds, increasing by a factor of 1.05 each time. The second setting applies
15551 delays to RCPT commands when more than four occur in a single message.
15552
15553
15554 .option smtp_ratelimit_mail main string unset
15555 See &%smtp_ratelimit_hosts%& above.
15556
15557
15558 .option smtp_ratelimit_rcpt main string unset
15559 See &%smtp_ratelimit_hosts%& above.
15560
15561
15562 .option smtp_receive_timeout main time 5m
15563 .cindex "timeout" "for SMTP input"
15564 .cindex "SMTP" "input timeout"
15565 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15566 input, including batch SMTP. If a line of input (either an SMTP command or a
15567 data line) is not received within this time, the SMTP connection is dropped and
15568 the message is abandoned.
15569 A line is written to the log containing one of the following messages:
15570 .code
15571 SMTP command timeout on connection from...
15572 SMTP data timeout on connection from...
15573 .endd
15574 The former means that Exim was expecting to read an SMTP command; the latter
15575 means that it was in the DATA phase, reading the contents of a message.
15576
15577
15578 .oindex "&%-os%&"
15579 The value set by this option can be overridden by the
15580 &%-os%& command-line option. A setting of zero time disables the timeout, but
15581 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15582 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15583 timeout is controlled by &%receive_timeout%& and &%-or%&.
15584
15585
15586 .option smtp_reserve_hosts main "host list&!!" unset
15587 This option defines hosts for which SMTP connections are reserved; see
15588 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15589
15590
15591 .option smtp_return_error_details main boolean false
15592 .cindex "SMTP" "details policy failures"
15593 .cindex "policy control" "rejection, returning details"
15594 In the default state, Exim uses bland messages such as
15595 &"Administrative prohibition"& when it rejects SMTP commands for policy
15596 reasons. Many sysadmins like this because it gives away little information
15597 to spammers. However, some other sysadmins who are applying strict checking
15598 policies want to give out much fuller information about failures. Setting
15599 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15600 example, instead of &"Administrative prohibition"&, it might give:
15601 .code
15602 550-Rejected after DATA: '>' missing at end of address:
15603 550 failing address in "From" header is: <user@dom.ain
15604 .endd
15605
15606 .option spamd_address main string "see below"
15607 This option is available when Exim is compiled with the content-scanning
15608 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15609 The default value is
15610 .code
15611 127.0.0.1 783
15612 .endd
15613 See section &<<SECTscanspamass>>& for more details.
15614
15615
15616
15617 .option split_spool_directory main boolean false
15618 .cindex "multiple spool directories"
15619 .cindex "spool directory" "split"
15620 .cindex "directories, multiple"
15621 If this option is set, it causes Exim to split its input directory into 62
15622 subdirectories, each with a single alphanumeric character as its name. The
15623 sixth character of the message id is used to allocate messages to
15624 subdirectories; this is the least significant base-62 digit of the time of
15625 arrival of the message.
15626
15627 Splitting up the spool in this way may provide better performance on systems
15628 where there are long mail queues, by reducing the number of files in any one
15629 directory. The msglog directory is also split up in a similar way to the input
15630 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15631 are still placed in the single directory &_msglog.OLD_&.
15632
15633 It is not necessary to take any special action for existing messages when
15634 changing &%split_spool_directory%&. Exim notices messages that are in the
15635 &"wrong"& place, and continues to process them. If the option is turned off
15636 after a period of being on, the subdirectories will eventually empty and be
15637 automatically deleted.
15638
15639 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15640 changes. Instead of creating a list of all messages in the queue, and then
15641 trying to deliver each one in turn, it constructs a list of those in one
15642 sub-directory and tries to deliver them, before moving on to the next
15643 sub-directory. The sub-directories are processed in a random order. This
15644 spreads out the scanning of the input directories, and uses less memory. It is
15645 particularly beneficial when there are lots of messages on the queue. However,
15646 if &%queue_run_in_order%& is set, none of this new processing happens. The
15647 entire queue has to be scanned and sorted before any deliveries can start.
15648
15649
15650 .option spool_directory main string&!! "set at compile time"
15651 .cindex "spool directory" "path to"
15652 This defines the directory in which Exim keeps its spool, that is, the messages
15653 it is waiting to deliver. The default value is taken from the compile-time
15654 configuration setting, if there is one. If not, this option must be set. The
15655 string is expanded, so it can contain, for example, a reference to
15656 &$primary_hostname$&.
15657
15658 If the spool directory name is fixed on your installation, it is recommended
15659 that you set it at build time rather than from this option, particularly if the
15660 log files are being written to the spool directory (see &%log_file_path%&).
15661 Otherwise log files cannot be used for errors that are detected early on, such
15662 as failures in the configuration file.
15663
15664 By using this option to override the compiled-in path, it is possible to run
15665 tests of Exim without using the standard spool.
15666
15667 .option sqlite_lock_timeout main time 5s
15668 .cindex "sqlite lookup type" "lock timeout"
15669 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15670 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15671
15672 .option strict_acl_vars main boolean false
15673 .cindex "&ACL;" "variables, handling unset"
15674 This option controls what happens if a syntactically valid but undefined ACL
15675 variable is referenced. If it is false (the default), an empty string
15676 is substituted; if it is true, an error is generated. See section
15677 &<<SECTaclvariables>>& for details of ACL variables.
15678
15679 .option strip_excess_angle_brackets main boolean false
15680 .cindex "angle brackets, excess"
15681 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15682 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15683 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15684 passed on to another MTA, the excess angle brackets are not passed on. If this
15685 option is not set, multiple pairs of angle brackets cause a syntax error.
15686
15687
15688 .option strip_trailing_dot main boolean false
15689 .cindex "trailing dot on domain"
15690 .cindex "dot" "trailing on domain"
15691 If this option is set, a trailing dot at the end of a domain in an address is
15692 ignored. If this is in the envelope and the message is passed on to another
15693 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15694 domain causes a syntax error.
15695 However, addresses in header lines are checked only when an ACL requests header
15696 syntax checking.
15697
15698
15699 .option syslog_duplication main boolean true
15700 .cindex "syslog" "duplicate log lines; suppressing"
15701 When Exim is logging to syslog, it writes the log lines for its three
15702 separate logs at different syslog priorities so that they can in principle
15703 be separated on the logging hosts. Some installations do not require this
15704 separation, and in those cases, the duplication of certain log lines is a
15705 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15706 particular log line is written to syslog. For lines that normally go to
15707 both the main log and the reject log, the reject log version (possibly
15708 containing message header lines) is written, at LOG_NOTICE priority.
15709 Lines that normally go to both the main and the panic log are written at
15710 the LOG_ALERT priority.
15711
15712
15713 .option syslog_facility main string unset
15714 .cindex "syslog" "facility; setting"
15715 This option sets the syslog &"facility"& name, used when Exim is logging to
15716 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15717 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15718 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15719 details of Exim's logging.
15720
15721
15722
15723 .option syslog_processname main string &`exim`&
15724 .cindex "syslog" "process name; setting"
15725 This option sets the syslog &"ident"& name, used when Exim is logging to
15726 syslog. The value must be no longer than 32 characters. See chapter
15727 &<<CHAPlog>>& for details of Exim's logging.
15728
15729
15730
15731 .option syslog_timestamp main boolean true
15732 .cindex "syslog" "timestamps"
15733 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15734 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15735 details of Exim's logging.
15736
15737
15738 .option system_filter main string&!! unset
15739 .cindex "filter" "system filter"
15740 .cindex "system filter" "specifying"
15741 .cindex "Sieve filter" "not available for system filter"
15742 This option specifies an Exim filter file that is applied to all messages at
15743 the start of each delivery attempt, before any routing is done. System filters
15744 must be Exim filters; they cannot be Sieve filters. If the system filter
15745 generates any deliveries to files or pipes, or any new mail messages, the
15746 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15747 which transports are to be used. Details of this facility are given in chapter
15748 &<<CHAPsystemfilter>>&.
15749
15750
15751 .option system_filter_directory_transport main string&!! unset
15752 .vindex "&$address_file$&"
15753 This sets the name of the transport driver that is to be used when the
15754 &%save%& command in a system message filter specifies a path ending in &"/"&,
15755 implying delivery of each message into a separate file in some directory.
15756 During the delivery, the variable &$address_file$& contains the path name.
15757
15758
15759 .option system_filter_file_transport main string&!! unset
15760 .cindex "file" "transport for system filter"
15761 This sets the name of the transport driver that is to be used when the &%save%&
15762 command in a system message filter specifies a path not ending in &"/"&. During
15763 the delivery, the variable &$address_file$& contains the path name.
15764
15765 .option system_filter_group main string unset
15766 .cindex "gid (group id)" "system filter"
15767 This option is used only when &%system_filter_user%& is also set. It sets the
15768 gid under which the system filter is run, overriding any gid that is associated
15769 with the user. The value may be numerical or symbolic.
15770
15771 .option system_filter_pipe_transport main string&!! unset
15772 .cindex "&(pipe)& transport" "for system filter"
15773 .vindex "&$address_pipe$&"
15774 This specifies the transport driver that is to be used when a &%pipe%& command
15775 is used in a system filter. During the delivery, the variable &$address_pipe$&
15776 contains the pipe command.
15777
15778
15779 .option system_filter_reply_transport main string&!! unset
15780 .cindex "&(autoreply)& transport" "for system filter"
15781 This specifies the transport driver that is to be used when a &%mail%& command
15782 is used in a system filter.
15783
15784
15785 .option system_filter_user main string unset
15786 .cindex "uid (user id)" "system filter"
15787 If this option is set to root, the system filter is run in the main Exim
15788 delivery process, as root.  Otherwise, the system filter runs in a separate
15789 process, as the given user, defaulting to the Exim run-time user.
15790 Unless the string consists entirely of digits, it
15791 is looked up in the password data. Failure to find the named user causes a
15792 configuration error. The gid is either taken from the password data, or
15793 specified by &%system_filter_group%&. When the uid is specified numerically,
15794 &%system_filter_group%& is required to be set.
15795
15796 If the system filter generates any pipe, file, or reply deliveries, the uid
15797 under which the filter is run is used when transporting them, unless a
15798 transport option overrides.
15799
15800
15801 .option tcp_nodelay main boolean true
15802 .cindex "daemon" "TCP_NODELAY on sockets"
15803 .cindex "Nagle algorithm"
15804 .cindex "TCP_NODELAY on listening sockets"
15805 If this option is set false, it stops the Exim daemon setting the
15806 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15807 turns off the &"Nagle algorithm"&, which is a way of improving network
15808 performance in interactive (character-by-character) situations. Turning it off
15809 should improve Exim's performance a bit, so that is what happens by default.
15810 However, it appears that some broken clients cannot cope, and time out. Hence
15811 this option. It affects only those sockets that are set up for listening by the
15812 daemon. Sockets created by the smtp transport for delivering mail always set
15813 TCP_NODELAY.
15814
15815
15816 .option timeout_frozen_after main time 0s
15817 .cindex "frozen messages" "timing out"
15818 .cindex "timeout" "frozen messages"
15819 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15820 message of any kind that has been on the queue for longer than the given time
15821 is automatically cancelled at the next queue run. If the frozen message is a
15822 bounce message, it is just discarded; otherwise, a bounce is sent to the
15823 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15824 If you want to timeout frozen bounce messages earlier than other kinds of
15825 frozen message, see &%ignore_bounce_errors_after%&.
15826
15827 &*Note:*& the default value of zero means no timeouts; with this setting,
15828 frozen messages remain on the queue forever (except for any frozen bounce
15829 messages that are released by &%ignore_bounce_errors_after%&).
15830
15831
15832 .option timezone main string unset
15833 .cindex "timezone, setting"
15834 The value of &%timezone%& is used to set the environment variable TZ while
15835 running Exim (if it is different on entry). This ensures that all timestamps
15836 created by Exim are in the required timezone. If you want all your timestamps
15837 to be in UTC (aka GMT) you should set
15838 .code
15839 timezone = UTC
15840 .endd
15841 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15842 or, if that is not set, from the value of the TZ environment variable when Exim
15843 is built. If &%timezone%& is set to the empty string, either at build or run
15844 time, any existing TZ variable is removed from the environment when Exim
15845 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15846 unfortunately not all, operating systems.
15847
15848
15849 .option tls_advertise_hosts main "host list&!!" unset
15850 .cindex "TLS" "advertising"
15851 .cindex "encryption" "on SMTP connection"
15852 .cindex "SMTP" "encrypted connection"
15853 When Exim is built with support for TLS encrypted connections, the availability
15854 of the STARTTLS command to set up an encrypted session is advertised in
15855 response to EHLO only to those client hosts that match this option. See
15856 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15857
15858
15859 .option tls_certificate main string&!! unset
15860 .cindex "TLS" "server certificate; location of"
15861 .cindex "certificate" "server, location of"
15862 The value of this option is expanded, and must then be the absolute path to a
15863 file which contains the server's certificates. The server's private key is also
15864 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15865 &<<CHAPTLS>>& for further details.
15866
15867 &*Note*&: The certificates defined by this option are used only when Exim is
15868 receiving incoming messages as a server. If you want to supply certificates for
15869 use when sending messages as a client, you must set the &%tls_certificate%&
15870 option in the relevant &(smtp)& transport.
15871
15872 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
15873 if the OpenSSL build supports TLS extensions and the TLS client sends the
15874 Server Name Indication extension, then this option and others documented in
15875 &<<SECTtlssni>>& will be re-expanded.
15876
15877 .option tls_crl main string&!! unset
15878 .cindex "TLS" "server certificate revocation list"
15879 .cindex "certificate" "revocation list for server"
15880 This option specifies a certificate revocation list. The expanded value must
15881 be the name of a file that contains a CRL in PEM format.
15882
15883 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15884
15885
15886 .option tls_dh_max_bits main integer 2236
15887 .cindex "TLS" "D-H bit count"
15888 The number of bits used for Diffie-Hellman key-exchange may be suggested by
15889 the chosen TLS library.  That value might prove to be too high for
15890 interoperability.  This option provides a maximum clamp on the value
15891 suggested, trading off security for interoperability.
15892
15893 The value must be at least 1024.
15894
15895 The value 2236 was chosen because, at time of adding the option, it was the
15896 hard-coded maximum value supported by the NSS cryptographic library, as used
15897 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
15898
15899 If you prefer more security and are willing to break some clients, raise this
15900 number.
15901
15902 Note that the value passed to GnuTLS for *generating* a new prime may be a
15903 little less than this figure, because GnuTLS is inexact and may produce a
15904 larger prime than requested.
15905
15906
15907 .option tls_dhparam main string&!! unset
15908 .cindex "TLS" "D-H parameters for server"
15909 The value of this option is expanded and indicates the source of DH parameters
15910 to be used by Exim.
15911
15912 If it is a filename starting with a &`/`&, then it names a file from which DH
15913 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
15914 PKCS#3 representation of the DH prime.  If the file does not exist, for
15915 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
15916 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
15917 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
15918 and treated as though the &%tls_dhparam%& were set to "none".
15919
15920 If this option expands to the string "none", then no DH parameters will be
15921 loaded by Exim.
15922
15923 If this option expands to the string "historic" and Exim is using GnuTLS, then
15924 Exim will attempt to load a file from inside the spool directory.  If the file
15925 does not exist, Exim will attempt to create it.
15926 See section &<<SECTgnutlsparam>>& for further details.
15927
15928 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
15929 a default DH prime; the default is the 2048 bit prime described in section
15930 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
15931 in IKE is assigned number 23.
15932
15933 Otherwise, the option must expand to the name used by Exim for any of a number
15934 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
15935 "ike" followed by the number used by IKE, of "default" which corresponds to
15936 "ike23".
15937
15938 The available primes are:
15939 &`ike1`&, &`ike2`&, &`ike5`&,
15940 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
15941 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
15942
15943 Some of these will be too small to be accepted by clients.
15944 Some may be too large to be accepted by clients.
15945
15946
15947 .option tls_on_connect_ports main "string list" unset
15948 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15949 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15950 set up without waiting for the client to issue a STARTTLS command. For
15951 further details, see section &<<SECTsupobssmt>>&.
15952
15953
15954
15955 .option tls_privatekey main string&!! unset
15956 .cindex "TLS" "server private key; location of"
15957 The value of this option is expanded, and must then be the absolute path to a
15958 file which contains the server's private key. If this option is unset, or if
15959 the expansion is forced to fail, or the result is an empty string, the private
15960 key is assumed to be in the same file as the server's certificates. See chapter
15961 &<<CHAPTLS>>& for further details.
15962
15963 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15964
15965
15966 .option tls_remember_esmtp main boolean false
15967 .cindex "TLS" "esmtp state; remembering"
15968 .cindex "TLS" "broken clients"
15969 If this option is set true, Exim violates the RFCs by remembering that it is in
15970 &"esmtp"& state after successfully negotiating a TLS session. This provides
15971 support for broken clients that fail to send a new EHLO after starting a
15972 TLS session.
15973
15974
15975 .option tls_require_ciphers main string&!! unset
15976 .cindex "TLS" "requiring specific ciphers"
15977 .cindex "cipher" "requiring specific"
15978 This option controls which ciphers can be used for incoming TLS connections.
15979 The &(smtp)& transport has an option of the same name for controlling outgoing
15980 connections. This option is expanded for each connection, so can be varied for
15981 different clients if required. The value of this option must be a list of
15982 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15983 in somewhat different ways. If GnuTLS is being used, the client controls the
15984 preference order of the available ciphers. Details are given in sections
15985 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15986
15987
15988 .option tls_try_verify_hosts main "host list&!!" unset
15989 .cindex "TLS" "client certificate verification"
15990 .cindex "certificate" "verification of client"
15991 See &%tls_verify_hosts%& below.
15992
15993
15994 .option tls_verify_certificates main string&!! unset
15995 .cindex "TLS" "client certificate verification"
15996 .cindex "certificate" "verification of client"
15997 The value of this option is expanded, and must then be the absolute path to
15998 a file containing permitted certificates for clients that
15999 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
16000 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
16001 directory containing certificate files. This does not work with GnuTLS; the
16002 option must be set to the name of a single file if you are using GnuTLS.
16003
16004 These certificates should be for the certificate authorities trusted, rather
16005 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16006 the value is a file then the certificates are sent by Exim as a server to
16007 connecting clients, defining the list of accepted certificate authorities.
16008 Thus the values defined should be considered public data.  To avoid this,
16009 use OpenSSL with a directory.
16010
16011 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16012
16013
16014 .option tls_verify_hosts main "host list&!!" unset
16015 .cindex "TLS" "client certificate verification"
16016 .cindex "certificate" "verification of client"
16017 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16018 certificates from clients. The expected certificates are defined by
16019 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16020 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16021 &%tls_verify_certificates%& is not set.
16022
16023 Any client that matches &%tls_verify_hosts%& is constrained by
16024 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16025 present one of the listed certificates. If it does not, the connection is
16026 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16027 the host to use TLS. It can still send SMTP commands through unencrypted
16028 connections. Forcing a client to use TLS has to be done separately using an
16029 ACL to reject inappropriate commands when the connection is not encrypted.
16030
16031 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16032 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16033 certificate and checks it against &%tls_verify_certificates%&, but does not
16034 abort the connection if there is no certificate or if it does not match. This
16035 state can be detected in an ACL, which makes it possible to implement policies
16036 such as &"accept for relay only if a verified certificate has been received,
16037 but accept for local delivery if encrypted, even without a verified
16038 certificate"&.
16039
16040 Client hosts that match neither of these lists are not asked to present
16041 certificates.
16042
16043
16044 .option trusted_groups main "string list&!!" unset
16045 .cindex "trusted groups"
16046 .cindex "groups" "trusted"
16047 This option is expanded just once, at the start of Exim's processing. If this
16048 option is set, any process that is running in one of the listed groups, or
16049 which has one of them as a supplementary group, is trusted. The groups can be
16050 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16051 details of what trusted callers are permitted to do. If neither
16052 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16053 are trusted.
16054
16055 .option trusted_users main "string list&!!" unset
16056 .cindex "trusted users"
16057 .cindex "user" "trusted"
16058 This option is expanded just once, at the start of Exim's processing. If this
16059 option is set, any process that is running as one of the listed users is
16060 trusted. The users can be specified numerically or by name. See section
16061 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16062 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16063 Exim user are trusted.
16064
16065 .option unknown_login main string&!! unset
16066 .cindex "uid (user id)" "unknown caller"
16067 .vindex "&$caller_uid$&"
16068 This is a specialized feature for use in unusual configurations. By default, if
16069 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16070 gives up. The &%unknown_login%& option can be used to set a login name to be
16071 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16072 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16073 is used for the user's real name (gecos field), unless this has been set by the
16074 &%-F%& option.
16075
16076 .option unknown_username main string unset
16077 See &%unknown_login%&.
16078
16079 .option untrusted_set_sender main "address list&!!" unset
16080 .cindex "trusted users"
16081 .cindex "sender" "setting by untrusted user"
16082 .cindex "untrusted user setting sender"
16083 .cindex "user" "untrusted setting sender"
16084 .cindex "envelope sender"
16085 When an untrusted user submits a message to Exim using the standard input, Exim
16086 normally creates an envelope sender address from the user's login and the
16087 default qualification domain. Data from the &%-f%& option (for setting envelope
16088 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16089 is used) is ignored.
16090
16091 However, untrusted users are permitted to set an empty envelope sender address,
16092 to declare that a message should never generate any bounces. For example:
16093 .code
16094 exim -f '<>' user@domain.example
16095 .endd
16096 .vindex "&$sender_ident$&"
16097 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16098 other envelope sender addresses in a controlled way. When it is set, untrusted
16099 users are allowed to set envelope sender addresses that match any of the
16100 patterns in the list. Like all address lists, the string is expanded. The
16101 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16102 users to setting senders that start with their login ids
16103 followed by a hyphen
16104 by a setting like this:
16105 .code
16106 untrusted_set_sender = ^$sender_ident-
16107 .endd
16108 If you want to allow untrusted users to set envelope sender addresses without
16109 restriction, you can use
16110 .code
16111 untrusted_set_sender = *
16112 .endd
16113 The &%untrusted_set_sender%& option applies to all forms of local input, but
16114 only to the setting of the envelope sender. It does not permit untrusted users
16115 to use the other options which trusted user can use to override message
16116 parameters. Furthermore, it does not stop Exim from removing an existing
16117 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16118 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16119 overriding these actions. The handling of the &'Sender:'& header is also
16120 described in section &<<SECTthesenhea>>&.
16121
16122 The log line for a message's arrival shows the envelope sender following
16123 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16124 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16125 envelope sender address, the user's login is shown in parentheses after the
16126 sender address.
16127
16128
16129 .option uucp_from_pattern main string "see below"
16130 .cindex "&""From""& line"
16131 .cindex "UUCP" "&""From""& line"
16132 Some applications that pass messages to an MTA via a command line interface use
16133 an initial line starting with &"From&~"& to pass the envelope sender. In
16134 particular, this is used by UUCP software. Exim recognizes such a line by means
16135 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16136 matches, the sender address is constructed by expanding the contents of
16137 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16138 default pattern recognizes lines in the following two forms:
16139 .code
16140 From ph10 Fri Jan  5 12:35 GMT 1996
16141 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16142 .endd
16143 The pattern can be seen by running
16144 .code
16145 exim -bP uucp_from_pattern
16146 .endd
16147 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16148 year in the second case. The first word after &"From&~"& is matched in the
16149 regular expression by a parenthesized subpattern. The default value for
16150 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16151 (&"ph10"& in the example above) as the message's sender. See also
16152 &%ignore_fromline_hosts%&.
16153
16154
16155 .option uucp_from_sender main string&!! &`$1`&
16156 See &%uucp_from_pattern%& above.
16157
16158
16159 .option warn_message_file main string unset
16160 .cindex "warning of delay" "customizing the message"
16161 .cindex "customizing" "warning message"
16162 This option defines a template file containing paragraphs of text to be used
16163 for constructing the warning message which is sent by Exim when a message has
16164 been on the queue for a specified amount of time, as specified by
16165 &%delay_warning%&. Details of the file's contents are given in chapter
16166 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16167
16168
16169 .option write_rejectlog main boolean true
16170 .cindex "reject log" "disabling"
16171 If this option is set false, Exim no longer writes anything to the reject log.
16172 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16173 .ecindex IIDconfima
16174 .ecindex IIDmaiconf
16175
16176
16177
16178
16179 . ////////////////////////////////////////////////////////////////////////////
16180 . ////////////////////////////////////////////////////////////////////////////
16181
16182 .chapter "Generic options for routers" "CHAProutergeneric"
16183 .scindex IIDgenoprou1 "options" "generic; for routers"
16184 .scindex IIDgenoprou2 "generic options" "router"
16185 This chapter describes the generic options that apply to all routers.
16186 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16187
16188 For a general description of how a router operates, see sections
16189 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16190 which the preconditions are tested. The order of expansion of the options that
16191 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16192 &%headers_remove%&, &%transport%&.
16193
16194
16195
16196 .option address_data routers string&!! unset
16197 .cindex "router" "data attached to address"
16198 The string is expanded just before the router is run, that is, after all the
16199 precondition tests have succeeded. If the expansion is forced to fail, the
16200 router declines, the value of &%address_data%& remains unchanged, and the
16201 &%more%& option controls what happens next. Other expansion failures cause
16202 delivery of the address to be deferred.
16203
16204 .vindex "&$address_data$&"
16205 When the expansion succeeds, the value is retained with the address, and can be
16206 accessed using the variable &$address_data$& in the current router, subsequent
16207 routers, and the eventual transport.
16208
16209 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16210 that runs a user's filter file, the contents of &$address_data$& are accessible
16211 in the filter. This is not normally a problem, because such data is usually
16212 either not confidential or it &"belongs"& to the current user, but if you do
16213 put confidential data into &$address_data$& you need to remember this point.
16214
16215 Even if the router declines or passes, the value of &$address_data$& remains
16216 with the address, though it can be changed by another &%address_data%& setting
16217 on a subsequent router. If a router generates child addresses, the value of
16218 &$address_data$& propagates to them. This also applies to the special kind of
16219 &"child"& that is generated by a router with the &%unseen%& option.
16220
16221 The idea of &%address_data%& is that you can use it to look up a lot of data
16222 for the address once, and then pick out parts of the data later. For example,
16223 you could use a single LDAP lookup to return a string of the form
16224 .code
16225 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16226 .endd
16227 In the transport you could pick out the mailbox by a setting such as
16228 .code
16229 file = ${extract{mailbox}{$address_data}}
16230 .endd
16231 This makes the configuration file less messy, and also reduces the number of
16232 lookups (though Exim does cache lookups).
16233
16234 .vindex "&$sender_address_data$&"
16235 .vindex "&$address_data$&"
16236 The &%address_data%& facility is also useful as a means of passing information
16237 from one router to another, and from a router to a transport. In addition, if
16238 &$address_data$& is set by a router when verifying a recipient address from an
16239 ACL, it remains available for use in the rest of the ACL statement. After
16240 verifying a sender, the value is transferred to &$sender_address_data$&.
16241
16242
16243
16244 .option address_test routers&!? boolean true
16245 .oindex "&%-bt%&"
16246 .cindex "router" "skipping when address testing"
16247 If this option is set false, the router is skipped when routing is being tested
16248 by means of the &%-bt%& command line option. This can be a convenience when
16249 your first router sends messages to an external scanner, because it saves you
16250 having to set the &"already scanned"& indicator when testing real address
16251 routing.
16252
16253
16254
16255 .option cannot_route_message routers string&!! unset
16256 .cindex "router" "customizing &""cannot route""& message"
16257 .cindex "customizing" "&""cannot route""& message"
16258 This option specifies a text message that is used when an address cannot be
16259 routed because Exim has run out of routers. The default message is
16260 &"Unrouteable address"&. This option is useful only on routers that have
16261 &%more%& set false, or on the very last router in a configuration, because the
16262 value that is used is taken from the last router that is considered. This
16263 includes a router that is skipped because its preconditions are not met, as
16264 well as a router that declines. For example, using the default configuration,
16265 you could put:
16266 .code
16267 cannot_route_message = Remote domain not found in DNS
16268 .endd
16269 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16270 and
16271 .code
16272 cannot_route_message = Unknown local user
16273 .endd
16274 on the final router that checks for local users. If string expansion fails for
16275 this option, the default message is used. Unless the expansion failure was
16276 explicitly forced, a message about the failure is written to the main and panic
16277 logs, in addition to the normal message about the routing failure.
16278
16279
16280 .option caseful_local_part routers boolean false
16281 .cindex "case of local parts"
16282 .cindex "router" "case of local parts"
16283 By default, routers handle the local parts of addresses in a case-insensitive
16284 manner, though the actual case is preserved for transmission with the message.
16285 If you want the case of letters to be significant in a router, you must set
16286 this option true. For individual router options that contain address or local
16287 part lists (for example, &%local_parts%&), case-sensitive matching can be
16288 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16289 more details.
16290
16291 .vindex "&$local_part$&"
16292 .vindex "&$original_local_part$&"
16293 .vindex "&$parent_local_part$&"
16294 The value of the &$local_part$& variable is forced to lower case while a
16295 router is running unless &%caseful_local_part%& is set. When a router assigns
16296 an address to a transport, the value of &$local_part$& when the transport runs
16297 is the same as it was in the router. Similarly, when a router generates child
16298 addresses by aliasing or forwarding, the values of &$original_local_part$&
16299 and &$parent_local_part$& are those that were used by the redirecting router.
16300
16301 This option applies to the processing of an address by a router. When a
16302 recipient address is being processed in an ACL, there is a separate &%control%&
16303 modifier that can be used to specify case-sensitive processing within the ACL
16304 (see section &<<SECTcontrols>>&).
16305
16306
16307
16308 .option check_local_user routers&!? boolean false
16309 .cindex "local user, checking in router"
16310 .cindex "router" "checking for local user"
16311 .cindex "&_/etc/passwd_&"
16312 .vindex "&$home$&"
16313 When this option is true, Exim checks that the local part of the recipient
16314 address (with affixes removed if relevant) is the name of an account on the
16315 local system. The check is done by calling the &[getpwnam()]& function rather
16316 than trying to read &_/etc/passwd_& directly. This means that other methods of
16317 holding password data (such as NIS) are supported. If the local part is a local
16318 user, &$home$& is set from the password data, and can be tested in other
16319 preconditions that are evaluated after this one (the order of evaluation is
16320 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16321 overridden by &%router_home_directory%&. If the local part is not a local user,
16322 the router is skipped.
16323
16324 If you want to check that the local part is either the name of a local user
16325 or matches something else, you cannot combine &%check_local_user%& with a
16326 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16327 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16328 setting to achieve this. For example:
16329 .code
16330 local_parts = passwd;$local_part : lsearch;/etc/other/users
16331 .endd
16332 Note, however, that the side effects of &%check_local_user%& (such as setting
16333 up a home directory) do not occur when a &(passwd)& lookup is used in a
16334 &%local_parts%& (or any other) precondition.
16335
16336
16337
16338 .option condition routers&!? string&!! unset
16339 .cindex "router" "customized precondition"
16340 This option specifies a general precondition test that has to succeed for the
16341 router to be called. The &%condition%& option is the last precondition to be
16342 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16343 result is a forced failure, or an empty string, or one of the strings &"0"& or
16344 &"no"& or &"false"& (checked without regard to the case of the letters), the
16345 router is skipped, and the address is offered to the next one.
16346
16347 If the result is any other value, the router is run (as this is the last
16348 precondition to be evaluated, all the other preconditions must be true).
16349
16350 This option is unusual in that multiple &%condition%& options may be present.
16351 All &%condition%& options must succeed.
16352
16353 The &%condition%& option provides a means of applying custom conditions to the
16354 running of routers. Note that in the case of a simple conditional expansion,
16355 the default expansion values are exactly what is wanted. For example:
16356 .code
16357 condition = ${if >{$message_age}{600}}
16358 .endd
16359 Because of the default behaviour of the string expansion, this is equivalent to
16360 .code
16361 condition = ${if >{$message_age}{600}{true}{}}
16362 .endd
16363
16364 A multiple condition example, which succeeds:
16365 .code
16366 condition = ${if >{$message_age}{600}}
16367 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16368 condition = foobar
16369 .endd
16370
16371 If the expansion fails (other than forced failure) delivery is deferred. Some
16372 of the other precondition options are common special cases that could in fact
16373 be specified using &%condition%&.
16374
16375
16376 .option debug_print routers string&!! unset
16377 .cindex "testing" "variables in drivers"
16378 If this option is set and debugging is enabled (see the &%-d%& command line
16379 option), the string is expanded and included in the debugging output.
16380 If expansion of the string fails, the error message is written to the debugging
16381 output, and Exim carries on processing.
16382 This option is provided to help with checking out the values of variables and
16383 so on when debugging router configurations. For example, if a &%condition%&
16384 option appears not to be working, &%debug_print%& can be used to output the
16385 variables it references. The output happens after checks for &%domains%&,
16386 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16387 are tested. A newline is added to the text if it does not end with one.
16388
16389
16390
16391 .option disable_logging routers boolean false
16392 If this option is set true, nothing is logged for any routing errors
16393 or for any deliveries caused by this router. You should not set this option
16394 unless you really, really know what you are doing. See also the generic
16395 transport option of the same name.
16396
16397
16398 .option domains routers&!? "domain list&!!" unset
16399 .cindex "router" "restricting to specific domains"
16400 .vindex "&$domain_data$&"
16401 If this option is set, the router is skipped unless the current domain matches
16402 the list. If the match is achieved by means of a file lookup, the data that the
16403 lookup returned for the domain is placed in &$domain_data$& for use in string
16404 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16405 a list of the order in which preconditions are evaluated.
16406
16407
16408
16409 .option driver routers string unset
16410 This option must always be set. It specifies which of the available routers is
16411 to be used.
16412
16413
16414
16415 .option errors_to routers string&!! unset
16416 .cindex "envelope sender"
16417 .cindex "router" "changing address for errors"
16418 If a router successfully handles an address, it may assign the address to a
16419 transport for delivery or it may generate child addresses. In both cases, if
16420 there is a delivery problem during later processing, the resulting bounce
16421 message is sent to the address that results from expanding this string,
16422 provided that the address verifies successfully. The &%errors_to%& option is
16423 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16424
16425 The &%errors_to%& setting associated with an address can be overridden if it
16426 subsequently passes through other routers that have their own &%errors_to%&
16427 settings, or if the message is delivered by a transport with a &%return_path%&
16428 setting.
16429
16430 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16431 the expansion fails to verify, the errors address associated with the incoming
16432 address is used. At top level, this is the envelope sender. A non-forced
16433 expansion failure causes delivery to be deferred.
16434
16435 If an address for which &%errors_to%& has been set ends up being delivered over
16436 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16437 any bounces that are generated by other MTAs on the delivery route are also
16438 sent there. You can set &%errors_to%& to the empty string by either of these
16439 settings:
16440 .code
16441 errors_to =
16442 errors_to = ""
16443 .endd
16444 An expansion item that yields an empty string has the same effect. If you do
16445 this, a locally detected delivery error for addresses processed by this router
16446 no longer gives rise to a bounce message; the error is discarded. If the
16447 address is delivered to a remote host, the return path is set to &`<>`&, unless
16448 overridden by the &%return_path%& option on the transport.
16449
16450 .vindex "&$address_data$&"
16451 If for some reason you want to discard local errors, but use a non-empty
16452 MAIL command for remote delivery, you can preserve the original return
16453 path in &$address_data$& in the router, and reinstate it in the transport by
16454 setting &%return_path%&.
16455
16456 The most common use of &%errors_to%& is to direct mailing list bounces to the
16457 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16458 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16459
16460
16461
16462 .option expn routers&!? boolean true
16463 .cindex "address" "testing"
16464 .cindex "testing" "addresses"
16465 .cindex "EXPN" "router skipping"
16466 .cindex "router" "skipping for EXPN"
16467 If this option is turned off, the router is skipped when testing an address
16468 as a result of processing an SMTP EXPN command. You might, for example,
16469 want to turn it off on a router for users' &_.forward_& files, while leaving it
16470 on for the system alias file.
16471 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16472 are evaluated.
16473
16474 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16475 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16476 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16477
16478
16479
16480 .option fail_verify routers boolean false
16481 .cindex "router" "forcing verification failure"
16482 Setting this option has the effect of setting both &%fail_verify_sender%& and
16483 &%fail_verify_recipient%& to the same value.
16484
16485
16486
16487 .option fail_verify_recipient routers boolean false
16488 If this option is true and an address is accepted by this router when
16489 verifying a recipient, verification fails.
16490
16491
16492
16493 .option fail_verify_sender routers boolean false
16494 If this option is true and an address is accepted by this router when
16495 verifying a sender, verification fails.
16496
16497
16498
16499 .option fallback_hosts routers "string list" unset
16500 .cindex "router" "fallback hosts"
16501 .cindex "fallback" "hosts specified on router"
16502 String expansion is not applied to this option. The argument must be a
16503 colon-separated list of host names or IP addresses. The list separator can be
16504 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16505 each name or address. In fact, the format of each item is exactly the same as
16506 defined for the list of hosts in a &(manualroute)& router (see section
16507 &<<SECTformatonehostitem>>&).
16508
16509 If a router queues an address for a remote transport, this host list is
16510 associated with the address, and used instead of the transport's fallback host
16511 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16512 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16513 transport for further details.
16514
16515
16516 .option group routers string&!! "see below"
16517 .cindex "gid (group id)" "local delivery"
16518 .cindex "local transports" "uid and gid"
16519 .cindex "transport" "local"
16520 .cindex "router" "setting group"
16521 When a router queues an address for a transport, and the transport does not
16522 specify a group, the group given here is used when running the delivery
16523 process.
16524 The group may be specified numerically or by name. If expansion fails, the
16525 error is logged and delivery is deferred.
16526 The default is unset, unless &%check_local_user%& is set, when the default
16527 is taken from the password information. See also &%initgroups%& and &%user%&
16528 and the discussion in chapter &<<CHAPenvironment>>&.
16529
16530
16531
16532 .option headers_add routers string&!! unset
16533 .cindex "header lines" "adding"
16534 .cindex "router" "adding header lines"
16535 This option specifies a string of text that is expanded at routing time, and
16536 associated with any addresses that are accepted by the router. However, this
16537 option has no effect when an address is just being verified. The way in which
16538 the text is used to add header lines at transport time is described in section
16539 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16540 message is in the process of being transported. This means that references to
16541 header lines in string expansions in the transport's configuration do not
16542 &"see"& the added header lines.
16543
16544 The &%headers_add%& option is expanded after &%errors_to%&, but before
16545 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16546 the expansion is forced to fail, the option has no effect. Other expansion
16547 failures are treated as configuration errors.
16548
16549 Unlike most options, &%headers_add%& can be specified multiple times
16550 for a router; all listed headers are added.
16551
16552 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16553 router that has the &%one_time%& option set.
16554
16555 .cindex "duplicate addresses"
16556 .oindex "&%unseen%&"
16557 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16558 additions are deleted when the address is passed on to subsequent routers.
16559 For a &%redirect%& router, if a generated address is the same as the incoming
16560 address, this can lead to duplicate addresses with different header
16561 modifications. Exim does not do duplicate deliveries (except, in certain
16562 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16563 which of the duplicates is discarded, so this ambiguous situation should be
16564 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16565
16566
16567
16568 .option headers_remove routers string&!! unset
16569 .cindex "header lines" "removing"
16570 .cindex "router" "removing header lines"
16571 This option specifies a string of text that is expanded at routing time, and
16572 associated with any addresses that are accepted by the router. However, this
16573 option has no effect when an address is just being verified. The way in which
16574 the text is used to remove header lines at transport time is described in
16575 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16576 the message is in the process of being transported. This means that references
16577 to header lines in string expansions in the transport's configuration still
16578 &"see"& the original header lines.
16579
16580 The &%headers_remove%& option is expanded after &%errors_to%& and
16581 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16582 the option has no effect. Other expansion failures are treated as configuration
16583 errors.
16584
16585 Unlike most options, &%headers_remove%& can be specified multiple times
16586 for a router; all listed headers are removed.
16587
16588 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16589 router that has the &%one_time%& option set.
16590
16591 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16592 removal requests are deleted when the address is passed on to subsequent
16593 routers, and this can lead to problems with duplicates -- see the similar
16594 warning for &%headers_add%& above.
16595
16596
16597 .option ignore_target_hosts routers "host list&!!" unset
16598 .cindex "IP address" "discarding"
16599 .cindex "router" "discarding IP addresses"
16600 Although this option is a host list, it should normally contain IP address
16601 entries rather than names. If any host that is looked up by the router has an
16602 IP address that matches an item in this list, Exim behaves as if that IP
16603 address did not exist. This option allows you to cope with rogue DNS entries
16604 like
16605 .code
16606 remote.domain.example.  A  127.0.0.1
16607 .endd
16608 by setting
16609 .code
16610 ignore_target_hosts = 127.0.0.1
16611 .endd
16612 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16613 discarded in this way, the router declines. In a conventional configuration, an
16614 attempt to mail to such a domain would normally provoke the &"unrouteable
16615 domain"& error, and an attempt to verify an address in the domain would fail.
16616 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16617 router declines if presented with one of the listed addresses.
16618
16619 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16620 means of the first or the second of the following settings, respectively:
16621 .code
16622 ignore_target_hosts = 0.0.0.0/0
16623 ignore_target_hosts = <; 0::0/0
16624 .endd
16625 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16626 in the second line matches all IPv6 addresses.
16627
16628 This option may also be useful for ignoring link-local and site-local IPv6
16629 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16630 is expanded before use as a list, it is possible to make it dependent on the
16631 domain that is being routed.
16632
16633 .vindex "&$host_address$&"
16634 During its expansion, &$host_address$& is set to the IP address that is being
16635 checked.
16636
16637 .option initgroups routers boolean false
16638 .cindex "additional groups"
16639 .cindex "groups" "additional"
16640 .cindex "local transports" "uid and gid"
16641 .cindex "transport" "local"
16642 If the router queues an address for a transport, and this option is true, and
16643 the uid supplied by the router is not overridden by the transport, the
16644 &[initgroups()]& function is called when running the transport to ensure that
16645 any additional groups associated with the uid are set up. See also &%group%&
16646 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16647
16648
16649
16650 .option local_part_prefix routers&!? "string list" unset
16651 .cindex "router" "prefix for local part"
16652 .cindex "prefix" "for local part, used in router"
16653 If this option is set, the router is skipped unless the local part starts with
16654 one of the given strings, or &%local_part_prefix_optional%& is true. See
16655 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16656 evaluated.
16657
16658 The list is scanned from left to right, and the first prefix that matches is
16659 used. A limited form of wildcard is available; if the prefix begins with an
16660 asterisk, it matches the longest possible sequence of arbitrary characters at
16661 the start of the local part. An asterisk should therefore always be followed by
16662 some character that does not occur in normal local parts.
16663 .cindex "multiple mailboxes"
16664 .cindex "mailbox" "multiple"
16665 Wildcarding can be used to set up multiple user mailboxes, as described in
16666 section &<<SECTmulbox>>&.
16667
16668 .vindex "&$local_part$&"
16669 .vindex "&$local_part_prefix$&"
16670 During the testing of the &%local_parts%& option, and while the router is
16671 running, the prefix is removed from the local part, and is available in the
16672 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16673 the router accepts the address, this remains true during subsequent delivery by
16674 a transport. In particular, the local part that is transmitted in the RCPT
16675 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16676 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16677 the relevant transport.
16678
16679 When an address is being verified, &%local_part_prefix%& affects only the
16680 behaviour of the router. If the callout feature of verification is in use, this
16681 means that the full address, including the prefix, will be used during the
16682 callout.
16683
16684 The prefix facility is commonly used to handle local parts of the form
16685 &%owner-something%&. Another common use is to support local parts of the form
16686 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16687 to tell a user their forwarding is broken &-- by placing a router like this one
16688 immediately before the router that handles &_.forward_& files:
16689 .code
16690 real_localuser:
16691   driver = accept
16692   local_part_prefix = real-
16693   check_local_user
16694   transport = local_delivery
16695 .endd
16696 For security, it would probably be a good idea to restrict the use of this
16697 router to locally-generated messages, using a condition such as this:
16698 .code
16699   condition = ${if match {$sender_host_address}\
16700                          {\N^(|127\.0\.0\.1)$\N}}
16701 .endd
16702
16703 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16704 both conditions must be met if not optional. Care must be taken if wildcards
16705 are used in both a prefix and a suffix on the same router. Different
16706 separator characters must be used to avoid ambiguity.
16707
16708
16709 .option local_part_prefix_optional routers boolean false
16710 See &%local_part_prefix%& above.
16711
16712
16713
16714 .option local_part_suffix routers&!? "string list" unset
16715 .cindex "router" "suffix for local part"
16716 .cindex "suffix for local part" "used in router"
16717 This option operates in the same way as &%local_part_prefix%&, except that the
16718 local part must end (rather than start) with the given string, the
16719 &%local_part_suffix_optional%& option determines whether the suffix is
16720 mandatory, and the wildcard * character, if present, must be the last
16721 character of the suffix. This option facility is commonly used to handle local
16722 parts of the form &%something-request%& and multiple user mailboxes of the form
16723 &%username-foo%&.
16724
16725
16726 .option local_part_suffix_optional routers boolean false
16727 See &%local_part_suffix%& above.
16728
16729
16730
16731 .option local_parts routers&!? "local part list&!!" unset
16732 .cindex "router" "restricting to specific local parts"
16733 .cindex "local part" "checking in router"
16734 The router is run only if the local part of the address matches the list.
16735 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16736 are evaluated, and
16737 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16738 string is expanded, it is possible to make it depend on the domain, for
16739 example:
16740 .code
16741 local_parts = dbm;/usr/local/specials/$domain
16742 .endd
16743 .vindex "&$local_part_data$&"
16744 If the match is achieved by a lookup, the data that the lookup returned
16745 for the local part is placed in the variable &$local_part_data$& for use in
16746 expansions of the router's private options. You might use this option, for
16747 example, if you have a large number of local virtual domains, and you want to
16748 send all postmaster mail to the same place without having to set up an alias in
16749 each virtual domain:
16750 .code
16751 postmaster:
16752   driver = redirect
16753   local_parts = postmaster
16754   data = postmaster@real.domain.example
16755 .endd
16756
16757
16758 .option log_as_local routers boolean "see below"
16759 .cindex "log" "delivery line"
16760 .cindex "delivery" "log line format"
16761 Exim has two logging styles for delivery, the idea being to make local
16762 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16763 recipient address is given just as the local part, without a domain. The use of
16764 this style is controlled by this option. It defaults to true for the &(accept)&
16765 router, and false for all the others. This option applies only when a
16766 router assigns an address to a transport. It has no effect on routers that
16767 redirect addresses.
16768
16769
16770
16771 .option more routers boolean&!! true
16772 The result of string expansion for this option must be a valid boolean value,
16773 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16774 result causes an error, and delivery is deferred. If the expansion is forced to
16775 fail, the default value for the option (true) is used. Other failures cause
16776 delivery to be deferred.
16777
16778 If this option is set false, and the router declines to handle the address, no
16779 further routers are tried, routing fails, and the address is bounced.
16780 .oindex "&%self%&"
16781 However, if the router explicitly passes an address to the following router by
16782 means of the setting
16783 .code
16784 self = pass
16785 .endd
16786 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16787 does not affect the behaviour if one of the precondition tests fails. In that
16788 case, the address is always passed to the next router.
16789
16790 Note that &%address_data%& is not considered to be a precondition. If its
16791 expansion is forced to fail, the router declines, and the value of &%more%&
16792 controls what happens next.
16793
16794
16795 .option pass_on_timeout routers boolean false
16796 .cindex "timeout" "of router"
16797 .cindex "router" "timeout"
16798 If a router times out during a host lookup, it normally causes deferral of the
16799 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16800 router, overriding &%no_more%&. This may be helpful for systems that are
16801 intermittently connected to the Internet, or those that want to pass to a smart
16802 host any messages that cannot immediately be delivered.
16803
16804 There are occasional other temporary errors that can occur while doing DNS
16805 lookups. They are treated in the same way as a timeout, and this option
16806 applies to all of them.
16807
16808
16809
16810 .option pass_router routers string unset
16811 .cindex "router" "go to after &""pass""&"
16812 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16813 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16814 routing to continue, and overriding a false setting of &%more%&. When one of
16815 these routers returns &"pass"&, the address is normally handed on to the next
16816 router in sequence. This can be changed by setting &%pass_router%& to the name
16817 of another router. However (unlike &%redirect_router%&) the named router must
16818 be below the current router, to avoid loops. Note that this option applies only
16819 to the special case of &"pass"&. It does not apply when a router returns
16820 &"decline"& because it cannot handle an address.
16821
16822
16823
16824 .option redirect_router routers string unset
16825 .cindex "router" "start at after redirection"
16826 Sometimes an administrator knows that it is pointless to reprocess addresses
16827 generated from alias or forward files with the same router again. For
16828 example, if an alias file translates real names into login ids there is no
16829 point searching the alias file a second time, especially if it is a large file.
16830
16831 The &%redirect_router%& option can be set to the name of any router instance.
16832 It causes the routing of any generated addresses to start at the named router
16833 instead of at the first router. This option has no effect if the router in
16834 which it is set does not generate new addresses.
16835
16836
16837
16838 .option require_files routers&!? "string list&!!" unset
16839 .cindex "file" "requiring for router"
16840 .cindex "router" "requiring file existence"
16841 This option provides a general mechanism for predicating the running of a
16842 router on the existence or non-existence of certain files or directories.
16843 Before running a router, as one of its precondition tests, Exim works its way
16844 through the &%require_files%& list, expanding each item separately.
16845
16846 Because the list is split before expansion, any colons in expansion items must
16847 be doubled, or the facility for using a different list separator must be used.
16848 If any expansion is forced to fail, the item is ignored. Other expansion
16849 failures cause routing of the address to be deferred.
16850
16851 If any expanded string is empty, it is ignored. Otherwise, except as described
16852 below, each string must be a fully qualified file path, optionally preceded by
16853 &"!"&. The paths are passed to the &[stat()]& function to test for the
16854 existence of the files or directories. The router is skipped if any paths not
16855 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16856
16857 .cindex "NFS"
16858 If &[stat()]& cannot determine whether a file exists or not, delivery of
16859 the message is deferred. This can happen when NFS-mounted filesystems are
16860 unavailable.
16861
16862 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16863 options, so you cannot use it to check for the existence of a file in which to
16864 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16865 full list of the order in which preconditions are evaluated.) However, as
16866 these options are all expanded, you can use the &%exists%& expansion condition
16867 to make such tests. The &%require_files%& option is intended for checking files
16868 that the router may be going to use internally, or which are needed by a
16869 transport (for example &_.procmailrc_&).
16870
16871 During delivery, the &[stat()]& function is run as root, but there is a
16872 facility for some checking of the accessibility of a file by another user.
16873 This is not a proper permissions check, but just a &"rough"& check that
16874 operates as follows:
16875
16876 If an item in a &%require_files%& list does not contain any forward slash
16877 characters, it is taken to be the user (and optional group, separated by a
16878 comma) to be checked for subsequent files in the list. If no group is specified
16879 but the user is specified symbolically, the gid associated with the uid is
16880 used. For example:
16881 .code
16882 require_files = mail:/some/file
16883 require_files = $local_part:$home/.procmailrc
16884 .endd
16885 If a user or group name in a &%require_files%& list does not exist, the
16886 &%require_files%& condition fails.
16887
16888 Exim performs the check by scanning along the components of the file path, and
16889 checking the access for the given uid and gid. It checks for &"x"& access on
16890 directories, and &"r"& access on the final file. Note that this means that file
16891 access control lists, if the operating system has them, are ignored.
16892
16893 &*Warning 1*&: When the router is being run to verify addresses for an
16894 incoming SMTP message, Exim is not running as root, but under its own uid. This
16895 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16896 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16897 user is not permitted to read one of the directories on the file's path.
16898
16899 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16900 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16901 without root access. In this case, if a check for access by a particular user
16902 is requested, Exim creates a subprocess that runs as that user, and tries the
16903 check again in that process.
16904
16905 The default action for handling an unresolved EACCES is to consider it to
16906 be caused by a configuration error, and routing is deferred because the
16907 existence or non-existence of the file cannot be determined. However, in some
16908 circumstances it may be desirable to treat this condition as if the file did
16909 not exist. If the file name (or the exclamation mark that precedes the file
16910 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16911 as if the file did not exist. For example:
16912 .code
16913 require_files = +/some/file
16914 .endd
16915 If the router is not an essential part of verification (for example, it
16916 handles users' &_.forward_& files), another solution is to set the &%verify%&
16917 option false so that the router is skipped when verifying.
16918
16919
16920
16921 .option retry_use_local_part routers boolean "see below"
16922 .cindex "hints database" "retry keys"
16923 .cindex "local part" "in retry keys"
16924 When a delivery suffers a temporary routing failure, a retry record is created
16925 in Exim's hints database. For addresses whose routing depends only on the
16926 domain, the key for the retry record should not involve the local part, but for
16927 other addresses, both the domain and the local part should be included.
16928 Usually, remote routing is of the former kind, and local routing is of the
16929 latter kind.
16930
16931 This option controls whether the local part is used to form the key for retry
16932 hints for addresses that suffer temporary errors while being handled by this
16933 router. The default value is true for any router that has &%check_local_user%&
16934 set, and false otherwise. Note that this option does not apply to hints keys
16935 for transport delays; they are controlled by a generic transport option of the
16936 same name.
16937
16938 The setting of &%retry_use_local_part%& applies only to the router on which it
16939 appears. If the router generates child addresses, they are routed
16940 independently; this setting does not become attached to them.
16941
16942
16943
16944 .option router_home_directory routers string&!! unset
16945 .cindex "router" "home directory for"
16946 .cindex "home directory" "for router"
16947 .vindex "&$home$&"
16948 This option sets a home directory for use while the router is running. (Compare
16949 &%transport_home_directory%&, which sets a home directory for later
16950 transporting.) In particular, if used on a &(redirect)& router, this option
16951 sets a value for &$home$& while a filter is running. The value is expanded;
16952 forced expansion failure causes the option to be ignored &-- other failures
16953 cause the router to defer.
16954
16955 Expansion of &%router_home_directory%& happens immediately after the
16956 &%check_local_user%& test (if configured), before any further expansions take
16957 place.
16958 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16959 are evaluated.)
16960 While the router is running, &%router_home_directory%& overrides the value of
16961 &$home$& that came from &%check_local_user%&.
16962
16963 When a router accepts an address and assigns it to a local transport (including
16964 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16965 delivery), the home directory setting for the transport is taken from the first
16966 of these values that is set:
16967
16968 .ilist
16969 The &%home_directory%& option on the transport;
16970 .next
16971 The &%transport_home_directory%& option on the router;
16972 .next
16973 The password data if &%check_local_user%& is set on the router;
16974 .next
16975 The &%router_home_directory%& option on the router.
16976 .endlist
16977
16978 In other words, &%router_home_directory%& overrides the password data for the
16979 router, but not for the transport.
16980
16981
16982
16983 .option self routers string freeze
16984 .cindex "MX record" "pointing to local host"
16985 .cindex "local host" "MX pointing to"
16986 This option applies to those routers that use a recipient address to find a
16987 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16988 and &(manualroute)& routers.
16989 Certain configurations of the &(queryprogram)& router can also specify a list
16990 of remote hosts.
16991 Usually such routers are configured to send the message to a remote host via an
16992 &(smtp)& transport. The &%self%& option specifies what happens when the first
16993 host on the list turns out to be the local host.
16994 The way in which Exim checks for the local host is described in section
16995 &<<SECTreclocipadd>>&.
16996
16997 Normally this situation indicates either an error in Exim's configuration (for
16998 example, the router should be configured not to process this domain), or an
16999 error in the DNS (for example, the MX should not point to this host). For this
17000 reason, the default action is to log the incident, defer the address, and
17001 freeze the message. The following alternatives are provided for use in special
17002 cases:
17003
17004 .vlist
17005 .vitem &%defer%&
17006 Delivery of the message is tried again later, but the message is not frozen.
17007
17008 .vitem "&%reroute%&: <&'domain'&>"
17009 The domain is changed to the given domain, and the address is passed back to
17010 be reprocessed by the routers. No rewriting of headers takes place. This
17011 behaviour is essentially a redirection.
17012
17013 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17014 The domain is changed to the given domain, and the address is passed back to be
17015 reprocessed by the routers. Any headers that contain the original domain are
17016 rewritten.
17017
17018 .vitem &%pass%&
17019 .oindex "&%more%&"
17020 .vindex "&$self_hostname$&"
17021 The router passes the address to the next router, or to the router named in the
17022 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17023 subsequent routing and delivery, the variable &$self_hostname$& contains the
17024 name of the local host that the router encountered. This can be used to
17025 distinguish between different cases for hosts with multiple names. The
17026 combination
17027 .code
17028 self = pass
17029 no_more
17030 .endd
17031 ensures that only those addresses that routed to the local host are passed on.
17032 Without &%no_more%&, addresses that were declined for other reasons would also
17033 be passed to the next router.
17034
17035 .vitem &%fail%&
17036 Delivery fails and an error report is generated.
17037
17038 .vitem &%send%&
17039 .cindex "local host" "sending to"
17040 The anomaly is ignored and the address is queued for the transport. This
17041 setting should be used with extreme caution. For an &(smtp)& transport, it
17042 makes sense only in cases where the program that is listening on the SMTP port
17043 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17044 different configuration file that handles the domain in another way.
17045 .endlist
17046
17047
17048
17049 .option senders routers&!? "address list&!!" unset
17050 .cindex "router" "checking senders"
17051 If this option is set, the router is skipped unless the message's sender
17052 address matches something on the list.
17053 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17054 are evaluated.
17055
17056 There are issues concerning verification when the running of routers is
17057 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17058 setting, it sets the sender to the null string. When using the &%-bt%& option
17059 to check a configuration file, it is necessary also to use the &%-f%& option to
17060 set an appropriate sender. For incoming mail, the sender is unset when
17061 verifying the sender, but is available when verifying any recipients. If the
17062 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17063 matters.
17064
17065
17066 .option translate_ip_address routers string&!! unset
17067 .cindex "IP address" "translating"
17068 .cindex "packet radio"
17069 .cindex "router" "IP address translation"
17070 There exist some rare networking situations (for example, packet radio) where
17071 it is helpful to be able to translate IP addresses generated by normal routing
17072 mechanisms into other IP addresses, thus performing a kind of manual IP
17073 routing. This should be done only if the normal IP routing of the TCP/IP stack
17074 is inadequate or broken. Because this is an extremely uncommon requirement, the
17075 code to support this option is not included in the Exim binary unless
17076 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17077
17078 .vindex "&$host_address$&"
17079 The &%translate_ip_address%& string is expanded for every IP address generated
17080 by the router, with the generated address set in &$host_address$&. If the
17081 expansion is forced to fail, no action is taken.
17082 For any other expansion error, delivery of the message is deferred.
17083 If the result of the expansion is an IP address, that replaces the original
17084 address; otherwise the result is assumed to be a host name &-- this is looked
17085 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17086 produce one or more replacement IP addresses. For example, to subvert all IP
17087 addresses in some specific networks, this could be added to a router:
17088 .code
17089 translate_ip_address = \
17090   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17091     {$value}fail}}
17092 .endd
17093 The file would contain lines like
17094 .code
17095 10.2.3.128/26    some.host
17096 10.8.4.34/26     10.44.8.15
17097 .endd
17098 You should not make use of this facility unless you really understand what you
17099 are doing.
17100
17101
17102
17103 .option transport routers string&!! unset
17104 This option specifies the transport to be used when a router accepts an address
17105 and sets it up for delivery. A transport is never needed if a router is used
17106 only for verification. The value of the option is expanded at routing time,
17107 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17108 and result must be the name of one of the configured transports. If it is not,
17109 delivery is deferred.
17110
17111 The &%transport%& option is not used by the &(redirect)& router, but it does
17112 have some private options that set up transports for pipe and file deliveries
17113 (see chapter &<<CHAPredirect>>&).
17114
17115
17116
17117 .option transport_current_directory routers string&!! unset
17118 .cindex "current directory for local transport"
17119 This option associates a current directory with any address that is routed
17120 to a local transport. This can happen either because a transport is
17121 explicitly configured for the router, or because it generates a delivery to a
17122 file or a pipe. During the delivery process (that is, at transport time), this
17123 option string is expanded and is set as the current directory, unless
17124 overridden by a setting on the transport.
17125 If the expansion fails for any reason, including forced failure, an error is
17126 logged, and delivery is deferred.
17127 See chapter &<<CHAPenvironment>>& for details of the local delivery
17128 environment.
17129
17130
17131
17132
17133 .option transport_home_directory routers string&!! "see below"
17134 .cindex "home directory" "for local transport"
17135 This option associates a home directory with any address that is routed to a
17136 local transport. This can happen either because a transport is explicitly
17137 configured for the router, or because it generates a delivery to a file or a
17138 pipe. During the delivery process (that is, at transport time), the option
17139 string is expanded and is set as the home directory, unless overridden by a
17140 setting of &%home_directory%& on the transport.
17141 If the expansion fails for any reason, including forced failure, an error is
17142 logged, and delivery is deferred.
17143
17144 If the transport does not specify a home directory, and
17145 &%transport_home_directory%& is not set for the router, the home directory for
17146 the transport is taken from the password data if &%check_local_user%& is set for
17147 the router. Otherwise it is taken from &%router_home_directory%& if that option
17148 is set; if not, no home directory is set for the transport.
17149
17150 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17151 environment.
17152
17153
17154
17155
17156 .option unseen routers boolean&!! false
17157 .cindex "router" "carrying on after success"
17158 The result of string expansion for this option must be a valid boolean value,
17159 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17160 result causes an error, and delivery is deferred. If the expansion is forced to
17161 fail, the default value for the option (false) is used. Other failures cause
17162 delivery to be deferred.
17163
17164 When this option is set true, routing does not cease if the router accepts the
17165 address. Instead, a copy of the incoming address is passed to the next router,
17166 overriding a false setting of &%more%&. There is little point in setting
17167 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17168 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17169 sometimes true and sometimes false).
17170
17171 .cindex "copy of message (&%unseen%& option)"
17172 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17173 qualifier in filter files. It can be used to cause copies of messages to be
17174 delivered to some other destination, while also carrying out a normal delivery.
17175 In effect, the current address is made into a &"parent"& that has two children
17176 &-- one that is delivered as specified by this router, and a clone that goes on
17177 to be routed further. For this reason, &%unseen%& may not be combined with the
17178 &%one_time%& option in a &(redirect)& router.
17179
17180 &*Warning*&: Header lines added to the address (or specified for removal) by
17181 this router or by previous routers affect the &"unseen"& copy of the message
17182 only. The clone that continues to be processed by further routers starts with
17183 no added headers and none specified for removal. For a &%redirect%& router, if
17184 a generated address is the same as the incoming address, this can lead to
17185 duplicate addresses with different header modifications. Exim does not do
17186 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17187 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17188 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17189 &%redirect%& router may be of help.
17190
17191 Unlike the handling of header modifications, any data that was set by the
17192 &%address_data%& option in the current or previous routers &'is'& passed on to
17193 subsequent routers.
17194
17195
17196 .option user routers string&!! "see below"
17197 .cindex "uid (user id)" "local delivery"
17198 .cindex "local transports" "uid and gid"
17199 .cindex "transport" "local"
17200 .cindex "router" "user for filter processing"
17201 .cindex "filter" "user for processing"
17202 When a router queues an address for a transport, and the transport does not
17203 specify a user, the user given here is used when running the delivery process.
17204 The user may be specified numerically or by name. If expansion fails, the
17205 error is logged and delivery is deferred.
17206 This user is also used by the &(redirect)& router when running a filter file.
17207 The default is unset, except when &%check_local_user%& is set. In this case,
17208 the default is taken from the password information. If the user is specified as
17209 a name, and &%group%& is not set, the group associated with the user is used.
17210 See also &%initgroups%& and &%group%& and the discussion in chapter
17211 &<<CHAPenvironment>>&.
17212
17213
17214
17215 .option verify routers&!? boolean true
17216 Setting this option has the effect of setting &%verify_sender%& and
17217 &%verify_recipient%& to the same value.
17218
17219
17220 .option verify_only routers&!? boolean false
17221 .cindex "EXPN" "with &%verify_only%&"
17222 .oindex "&%-bv%&"
17223 .cindex "router" "used only when verifying"
17224 If this option is set, the router is used only when verifying an address or
17225 testing with the &%-bv%& option, not when actually doing a delivery, testing
17226 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17227 restricted to verifying only senders or recipients by means of
17228 &%verify_sender%& and &%verify_recipient%&.
17229
17230 &*Warning*&: When the router is being run to verify addresses for an incoming
17231 SMTP message, Exim is not running as root, but under its own uid. If the router
17232 accesses any files, you need to make sure that they are accessible to the Exim
17233 user or group.
17234
17235
17236 .option verify_recipient routers&!? boolean true
17237 If this option is false, the router is skipped when verifying recipient
17238 addresses
17239 or testing recipient verification using &%-bv%&.
17240 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17241 are evaluated.
17242
17243
17244 .option verify_sender routers&!? boolean true
17245 If this option is false, the router is skipped when verifying sender addresses
17246 or testing sender verification using &%-bvs%&.
17247 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17248 are evaluated.
17249 .ecindex IIDgenoprou1
17250 .ecindex IIDgenoprou2
17251
17252
17253
17254
17255
17256
17257 . ////////////////////////////////////////////////////////////////////////////
17258 . ////////////////////////////////////////////////////////////////////////////
17259
17260 .chapter "The accept router" "CHID4"
17261 .cindex "&(accept)& router"
17262 .cindex "routers" "&(accept)&"
17263 The &(accept)& router has no private options of its own. Unless it is being
17264 used purely for verification (see &%verify_only%&) a transport is required to
17265 be defined by the generic &%transport%& option. If the preconditions that are
17266 specified by generic options are met, the router accepts the address and queues
17267 it for the given transport. The most common use of this router is for setting
17268 up deliveries to local mailboxes. For example:
17269 .code
17270 localusers:
17271   driver = accept
17272   domains = mydomain.example
17273   check_local_user
17274   transport = local_delivery
17275 .endd
17276 The &%domains%& condition in this example checks the domain of the address, and
17277 &%check_local_user%& checks that the local part is the login of a local user.
17278 When both preconditions are met, the &(accept)& router runs, and queues the
17279 address for the &(local_delivery)& transport.
17280
17281
17282
17283
17284
17285
17286 . ////////////////////////////////////////////////////////////////////////////
17287 . ////////////////////////////////////////////////////////////////////////////
17288
17289 .chapter "The dnslookup router" "CHAPdnslookup"
17290 .scindex IIDdnsrou1 "&(dnslookup)& router"
17291 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17292 The &(dnslookup)& router looks up the hosts that handle mail for the
17293 recipient's domain in the DNS. A transport must always be set for this router,
17294 unless &%verify_only%& is set.
17295
17296 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17297 SRV records. If none are found, or if SRV support is not configured,
17298 MX records are looked up. If no MX records exist, address records are sought.
17299 However, &%mx_domains%& can be set to disable the direct use of address
17300 records.
17301
17302 MX records of equal priority are sorted by Exim into a random order. Exim then
17303 looks for address records for the host names obtained from MX or SRV records.
17304 When a host has more than one IP address, they are sorted into a random order,
17305 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17306 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17307 generic option, the router declines.
17308
17309 Unless they have the highest priority (lowest MX value), MX records that point
17310 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17311 are discarded, together with any other MX records of equal or lower priority.
17312
17313 .cindex "MX record" "pointing to local host"
17314 .cindex "local host" "MX pointing to"
17315 .oindex "&%self%&" "in &(dnslookup)& router"
17316 If the host pointed to by the highest priority MX record, or looked up as an
17317 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17318 happens is controlled by the generic &%self%& option.
17319
17320
17321 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17322 There have been problems with DNS servers when SRV records are looked up.
17323 Some mis-behaving servers return a DNS error or timeout when a non-existent
17324 SRV record is sought. Similar problems have in the past been reported for
17325 MX records. The global &%dns_again_means_nonexist%& option can help with this
17326 problem, but it is heavy-handed because it is a global option.
17327
17328 For this reason, there are two options, &%srv_fail_domains%& and
17329 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17330 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17331 an attempt to look up an SRV or MX record causes one of these results, and the
17332 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17333 such record"&. In the case of an SRV lookup, this means that the router
17334 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17335 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17336 case routing fails.
17337
17338
17339 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17340 .cindex "&(dnslookup)& router" "declines"
17341 There are a few cases where a &(dnslookup)& router will decline to accept
17342 an address; if such a router is expected to handle "all remaining non-local
17343 domains", then it is important to set &%no_more%&.
17344
17345 Reasons for a &(dnslookup)& router to decline currently include:
17346 .ilist
17347 The domain does not exist in DNS
17348 .next
17349 The domain exists but the MX record's host part is just "."; this is a common
17350 convention (borrowed from SRV) used to indicate that there is no such service
17351 for this domain and to not fall back to trying A/AAAA records.
17352 .next
17353 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17354 .next
17355 MX record points to a non-existent host.
17356 .next
17357 MX record points to an IP address and the main section option
17358 &%allow_mx_to_ip%& is not set.
17359 .next
17360 MX records exist and point to valid hosts, but all hosts resolve only to
17361 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17362 .next
17363 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17364 &%dns_check_names_pattern%& for handling one variant of this)
17365 .next
17366 &%check_secondary_mx%& is set on this router but the local host can
17367 not be found in the MX records (see below)
17368 .endlist
17369
17370
17371
17372
17373 .section "Private options for dnslookup" "SECID118"
17374 .cindex "options" "&(dnslookup)& router"
17375 The private options for the &(dnslookup)& router are as follows:
17376
17377 .option check_secondary_mx dnslookup boolean false
17378 .cindex "MX record" "checking for secondary"
17379 If this option is set, the router declines unless the local host is found in
17380 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17381 process domains for which the local host is a secondary mail exchanger
17382 differently to other domains. The way in which Exim decides whether a host is
17383 the local host is described in section &<<SECTreclocipadd>>&.
17384
17385
17386 .option check_srv dnslookup string&!! unset
17387 .cindex "SRV record" "enabling use of"
17388 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17389 addition to MX and address records. The support is disabled by default. To
17390 enable SRV support, set the &%check_srv%& option to the name of the service
17391 required. For example,
17392 .code
17393 check_srv = smtp
17394 .endd
17395 looks for SRV records that refer to the normal smtp service. The option is
17396 expanded, so the service name can vary from message to message or address
17397 to address. This might be helpful if SRV records are being used for a
17398 submission service. If the expansion is forced to fail, the &%check_srv%&
17399 option is ignored, and the router proceeds to look for MX records in the
17400 normal way.
17401
17402 When the expansion succeeds, the router searches first for SRV records for
17403 the given service (it assumes TCP protocol). A single SRV record with a
17404 host name that consists of just a single dot indicates &"no such service for
17405 this domain"&; if this is encountered, the router declines. If other kinds of
17406 SRV record are found, they are used to construct a host list for delivery
17407 according to the rules of RFC 2782. MX records are not sought in this case.
17408
17409 When no SRV records are found, MX records (and address records) are sought in
17410 the traditional way. In other words, SRV records take precedence over MX
17411 records, just as MX records take precedence over address records. Note that
17412 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17413 defined it. It is apparently believed that MX records are sufficient for email
17414 and that SRV records should not be used for this purpose. However, SRV records
17415 have an additional &"weight"& feature which some people might find useful when
17416 trying to split an SMTP load between hosts of different power.
17417
17418 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17419 when there is a DNS lookup error.
17420
17421
17422
17423 .option mx_domains dnslookup "domain list&!!" unset
17424 .cindex "MX record" "required to exist"
17425 .cindex "SRV record" "required to exist"
17426 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17427 record in order to be recognized. (The name of this option could be improved.)
17428 For example, if all the mail hosts in &'fict.example'& are known to have MX
17429 records, except for those in &'discworld.fict.example'&, you could use this
17430 setting:
17431 .code
17432 mx_domains = ! *.discworld.fict.example : *.fict.example
17433 .endd
17434 This specifies that messages addressed to a domain that matches the list but
17435 has no MX record should be bounced immediately instead of being routed using
17436 the address record.
17437
17438
17439 .option mx_fail_domains dnslookup "domain list&!!" unset
17440 If the DNS lookup for MX records for one of the domains in this list causes a
17441 DNS lookup error, Exim behaves as if no MX records were found. See section
17442 &<<SECTprowitdnsloo>>& for more discussion.
17443
17444
17445
17446
17447 .option qualify_single dnslookup boolean true
17448 .cindex "DNS" "resolver options"
17449 .cindex "DNS" "qualifying single-component names"
17450 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17451 lookups. Typically, but not standardly, this causes the resolver to qualify
17452 single-component names with the default domain. For example, on a machine
17453 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17454 &'thesaurus.ref.example'& inside the resolver. For details of what your
17455 resolver actually does, consult your man pages for &'resolver'& and
17456 &'resolv.conf'&.
17457
17458
17459
17460 .option rewrite_headers dnslookup boolean true
17461 .cindex "rewriting" "header lines"
17462 .cindex "header lines" "rewriting"
17463 If the domain name in the address that is being processed is not fully
17464 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17465 an address is specified as &'dormouse@teaparty'&, the domain might be
17466 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17467 occur as a result of setting the &%widen_domains%& option. If
17468 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17469 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17470 header lines of the message are rewritten with the full domain name.
17471
17472 This option should be turned off only when it is known that no message is
17473 ever going to be sent outside an environment where the abbreviation makes
17474 sense.
17475
17476 When an MX record is looked up in the DNS and matches a wildcard record, name
17477 servers normally return a record containing the name that has been looked up,
17478 making it impossible to detect whether a wildcard was present or not. However,
17479 some name servers have recently been seen to return the wildcard entry. If the
17480 name returned by a DNS lookup begins with an asterisk, it is not used for
17481 header rewriting.
17482
17483
17484 .option same_domain_copy_routing dnslookup boolean false
17485 .cindex "address" "copying routing"
17486 Addresses with the same domain are normally routed by the &(dnslookup)& router
17487 to the same list of hosts. However, this cannot be presumed, because the router
17488 options and preconditions may refer to the local part of the address. By
17489 default, therefore, Exim routes each address in a message independently. DNS
17490 servers run caches, so repeated DNS lookups are not normally expensive, and in
17491 any case, personal messages rarely have more than a few recipients.
17492
17493 If you are running mailing lists with large numbers of subscribers at the same
17494 domain, and you are using a &(dnslookup)& router which is independent of the
17495 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17496 lookups for identical domains in one message. In this case, when &(dnslookup)&
17497 routes an address to a remote transport, any other unrouted addresses in the
17498 message that have the same domain are automatically given the same routing
17499 without processing them independently,
17500 provided the following conditions are met:
17501
17502 .ilist
17503 No router that processed the address specified &%headers_add%& or
17504 &%headers_remove%&.
17505 .next
17506 The router did not change the address in any way, for example, by &"widening"&
17507 the domain.
17508 .endlist
17509
17510
17511
17512
17513 .option search_parents dnslookup boolean false
17514 .cindex "DNS" "resolver options"
17515 When this option is true, the resolver option RES_DNSRCH is set for DNS
17516 lookups. This is different from the &%qualify_single%& option in that it
17517 applies to domains containing dots. Typically, but not standardly, it causes
17518 the resolver to search for the name in the current domain and in parent
17519 domains. For example, on a machine in the &'fict.example'& domain, if looking
17520 up &'teaparty.wonderland'& failed, the resolver would try
17521 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17522 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17523
17524 Setting this option true can cause problems in domains that have a wildcard MX
17525 record, because any domain that does not have its own MX record matches the
17526 local wildcard.
17527
17528
17529
17530 .option srv_fail_domains dnslookup "domain list&!!" unset
17531 If the DNS lookup for SRV records for one of the domains in this list causes a
17532 DNS lookup error, Exim behaves as if no SRV records were found. See section
17533 &<<SECTprowitdnsloo>>& for more discussion.
17534
17535
17536
17537
17538 .option widen_domains dnslookup "string list" unset
17539 .cindex "domain" "partial; widening"
17540 If a DNS lookup fails and this option is set, each of its strings in turn is
17541 added onto the end of the domain, and the lookup is tried again. For example,
17542 if
17543 .code
17544 widen_domains = fict.example:ref.example
17545 .endd
17546 is set and a lookup of &'klingon.dictionary'& fails,
17547 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17548 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17549 and &%search_parents%& options can cause some widening to be undertaken inside
17550 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17551 when verifying, unless &%rewrite_headers%& is false (not the default).
17552
17553
17554 .section "Effect of qualify_single and search_parents" "SECID119"
17555 When a domain from an envelope recipient is changed by the resolver as a result
17556 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17557 corresponding address in the message's header lines unless &%rewrite_headers%&
17558 is set false. Exim then re-routes the address, using the full domain.
17559
17560 These two options affect only the DNS lookup that takes place inside the router
17561 for the domain of the address that is being routed. They do not affect lookups
17562 such as that implied by
17563 .code
17564 domains = @mx_any
17565 .endd
17566 that may happen while processing a router precondition before the router is
17567 entered. No widening ever takes place for these lookups.
17568 .ecindex IIDdnsrou1
17569 .ecindex IIDdnsrou2
17570
17571
17572
17573
17574
17575
17576
17577
17578
17579 . ////////////////////////////////////////////////////////////////////////////
17580 . ////////////////////////////////////////////////////////////////////////////
17581
17582 .chapter "The ipliteral router" "CHID5"
17583 .cindex "&(ipliteral)& router"
17584 .cindex "domain literal" "routing"
17585 .cindex "routers" "&(ipliteral)&"
17586 This router has no private options. Unless it is being used purely for
17587 verification (see &%verify_only%&) a transport is required to be defined by the
17588 generic &%transport%& option. The router accepts the address if its domain part
17589 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17590 router handles the address
17591 .code
17592 root@[192.168.1.1]
17593 .endd
17594 by setting up delivery to the host with that IP address. IPv4 domain literals
17595 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17596 are similar, but the address is preceded by &`ipv6:`&. For example:
17597 .code
17598 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17599 .endd
17600 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17601 grounds that sooner or later somebody will try it.
17602
17603 .oindex "&%self%&" "in &(ipliteral)& router"
17604 If the IP address matches something in &%ignore_target_hosts%&, the router
17605 declines. If an IP literal turns out to refer to the local host, the generic
17606 &%self%& option determines what happens.
17607
17608 The RFCs require support for domain literals; however, their use is
17609 controversial in today's Internet. If you want to use this router, you must
17610 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17611 Exim will not recognize the domain literal syntax in addresses.
17612
17613
17614
17615 . ////////////////////////////////////////////////////////////////////////////
17616 . ////////////////////////////////////////////////////////////////////////////
17617
17618 .chapter "The iplookup router" "CHID6"
17619 .cindex "&(iplookup)& router"
17620 .cindex "routers" "&(iplookup)&"
17621 The &(iplookup)& router was written to fulfil a specific requirement in
17622 Cambridge University (which in fact no longer exists). For this reason, it is
17623 not included in the binary of Exim by default. If you want to include it, you
17624 must set
17625 .code
17626 ROUTER_IPLOOKUP=yes
17627 .endd
17628 in your &_Local/Makefile_& configuration file.
17629
17630 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17631 connection to one or more specific hosts. The host can then return the same or
17632 a different address &-- in effect rewriting the recipient address in the
17633 message's envelope. The new address is then passed on to subsequent routers. If
17634 this process fails, the address can be passed on to other routers, or delivery
17635 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17636 must not be specified for it.
17637
17638 .cindex "options" "&(iplookup)& router"
17639 .option hosts iplookup string unset
17640 This option must be supplied. Its value is a colon-separated list of host
17641 names. The hosts are looked up using &[gethostbyname()]&
17642 (or &[getipnodebyname()]& when available)
17643 and are tried in order until one responds to the query. If none respond, what
17644 happens is controlled by &%optional%&.
17645
17646
17647 .option optional iplookup boolean false
17648 If &%optional%& is true, if no response is obtained from any host, the address
17649 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17650 delivery to the address is deferred.
17651
17652
17653 .option port iplookup integer 0
17654 .cindex "port" "&(iplookup)& router"
17655 This option must be supplied. It specifies the port number for the TCP or UDP
17656 call.
17657
17658
17659 .option protocol iplookup string udp
17660 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17661 protocols is to be used.
17662
17663
17664 .option query iplookup string&!! "see below"
17665 This defines the content of the query that is sent to the remote hosts. The
17666 default value is:
17667 .code
17668 $local_part@$domain $local_part@$domain
17669 .endd
17670 The repetition serves as a way of checking that a response is to the correct
17671 query in the default case (see &%response_pattern%& below).
17672
17673
17674 .option reroute iplookup string&!! unset
17675 If this option is not set, the rerouted address is precisely the byte string
17676 returned by the remote host, up to the first white space, if any. If set, the
17677 string is expanded to form the rerouted address. It can include parts matched
17678 in the response by &%response_pattern%& by means of numeric variables such as
17679 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17680 whether or not a pattern is in use. In all cases, the rerouted address must end
17681 up in the form &'local_part@domain'&.
17682
17683
17684 .option response_pattern iplookup string unset
17685 This option can be set to a regular expression that is applied to the string
17686 returned from the remote host. If the pattern does not match the response, the
17687 router declines. If &%response_pattern%& is not set, no checking of the
17688 response is done, unless the query was defaulted, in which case there is a
17689 check that the text returned after the first white space is the original
17690 address. This checks that the answer that has been received is in response to
17691 the correct question. For example, if the response is just a new domain, the
17692 following could be used:
17693 .code
17694 response_pattern = ^([^@]+)$
17695 reroute = $local_part@$1
17696 .endd
17697
17698 .option timeout iplookup time 5s
17699 This specifies the amount of time to wait for a response from the remote
17700 machine. The same timeout is used for the &[connect()]& function for a TCP
17701 call. It does not apply to UDP.
17702
17703
17704
17705
17706 . ////////////////////////////////////////////////////////////////////////////
17707 . ////////////////////////////////////////////////////////////////////////////
17708
17709 .chapter "The manualroute router" "CHID7"
17710 .scindex IIDmanrou1 "&(manualroute)& router"
17711 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17712 .cindex "domain" "manually routing"
17713 The &(manualroute)& router is so-called because it provides a way of manually
17714 routing an address according to its domain. It is mainly used when you want to
17715 route addresses to remote hosts according to your own rules, bypassing the
17716 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17717 route to local transports, a facility that may be useful if you want to save
17718 messages for dial-in hosts in local files.
17719
17720 The &(manualroute)& router compares a list of domain patterns with the domain
17721 it is trying to route. If there is no match, the router declines. Each pattern
17722 has associated with it a list of hosts and some other optional data, which may
17723 include a transport. The combination of a pattern and its data is called a
17724 &"routing rule"&. For patterns that do not have an associated transport, the
17725 generic &%transport%& option must specify a transport, unless the router is
17726 being used purely for verification (see &%verify_only%&).
17727
17728 .vindex "&$host$&"
17729 In the case of verification, matching the domain pattern is sufficient for the
17730 router to accept the address. When actually routing an address for delivery,
17731 an address that matches a domain pattern is queued for the associated
17732 transport. If the transport is not a local one, a host list must be associated
17733 with the pattern; IP addresses are looked up for the hosts, and these are
17734 passed to the transport along with the mail address. For local transports, a
17735 host list is optional. If it is present, it is passed in &$host$& as a single
17736 text string.
17737
17738 The list of routing rules can be provided as an inline string in
17739 &%route_list%&, or the data can be obtained by looking up the domain in a file
17740 or database by setting &%route_data%&. Only one of these settings may appear in
17741 any one instance of &(manualroute)&. The format of routing rules is described
17742 below, following the list of private options.
17743
17744
17745 .section "Private options for manualroute" "SECTprioptman"
17746
17747 .cindex "options" "&(manualroute)& router"
17748 The private options for the &(manualroute)& router are as follows:
17749
17750 .option host_all_ignored manualroute string defer
17751 See &%host_find_failed%&.
17752
17753 .option host_find_failed manualroute string freeze
17754 This option controls what happens when &(manualroute)& tries to find an IP
17755 address for a host, and the host does not exist. The option can be set to one
17756 of the following values:
17757 .code
17758 decline
17759 defer
17760 fail
17761 freeze
17762 ignore
17763 pass
17764 .endd
17765 The default (&"freeze"&) assumes that this state is a serious configuration
17766 error. The difference between &"pass"& and &"decline"& is that the former
17767 forces the address to be passed to the next router (or the router defined by
17768 &%pass_router%&),
17769 .oindex "&%more%&"
17770 overriding &%no_more%&, whereas the latter passes the address to the next
17771 router only if &%more%& is true.
17772
17773 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17774 cannot be found. If all the hosts in the list are ignored, the behaviour is
17775 controlled by the &%host_all_ignored%& option. This takes the same values
17776 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17777
17778 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17779 state; if a host lookup gets a temporary error, delivery is deferred unless the
17780 generic &%pass_on_timeout%& option is set.
17781
17782
17783 .option hosts_randomize manualroute boolean false
17784 .cindex "randomized host list"
17785 .cindex "host" "list of; randomized"
17786 If this option is set, the order of the items in a host list in a routing rule
17787 is randomized each time the list is used, unless an option in the routing rule
17788 overrides (see below). Randomizing the order of a host list can be used to do
17789 crude load sharing. However, if more than one mail address is routed by the
17790 same router to the same host list, the host lists are considered to be the same
17791 (even though they may be randomized into different orders) for the purpose of
17792 deciding whether to batch the deliveries into a single SMTP transaction.
17793
17794 When &%hosts_randomize%& is true, a host list may be split
17795 into groups whose order is separately randomized. This makes it possible to
17796 set up MX-like behaviour. The boundaries between groups are indicated by an
17797 item that is just &`+`& in the host list. For example:
17798 .code
17799 route_list = * host1:host2:host3:+:host4:host5
17800 .endd
17801 The order of the first three hosts and the order of the last two hosts is
17802 randomized for each use, but the first three always end up before the last two.
17803 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17804 randomized host list is passed to an &(smtp)& transport that also has
17805 &%hosts_randomize set%&, the list is not re-randomized.
17806
17807
17808 .option route_data manualroute string&!! unset
17809 If this option is set, it must expand to yield the data part of a routing rule.
17810 Typically, the expansion string includes a lookup based on the domain. For
17811 example:
17812 .code
17813 route_data = ${lookup{$domain}dbm{/etc/routes}}
17814 .endd
17815 If the expansion is forced to fail, or the result is an empty string, the
17816 router declines. Other kinds of expansion failure cause delivery to be
17817 deferred.
17818
17819
17820 .option route_list manualroute "string list" unset
17821 This string is a list of routing rules, in the form defined below. Note that,
17822 unlike most string lists, the items are separated by semicolons. This is so
17823 that they may contain colon-separated host lists.
17824
17825
17826 .option same_domain_copy_routing manualroute boolean false
17827 .cindex "address" "copying routing"
17828 Addresses with the same domain are normally routed by the &(manualroute)&
17829 router to the same list of hosts. However, this cannot be presumed, because the
17830 router options and preconditions may refer to the local part of the address. By
17831 default, therefore, Exim routes each address in a message independently. DNS
17832 servers run caches, so repeated DNS lookups are not normally expensive, and in
17833 any case, personal messages rarely have more than a few recipients.
17834
17835 If you are running mailing lists with large numbers of subscribers at the same
17836 domain, and you are using a &(manualroute)& router which is independent of the
17837 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17838 lookups for identical domains in one message. In this case, when
17839 &(manualroute)& routes an address to a remote transport, any other unrouted
17840 addresses in the message that have the same domain are automatically given the
17841 same routing without processing them independently. However, this is only done
17842 if &%headers_add%& and &%headers_remove%& are unset.
17843
17844
17845
17846
17847 .section "Routing rules in route_list" "SECID120"
17848 The value of &%route_list%& is a string consisting of a sequence of routing
17849 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17850 entered as two semicolons. Alternatively, the list separator can be changed as
17851 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17852 Empty rules are ignored. The format of each rule is
17853 .display
17854 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17855 .endd
17856 The following example contains two rules, each with a simple domain pattern and
17857 no options:
17858 .code
17859 route_list = \
17860   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17861   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17862 .endd
17863 The three parts of a rule are separated by white space. The pattern and the
17864 list of hosts can be enclosed in quotes if necessary, and if they are, the
17865 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17866 single domain pattern, which is the only mandatory item in the rule. The
17867 pattern is in the same format as one item in a domain list (see section
17868 &<<SECTdomainlist>>&),
17869 except that it may not be the name of an interpolated file.
17870 That is, it may be wildcarded, or a regular expression, or a file or database
17871 lookup (with semicolons doubled, because of the use of semicolon as a separator
17872 in a &%route_list%&).
17873
17874 The rules in &%route_list%& are searched in order until one of the patterns
17875 matches the domain that is being routed. The list of hosts and then options are
17876 then used as described below. If there is no match, the router declines. When
17877 &%route_list%& is set, &%route_data%& must not be set.
17878
17879
17880
17881 .section "Routing rules in route_data" "SECID121"
17882 The use of &%route_list%& is convenient when there are only a small number of
17883 routing rules. For larger numbers, it is easier to use a file or database to
17884 hold the routing information, and use the &%route_data%& option instead.
17885 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17886 Most commonly, &%route_data%& is set as a string that contains an
17887 expansion lookup. For example, suppose we place two routing rules in a file
17888 like this:
17889 .code
17890 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17891 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17892 .endd
17893 This data can be accessed by setting
17894 .code
17895 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17896 .endd
17897 Failure of the lookup results in an empty string, causing the router to
17898 decline. However, you do not have to use a lookup in &%route_data%&. The only
17899 requirement is that the result of expanding the string is a list of hosts,
17900 possibly followed by options, separated by white space. The list of hosts must
17901 be enclosed in quotes if it contains white space.
17902
17903
17904
17905
17906 .section "Format of the list of hosts" "SECID122"
17907 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17908 always separately expanded before use. If the expansion fails, the router
17909 declines. The result of the expansion must be a colon-separated list of names
17910 and/or IP addresses, optionally also including ports. The format of each item
17911 in the list is described in the next section. The list separator can be changed
17912 as described in section &<<SECTlistconstruct>>&.
17913
17914 If the list of hosts was obtained from a &%route_list%& item, the following
17915 variables are set during its expansion:
17916
17917 .ilist
17918 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17919 If the domain was matched against a regular expression, the numeric variables
17920 &$1$&, &$2$&, etc. may be set. For example:
17921 .code
17922 route_list = ^domain(\d+)   host-$1.text.example
17923 .endd
17924 .next
17925 &$0$& is always set to the entire domain.
17926 .next
17927 &$1$& is also set when partial matching is done in a file lookup.
17928
17929 .next
17930 .vindex "&$value$&"
17931 If the pattern that matched the domain was a lookup item, the data that was
17932 looked up is available in the expansion variable &$value$&. For example:
17933 .code
17934 route_list = lsearch;;/some/file.routes  $value
17935 .endd
17936 .endlist
17937
17938 Note the doubling of the semicolon in the pattern that is necessary because
17939 semicolon is the default route list separator.
17940
17941
17942
17943 .section "Format of one host item" "SECTformatonehostitem"
17944 Each item in the list of hosts is either a host name or an IP address,
17945 optionally with an attached port number. When no port is given, an IP address
17946 is not enclosed in brackets. When a port is specified, it overrides the port
17947 specification on the transport. The port is separated from the name or address
17948 by a colon. This leads to some complications:
17949
17950 .ilist
17951 Because colon is the default separator for the list of hosts, either
17952 the colon that specifies a port must be doubled, or the list separator must
17953 be changed. The following two examples have the same effect:
17954 .code
17955 route_list = * "host1.tld::1225 : host2.tld::1226"
17956 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17957 .endd
17958 .next
17959 When IPv6 addresses are involved, it gets worse, because they contain
17960 colons of their own. To make this case easier, it is permitted to
17961 enclose an IP address (either v4 or v6) in square brackets if a port
17962 number follows. For example:
17963 .code
17964 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17965 .endd
17966 .endlist
17967
17968 .section "How the list of hosts is used" "SECThostshowused"
17969 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17970 the hosts is tried, in the order specified, when carrying out the SMTP
17971 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17972 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17973 transport.
17974
17975 Hosts may be listed by name or by IP address. An unadorned name in the list of
17976 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17977 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17978 records in the DNS. For example:
17979 .code
17980 route_list = *  x.y.z:p.q.r/MX:e.f.g
17981 .endd
17982 If this feature is used with a port specifier, the port must come last. For
17983 example:
17984 .code
17985 route_list = *  dom1.tld/mx::1225
17986 .endd
17987 If the &%hosts_randomize%& option is set, the order of the items in the list is
17988 randomized before any lookups are done. Exim then scans the list; for any name
17989 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17990 be an interface on the local host and the item is not the first in the list,
17991 Exim discards it and any subsequent items. If it is the first item, what
17992 happens is controlled by the
17993 .oindex "&%self%&" "in &(manualroute)& router"
17994 &%self%& option of the router.
17995
17996 A name on the list that is followed by &`/MX`& is replaced with the list of
17997 hosts obtained by looking up MX records for the name. This is always a DNS
17998 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17999 below) are not relevant here. The order of these hosts is determined by the
18000 preference values in the MX records, according to the usual rules. Because
18001 randomizing happens before the MX lookup, it does not affect the order that is
18002 defined by MX preferences.
18003
18004 If the local host is present in the sublist obtained from MX records, but is
18005 not the most preferred host in that list, it and any equally or less
18006 preferred hosts are removed before the sublist is inserted into the main list.
18007
18008 If the local host is the most preferred host in the MX list, what happens
18009 depends on where in the original list of hosts the &`/MX`& item appears. If it
18010 is not the first item (that is, there are previous hosts in the main list),
18011 Exim discards this name and any subsequent items in the main list.
18012
18013 If the MX item is first in the list of hosts, and the local host is the
18014 most preferred host, what happens is controlled by the &%self%& option of the
18015 router.
18016
18017 DNS failures when lookup up the MX records are treated in the same way as DNS
18018 failures when looking up IP addresses: &%pass_on_timeout%& and
18019 &%host_find_failed%& are used when relevant.
18020
18021 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18022 whether obtained from an MX lookup or not.
18023
18024
18025
18026 .section "How the options are used" "SECThowoptused"
18027 The options are a sequence of words; in practice no more than three are ever
18028 present. One of the words can be the name of a transport; this overrides the
18029 &%transport%& option on the router for this particular routing rule only. The
18030 other words (if present) control randomization of the list of hosts on a
18031 per-rule basis, and how the IP addresses of the hosts are to be found when
18032 routing to a remote transport. These options are as follows:
18033
18034 .ilist
18035 &%randomize%&: randomize the order of the hosts in this list, overriding the
18036 setting of &%hosts_randomize%& for this routing rule only.
18037 .next
18038 &%no_randomize%&: do not randomize the order of the hosts in this list,
18039 overriding the setting of &%hosts_randomize%& for this routing rule only.
18040 .next
18041 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18042 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18043 also look in &_/etc/hosts_& or other sources of information.
18044 .next
18045 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18046 no address records are found. If there is a temporary DNS error (such as a
18047 timeout), delivery is deferred.
18048 .endlist
18049
18050 For example:
18051 .code
18052 route_list = domain1  host1:host2:host3  randomize bydns;\
18053              domain2  host4:host5
18054 .endd
18055 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18056 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18057 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18058 or &[gethostbyname()]&, and the result of the lookup is the result of that
18059 call.
18060
18061 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18062 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18063 instead of TRY_AGAIN. That is why the default action is to try a DNS
18064 lookup first. Only if that gives a definite &"no such host"& is the local
18065 function called.
18066
18067
18068
18069 If no IP address for a host can be found, what happens is controlled by the
18070 &%host_find_failed%& option.
18071
18072 .vindex "&$host$&"
18073 When an address is routed to a local transport, IP addresses are not looked up.
18074 The host list is passed to the transport in the &$host$& variable.
18075
18076
18077
18078 .section "Manualroute examples" "SECID123"
18079 In some of the examples that follow, the presence of the &%remote_smtp%&
18080 transport, as defined in the default configuration file, is assumed:
18081
18082 .ilist
18083 .cindex "smart host" "example router"
18084 The &(manualroute)& router can be used to forward all external mail to a
18085 &'smart host'&. If you have set up, in the main part of the configuration, a
18086 named domain list that contains your local domains, for example:
18087 .code
18088 domainlist local_domains = my.domain.example
18089 .endd
18090 You can arrange for all other domains to be routed to a smart host by making
18091 your first router something like this:
18092 .code
18093 smart_route:
18094   driver = manualroute
18095   domains = !+local_domains
18096   transport = remote_smtp
18097   route_list = * smarthost.ref.example
18098 .endd
18099 This causes all non-local addresses to be sent to the single host
18100 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18101 they are tried in order
18102 (but you can use &%hosts_randomize%& to vary the order each time).
18103 Another way of configuring the same thing is this:
18104 .code
18105 smart_route:
18106   driver = manualroute
18107   transport = remote_smtp
18108   route_list = !+local_domains  smarthost.ref.example
18109 .endd
18110 There is no difference in behaviour between these two routers as they stand.
18111 However, they behave differently if &%no_more%& is added to them. In the first
18112 example, the router is skipped if the domain does not match the &%domains%&
18113 precondition; the following router is always tried. If the router runs, it
18114 always matches the domain and so can never decline. Therefore, &%no_more%&
18115 would have no effect. In the second case, the router is never skipped; it
18116 always runs. However, if it doesn't match the domain, it declines. In this case
18117 &%no_more%& would prevent subsequent routers from running.
18118
18119 .next
18120 .cindex "mail hub example"
18121 A &'mail hub'& is a host which receives mail for a number of domains via MX
18122 records in the DNS and delivers it via its own private routing mechanism. Often
18123 the final destinations are behind a firewall, with the mail hub being the one
18124 machine that can connect to machines both inside and outside the firewall. The
18125 &(manualroute)& router is usually used on a mail hub to route incoming messages
18126 to the correct hosts. For a small number of domains, the routing can be inline,
18127 using the &%route_list%& option, but for a larger number a file or database
18128 lookup is easier to manage.
18129
18130 If the domain names are in fact the names of the machines to which the mail is
18131 to be sent by the mail hub, the configuration can be quite simple. For
18132 example:
18133 .code
18134 hub_route:
18135   driver = manualroute
18136   transport = remote_smtp
18137   route_list = *.rhodes.tvs.example  $domain
18138 .endd
18139 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18140 whose names are the same as the mail domains. A similar approach can be taken
18141 if the host name can be obtained from the domain name by a string manipulation
18142 that the expansion facilities can handle. Otherwise, a lookup based on the
18143 domain can be used to find the host:
18144 .code
18145 through_firewall:
18146   driver = manualroute
18147   transport = remote_smtp
18148   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18149 .endd
18150 The result of the lookup must be the name or IP address of the host (or
18151 hosts) to which the address is to be routed. If the lookup fails, the route
18152 data is empty, causing the router to decline. The address then passes to the
18153 next router.
18154
18155 .next
18156 .cindex "batched SMTP output example"
18157 .cindex "SMTP" "batched outgoing; example"
18158 You can use &(manualroute)& to deliver messages to pipes or files in batched
18159 SMTP format for onward transportation by some other means. This is one way of
18160 storing mail for a dial-up host when it is not connected. The route list entry
18161 can be as simple as a single domain name in a configuration like this:
18162 .code
18163 save_in_file:
18164   driver = manualroute
18165   transport = batchsmtp_appendfile
18166   route_list = saved.domain.example
18167 .endd
18168 though often a pattern is used to pick up more than one domain. If there are
18169 several domains or groups of domains with different transport requirements,
18170 different transports can be listed in the routing information:
18171 .code
18172 save_in_file:
18173   driver = manualroute
18174   route_list = \
18175     *.saved.domain1.example  $domain  batch_appendfile; \
18176     *.saved.domain2.example  \
18177       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18178       batch_pipe
18179 .endd
18180 .vindex "&$domain$&"
18181 .vindex "&$host$&"
18182 The first of these just passes the domain in the &$host$& variable, which
18183 doesn't achieve much (since it is also in &$domain$&), but the second does a
18184 file lookup to find a value to pass, causing the router to decline to handle
18185 the address if the lookup fails.
18186
18187 .next
18188 .cindex "UUCP" "example of router for"
18189 Routing mail directly to UUCP software is a specific case of the use of
18190 &(manualroute)& in a gateway to another mail environment. This is an example of
18191 one way it can be done:
18192 .code
18193 # Transport
18194 uucp:
18195   driver = pipe
18196   user = nobody
18197   command = /usr/local/bin/uux -r - \
18198     ${substr_-5:$host}!rmail ${local_part}
18199   return_fail_output = true
18200
18201 # Router
18202 uucphost:
18203   transport = uucp
18204   driver = manualroute
18205   route_data = \
18206     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18207 .endd
18208 The file &_/usr/local/exim/uucphosts_& contains entries like
18209 .code
18210 darksite.ethereal.example:           darksite.UUCP
18211 .endd
18212 It can be set up more simply without adding and removing &".UUCP"& but this way
18213 makes clear the distinction between the domain name
18214 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18215 .endlist
18216 .ecindex IIDmanrou1
18217 .ecindex IIDmanrou2
18218
18219
18220
18221
18222
18223
18224
18225
18226 . ////////////////////////////////////////////////////////////////////////////
18227 . ////////////////////////////////////////////////////////////////////////////
18228
18229 .chapter "The queryprogram router" "CHAPdriverlast"
18230 .scindex IIDquerou1 "&(queryprogram)& router"
18231 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18232 .cindex "routing" "by external program"
18233 The &(queryprogram)& router routes an address by running an external command
18234 and acting on its output. This is an expensive way to route, and is intended
18235 mainly for use in lightly-loaded systems, or for performing experiments.
18236 However, if it is possible to use the precondition options (&%domains%&,
18237 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18238 be used in special cases, even on a busy host. There are the following private
18239 options:
18240 .cindex "options" "&(queryprogram)& router"
18241
18242 .option command queryprogram string&!! unset
18243 This option must be set. It specifies the command that is to be run. The
18244 command is split up into a command name and arguments, and then each is
18245 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18246 &<<CHAPpipetransport>>&).
18247
18248
18249 .option command_group queryprogram string unset
18250 .cindex "gid (group id)" "in &(queryprogram)& router"
18251 This option specifies a gid to be set when running the command while routing an
18252 address for deliver. It must be set if &%command_user%& specifies a numerical
18253 uid. If it begins with a digit, it is interpreted as the numerical value of the
18254 gid. Otherwise it is looked up using &[getgrnam()]&.
18255
18256
18257 .option command_user queryprogram string unset
18258 .cindex "uid (user id)" "for &(queryprogram)&"
18259 This option must be set. It specifies the uid which is set when running the
18260 command while routing an address for delivery. If the value begins with a digit,
18261 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18262 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18263 not set, a value for the gid also.
18264
18265 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18266 root, which it does during a normal delivery in a conventional configuration.
18267 However, when an address is being verified during message reception, Exim is
18268 usually running as the Exim user, not as root. If the &(queryprogram)& router
18269 is called from a non-root process, Exim cannot change uid or gid before running
18270 the command. In this circumstance the command runs under the current uid and
18271 gid.
18272
18273
18274 .option current_directory queryprogram string /
18275 This option specifies an absolute path which is made the current directory
18276 before running the command.
18277
18278
18279 .option timeout queryprogram time 1h
18280 If the command does not complete within the timeout period, its process group
18281 is killed and the message is frozen. A value of zero time specifies no
18282 timeout.
18283
18284
18285 The standard output of the command is connected to a pipe, which is read when
18286 the command terminates. It should consist of a single line of output,
18287 containing up to five fields, separated by white space. The maximum length of
18288 the line is 1023 characters. Longer lines are silently truncated. The first
18289 field is one of the following words (case-insensitive):
18290
18291 .ilist
18292 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18293 below).
18294 .next
18295 &'Decline'&: the router declines; pass the address to the next router, unless
18296 &%no_more%& is set.
18297 .next
18298 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18299 subsequent text on the line is an error message. If the router is run as part
18300 of address verification during an incoming SMTP message, the message is
18301 included in the SMTP response.
18302 .next
18303 &'Defer'&: routing could not be completed at this time; try again later. Any
18304 subsequent text on the line is an error message which is logged. It is not
18305 included in any SMTP response.
18306 .next
18307 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18308 .next
18309 &'Pass'&: pass the address to the next router (or the router specified by
18310 &%pass_router%&), overriding &%no_more%&.
18311 .next
18312 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18313 new addresses, which are routed independently, starting with the first router,
18314 or the router specified by &%redirect_router%&, if set.
18315 .endlist
18316
18317 When the first word is &'accept'&, the remainder of the line consists of a
18318 number of keyed data values, as follows (split into two lines here, to fit on
18319 the page):
18320 .code
18321 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18322 LOOKUP=byname|bydns DATA=<text>
18323 .endd
18324 The data items can be given in any order, and all are optional. If no transport
18325 is included, the transport specified by the generic &%transport%& option is
18326 used. The list of hosts and the lookup type are needed only if the transport is
18327 an &(smtp)& transport that does not itself supply a list of hosts.
18328
18329 The format of the list of hosts is the same as for the &(manualroute)& router.
18330 As well as host names and IP addresses with optional port numbers, as described
18331 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18332 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18333 (see section &<<SECThostshowused>>&).
18334
18335 If the lookup type is not specified, Exim behaves as follows when trying to
18336 find an IP address for each host: First, a DNS lookup is done. If this yields
18337 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18338 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18339 result of the lookup is the result of that call.
18340
18341 .vindex "&$address_data$&"
18342 If the DATA field is set, its value is placed in the &$address_data$&
18343 variable. For example, this return line
18344 .code
18345 accept hosts=x1.y.example:x2.y.example data="rule1"
18346 .endd
18347 routes the address to the default transport, passing a list of two hosts. When
18348 the transport runs, the string &"rule1"& is in &$address_data$&.
18349 .ecindex IIDquerou1
18350 .ecindex IIDquerou2
18351
18352
18353
18354
18355 . ////////////////////////////////////////////////////////////////////////////
18356 . ////////////////////////////////////////////////////////////////////////////
18357
18358 .chapter "The redirect router" "CHAPredirect"
18359 .scindex IIDredrou1 "&(redirect)& router"
18360 .scindex IIDredrou2 "routers" "&(redirect)&"
18361 .cindex "alias file" "in a &(redirect)& router"
18362 .cindex "address redirection" "&(redirect)& router"
18363 The &(redirect)& router handles several kinds of address redirection. Its most
18364 common uses are for resolving local part aliases from a central alias file
18365 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18366 files, but it has many other potential uses. The incoming address can be
18367 redirected in several different ways:
18368
18369 .ilist
18370 It can be replaced by one or more new addresses which are themselves routed
18371 independently.
18372 .next
18373 It can be routed to be delivered to a given file or directory.
18374 .next
18375 It can be routed to be delivered to a specified pipe command.
18376 .next
18377 It can cause an automatic reply to be generated.
18378 .next
18379 It can be forced to fail, optionally with a custom error message.
18380 .next
18381 It can be temporarily deferred, optionally with a custom message.
18382 .next
18383 It can be discarded.
18384 .endlist
18385
18386 The generic &%transport%& option must not be set for &(redirect)& routers.
18387 However, there are some private options which define transports for delivery to
18388 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18389 &%pipe_transport%& and &%reply_transport%& descriptions below.
18390
18391
18392
18393 .section "Redirection data" "SECID124"
18394 The router operates by interpreting a text string which it obtains either by
18395 expanding the contents of the &%data%& option, or by reading the entire
18396 contents of a file whose name is given in the &%file%& option. These two
18397 options are mutually exclusive. The first is commonly used for handling system
18398 aliases, in a configuration like this:
18399 .code
18400 system_aliases:
18401   driver = redirect
18402   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18403 .endd
18404 If the lookup fails, the expanded string in this example is empty. When the
18405 expansion of &%data%& results in an empty string, the router declines. A forced
18406 expansion failure also causes the router to decline; other expansion failures
18407 cause delivery to be deferred.
18408
18409 A configuration using &%file%& is commonly used for handling users'
18410 &_.forward_& files, like this:
18411 .code
18412 userforward:
18413   driver = redirect
18414   check_local_user
18415   file = $home/.forward
18416   no_verify
18417 .endd
18418 If the file does not exist, or causes no action to be taken (for example, it is
18419 empty or consists only of comments), the router declines. &*Warning*&: This
18420 is not the case when the file contains syntactically valid items that happen to
18421 yield empty addresses, for example, items containing only RFC 2822 address
18422 comments.
18423
18424
18425
18426 .section "Forward files and address verification" "SECID125"
18427 .cindex "address redirection" "while verifying"
18428 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18429 &_.forward_& files, as in the example above. There are two reasons for this:
18430
18431 .ilist
18432 When Exim is receiving an incoming SMTP message from a remote host, it is
18433 running under the Exim uid, not as root. Exim is unable to change uid to read
18434 the file as the user, and it may not be able to read it as the Exim user. So in
18435 practice the router may not be able to operate.
18436 .next
18437 However, even when the router can operate, the existence of a &_.forward_& file
18438 is unimportant when verifying an address. What should be checked is whether the
18439 local part is a valid user name or not. Cutting out the redirection processing
18440 saves some resources.
18441 .endlist
18442
18443
18444
18445
18446
18447
18448 .section "Interpreting redirection data" "SECID126"
18449 .cindex "Sieve filter" "specifying in redirection data"
18450 .cindex "filter" "specifying in redirection data"
18451 The contents of the data string, whether obtained from &%data%& or &%file%&,
18452 can be interpreted in two different ways:
18453
18454 .ilist
18455 If the &%allow_filter%& option is set true, and the data begins with the text
18456 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18457 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18458 respectively. Details of the syntax and semantics of filter files are described
18459 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18460 document is intended for use by end users.
18461 .next
18462 Otherwise, the data must be a comma-separated list of redirection items, as
18463 described in the next section.
18464 .endlist
18465
18466 When a message is redirected to a file (a &"mail folder"&), the file name given
18467 in a non-filter redirection list must always be an absolute path. A filter may
18468 generate a relative path &-- how this is handled depends on the transport's
18469 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18470 for the &(appendfile)& transport.
18471
18472
18473
18474 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18475 .cindex "address redirection" "non-filter list items"
18476 When the redirection data is not an Exim or Sieve filter, for example, if it
18477 comes from a conventional alias or forward file, it consists of a list of
18478 addresses, file names, pipe commands, or certain special items (see section
18479 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18480 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18481 depending on their default values. The items in the list are separated by
18482 commas or newlines.
18483 If a comma is required in an item, the entire item must be enclosed in double
18484 quotes.
18485
18486 Lines starting with a # character are comments, and are ignored, and # may
18487 also appear following a comma, in which case everything between the # and the
18488 next newline character is ignored.
18489
18490 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18491 double quotes are retained because some forms of mail address require their use
18492 (but never to enclose the entire address). In the following description,
18493 &"item"& refers to what remains after any surrounding double quotes have been
18494 removed.
18495
18496 .vindex "&$local_part$&"
18497 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18498 and the expansion contains a reference to &$local_part$&, you should make use
18499 of the &%quote_local_part%& expansion operator, in case the local part contains
18500 special characters. For example, to redirect all mail for the domain
18501 &'obsolete.example'&, retaining the existing local part, you could use this
18502 setting:
18503 .code
18504 data = ${quote_local_part:$local_part}@newdomain.example
18505 .endd
18506
18507
18508 .section "Redirecting to a local mailbox" "SECTredlocmai"
18509 .cindex "routing" "loops in"
18510 .cindex "loop" "while routing, avoidance of"
18511 .cindex "address redirection" "to local mailbox"
18512 A redirection item may safely be the same as the address currently under
18513 consideration. This does not cause a routing loop, because a router is
18514 automatically skipped if any ancestor of the address that is being processed
18515 is the same as the current address and was processed by the current router.
18516 Such an address is therefore passed to the following routers, so it is handled
18517 as if there were no redirection. When making this loop-avoidance test, the
18518 complete local part, including any prefix or suffix, is used.
18519
18520 .cindex "address redirection" "local part without domain"
18521 Specifying the same local part without a domain is a common usage in personal
18522 filter files when the user wants to have messages delivered to the local
18523 mailbox and also forwarded elsewhere. For example, the user whose login is
18524 &'cleo'& might have a &_.forward_& file containing this:
18525 .code
18526 cleo, cleopatra@egypt.example
18527 .endd
18528 .cindex "backslash in alias file"
18529 .cindex "alias file" "backslash in"
18530 For compatibility with other MTAs, such unqualified local parts may be
18531 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18532 it does make a difference if more than one domain is being handled
18533 synonymously.
18534
18535 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18536 2822 address that does not include a domain, the item is qualified using the
18537 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18538 addresses are qualified using the value in &%qualify_recipient%&, but you can
18539 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18540
18541 Care must be taken if there are alias names for local users.
18542 Consider an MTA handling a single local domain where the system alias file
18543 contains:
18544 .code
18545 Sam.Reman: spqr
18546 .endd
18547 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18548 messages in the local mailbox, and also forward copies elsewhere. He creates
18549 this forward file:
18550 .code
18551 Sam.Reman, spqr@reme.elsewhere.example
18552 .endd
18553 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18554 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18555 second time round, because it has previously routed it,
18556 and the following routers presumably cannot handle the alias. The forward file
18557 should really contain
18558 .code
18559 spqr, spqr@reme.elsewhere.example
18560 .endd
18561 but because this is such a common error, the &%check_ancestor%& option (see
18562 below) exists to provide a way to get round it. This is normally set on a
18563 &(redirect)& router that is handling users' &_.forward_& files.
18564
18565
18566
18567 .section "Special items in redirection lists" "SECTspecitredli"
18568 In addition to addresses, the following types of item may appear in redirection
18569 lists (that is, in non-filter redirection data):
18570
18571 .ilist
18572 .cindex "pipe" "in redirection list"
18573 .cindex "address redirection" "to pipe"
18574 An item is treated as a pipe command if it begins with &"|"& and does not parse
18575 as a valid RFC 2822 address that includes a domain. A transport for running the
18576 command must be specified by the &%pipe_transport%& option.
18577 Normally, either the router or the transport specifies a user and a group under
18578 which to run the delivery. The default is to use the Exim user and group.
18579
18580 Single or double quotes can be used for enclosing the individual arguments of
18581 the pipe command; no interpretation of escapes is done for single quotes. If
18582 the command contains a comma character, it is necessary to put the whole item
18583 in double quotes, for example:
18584 .code
18585 "|/some/command ready,steady,go"
18586 .endd
18587 since items in redirection lists are terminated by commas. Do not, however,
18588 quote just the command. An item such as
18589 .code
18590 |"/some/command ready,steady,go"
18591 .endd
18592 is interpreted as a pipe with a rather strange command name, and no arguments.
18593
18594 .new
18595 Note that the above example assumes that the text comes from a lookup source
18596 of some sort, so that the quotes are part of the data.  If composing a
18597 redirect router with a &%data%& option directly specifying this command, the
18598 quotes will be used by the configuration parser to define the extent of one
18599 string, but will not be passed down into the redirect router itself.  There
18600 are two main approaches to get around this: escape quotes to be part of the
18601 data itself, or avoid using this mechanism and instead create a custom
18602 transport with the &%command%& option set and reference that transport from
18603 an &%accept%& router.
18604 .wen
18605
18606 .next
18607 .cindex "file" "in redirection list"
18608 .cindex "address redirection" "to file"
18609 An item is interpreted as a path name if it begins with &"/"& and does not
18610 parse as a valid RFC 2822 address that includes a domain. For example,
18611 .code
18612 /home/world/minbari
18613 .endd
18614 is treated as a file name, but
18615 .code
18616 /s=molari/o=babylon/@x400gate.way
18617 .endd
18618 is treated as an address. For a file name, a transport must be specified using
18619 the &%file_transport%& option. However, if the generated path name ends with a
18620 forward slash character, it is interpreted as a directory name rather than a
18621 file name, and &%directory_transport%& is used instead.
18622
18623 Normally, either the router or the transport specifies a user and a group under
18624 which to run the delivery. The default is to use the Exim user and group.
18625
18626 .cindex "&_/dev/null_&"
18627 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18628 bypassed at a high level, and the log entry shows &"**bypassed**"&
18629 instead of a transport name. In this case the user and group are not used.
18630
18631 .next
18632 .cindex "included address list"
18633 .cindex "address redirection" "included external list"
18634 If an item is of the form
18635 .code
18636 :include:<path name>
18637 .endd
18638 a list of further items is taken from the given file and included at that
18639 point. &*Note*&: Such a file can not be a filter file; it is just an
18640 out-of-line addition to the list. The items in the included list are separated
18641 by commas or newlines and are not subject to expansion. If this is the first
18642 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18643 the alias name. This example is incorrect:
18644 .code
18645 list1    :include:/opt/lists/list1
18646 .endd
18647 It must be given as
18648 .code
18649 list1:   :include:/opt/lists/list1
18650 .endd
18651 .next
18652 .cindex "address redirection" "to black hole"
18653 Sometimes you want to throw away mail to a particular local part. Making the
18654 &%data%& option expand to an empty string does not work, because that causes
18655 the router to decline. Instead, the alias item
18656 .cindex "black hole"
18657 .cindex "abandoning mail"
18658 &':blackhole:'& can be used. It does what its name implies. No delivery is
18659 done, and no error message is generated. This has the same effect as specifing
18660 &_/dev/null_& as a destination, but it can be independently disabled.
18661
18662 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18663 delivery is done for the original local part, even if other redirection items
18664 are present. If you are generating a multi-item list (for example, by reading a
18665 database) and need the ability to provide a no-op item, you must use
18666 &_/dev/null_&.
18667
18668 .next
18669 .cindex "delivery" "forcing failure"
18670 .cindex "delivery" "forcing deferral"
18671 .cindex "failing delivery" "forcing"
18672 .cindex "deferred delivery, forcing"
18673 .cindex "customizing" "failure message"
18674 An attempt to deliver a particular address can be deferred or forced to fail by
18675 redirection items of the form
18676 .code
18677 :defer:
18678 :fail:
18679 .endd
18680 respectively. When a redirection list contains such an item, it applies
18681 to the entire redirection; any other items in the list are ignored. Any
18682 text following &':fail:'& or &':defer:'& is placed in the error text
18683 associated with the failure. For example, an alias file might contain:
18684 .code
18685 X.Employee:  :fail: Gone away, no forwarding address
18686 .endd
18687 In the case of an address that is being verified from an ACL or as the subject
18688 of a
18689 .cindex "VRFY" "error text, display of"
18690 VRFY command, the text is included in the SMTP error response by
18691 default.
18692 .cindex "EXPN" "error text, display of"
18693 The text is not included in the response to an EXPN command. In non-SMTP cases
18694 the text is included in the error message that Exim generates.
18695
18696 .cindex "SMTP" "error codes"
18697 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18698 &':fail:'&. However, if the message starts with three digits followed by a
18699 space, optionally followed by an extended code of the form &'n.n.n'&, also
18700 followed by a space, and the very first digit is the same as the default error
18701 code, the code from the message is used instead. If the very first digit is
18702 incorrect, a panic error is logged, and the default code is used. You can
18703 suppress the use of the supplied code in a redirect router by setting the
18704 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18705 ignored.
18706
18707 .vindex "&$acl_verify_message$&"
18708 In an ACL, an explicitly provided message overrides the default, but the
18709 default message is available in the variable &$acl_verify_message$& and can
18710 therefore be included in a custom message if this is desired.
18711
18712 Normally the error text is the rest of the redirection list &-- a comma does
18713 not terminate it &-- but a newline does act as a terminator. Newlines are not
18714 normally present in alias expansions. In &(lsearch)& lookups they are removed
18715 as part of the continuation process, but they may exist in other kinds of
18716 lookup and in &':include:'& files.
18717
18718 During routing for message delivery (as opposed to verification), a redirection
18719 containing &':fail:'& causes an immediate failure of the incoming address,
18720 whereas &':defer:'& causes the message to remain on the queue so that a
18721 subsequent delivery attempt can happen at a later time. If an address is
18722 deferred for too long, it will ultimately fail, because the normal retry
18723 rules still apply.
18724
18725 .next
18726 .cindex "alias file" "exception to default"
18727 Sometimes it is useful to use a single-key search type with a default (see
18728 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18729 for exceptions to the default. These can be handled by aliasing them to
18730 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18731 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18732 results in an empty redirection list has the same effect.
18733 .endlist
18734
18735
18736 .section "Duplicate addresses" "SECTdupaddr"
18737 .cindex "duplicate addresses"
18738 .cindex "address duplicate, discarding"
18739 .cindex "pipe" "duplicated"
18740 Exim removes duplicate addresses from the list to which it is delivering, so as
18741 to deliver just one copy to each address. This does not apply to deliveries
18742 routed to pipes by different immediate parent addresses, but an indirect
18743 aliasing scheme of the type
18744 .code
18745 pipe:       |/some/command $local_part
18746 localpart1: pipe
18747 localpart2: pipe
18748 .endd
18749 does not work with a message that is addressed to both local parts, because
18750 when the second is aliased to the intermediate local part &"pipe"& it gets
18751 discarded as being the same as a previously handled address. However, a scheme
18752 such as
18753 .code
18754 localpart1: |/some/command $local_part
18755 localpart2: |/some/command $local_part
18756 .endd
18757 does result in two different pipe deliveries, because the immediate parents of
18758 the pipes are distinct.
18759
18760
18761
18762 .section "Repeated redirection expansion" "SECID128"
18763 .cindex "repeated redirection expansion"
18764 .cindex "address redirection" "repeated for each delivery attempt"
18765 When a message cannot be delivered to all of its recipients immediately,
18766 leading to two or more delivery attempts, redirection expansion is carried out
18767 afresh each time for those addresses whose children were not all previously
18768 delivered. If redirection is being used as a mailing list, this can lead to new
18769 members of the list receiving copies of old messages. The &%one_time%& option
18770 can be used to avoid this.
18771
18772
18773 .section "Errors in redirection lists" "SECID129"
18774 .cindex "address redirection" "errors"
18775 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18776 error is skipped, and an entry is written to the main log. This may be useful
18777 for mailing lists that are automatically managed. Otherwise, if an error is
18778 detected while generating the list of new addresses, the original address is
18779 deferred. See also &%syntax_errors_to%&.
18780
18781
18782
18783 .section "Private options for the redirect router" "SECID130"
18784
18785 .cindex "options" "&(redirect)& router"
18786 The private options for the &(redirect)& router are as follows:
18787
18788
18789 .option allow_defer redirect boolean false
18790 Setting this option allows the use of &':defer:'& in non-filter redirection
18791 data, or the &%defer%& command in an Exim filter file.
18792
18793
18794 .option allow_fail redirect boolean false
18795 .cindex "failing delivery" "from filter"
18796 If this option is true, the &':fail:'& item can be used in a redirection list,
18797 and the &%fail%& command may be used in an Exim filter file.
18798
18799
18800 .option allow_filter redirect boolean false
18801 .cindex "filter" "enabling use of"
18802 .cindex "Sieve filter" "enabling use of"
18803 Setting this option allows Exim to interpret redirection data that starts with
18804 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18805 are some features of Exim filter files that some administrators may wish to
18806 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18807
18808 It is also possible to lock out Exim filters or Sieve filters while allowing
18809 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18810
18811
18812 The filter is run using the uid and gid set by the generic &%user%& and
18813 &%group%& options. These take their defaults from the password data if
18814 &%check_local_user%& is set, so in the normal case of users' personal filter
18815 files, the filter is run as the relevant user. When &%allow_filter%& is set
18816 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18817
18818
18819
18820 .option allow_freeze redirect boolean false
18821 .cindex "freezing messages" "allowing in filter"
18822 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18823 This command is more normally encountered in system filters, and is disabled by
18824 default for redirection filters because it isn't something you usually want to
18825 let ordinary users do.
18826
18827
18828
18829 .option check_ancestor redirect boolean false
18830 This option is concerned with handling generated addresses that are the same
18831 as some address in the list of redirection ancestors of the current address.
18832 Although it is turned off by default in the code, it is set in the default
18833 configuration file for handling users' &_.forward_& files. It is recommended
18834 for this use of the &(redirect)& router.
18835
18836 When &%check_ancestor%& is set, if a generated address (including the domain)
18837 is the same as any ancestor of the current address, it is replaced by a copy of
18838 the current address. This helps in the case where local part A is aliased to B,
18839 and B has a &_.forward_& file pointing back to A. For example, within a single
18840 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18841 &_&~jb/.forward_& contains:
18842 .code
18843 \Joe.Bloggs, <other item(s)>
18844 .endd
18845 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18846 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18847 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18848 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18849 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18850 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18851 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18852 original address. See also the &%repeat_use%& option below.
18853
18854
18855 .option check_group redirect boolean "see below"
18856 When the &%file%& option is used, the group owner of the file is checked only
18857 when this option is set. The permitted groups are those listed in the
18858 &%owngroups%& option, together with the user's default group if
18859 &%check_local_user%& is set. If the file has the wrong group, routing is
18860 deferred. The default setting for this option is true if &%check_local_user%&
18861 is set and the &%modemask%& option permits the group write bit, or if the
18862 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18863
18864
18865
18866 .option check_owner redirect boolean "see below"
18867 When the &%file%& option is used, the owner of the file is checked only when
18868 this option is set. If &%check_local_user%& is set, the local user is
18869 permitted; otherwise the owner must be one of those listed in the &%owners%&
18870 option. The default value for this option is true if &%check_local_user%& or
18871 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18872
18873
18874 .option data redirect string&!! unset
18875 This option is mutually exclusive with &%file%&. One or other of them must be
18876 set, but not both. The contents of &%data%& are expanded, and then used as the
18877 list of forwarding items, or as a set of filtering instructions. If the
18878 expansion is forced to fail, or the result is an empty string or a string that
18879 has no effect (consists entirely of comments), the router declines.
18880
18881 When filtering instructions are used, the string must begin with &"#Exim
18882 filter"&, and all comments in the string, including this initial one, must be
18883 terminated with newline characters. For example:
18884 .code
18885 data = #Exim filter\n\
18886        if $h_to: contains Exim then save $home/mail/exim endif
18887 .endd
18888 If you are reading the data from a database where newlines cannot be included,
18889 you can use the &${sg}$& expansion item to turn the escape string of your
18890 choice into a newline.
18891
18892
18893 .option directory_transport redirect string&!! unset
18894 A &(redirect)& router sets up a direct delivery to a directory when a path name
18895 ending with a slash is specified as a new &"address"&. The transport used is
18896 specified by this option, which, after expansion, must be the name of a
18897 configured transport. This should normally be an &(appendfile)& transport.
18898
18899
18900 .option file redirect string&!! unset
18901 This option specifies the name of a file that contains the redirection data. It
18902 is mutually exclusive with the &%data%& option. The string is expanded before
18903 use; if the expansion is forced to fail, the router declines. Other expansion
18904 failures cause delivery to be deferred. The result of a successful expansion
18905 must be an absolute path. The entire file is read and used as the redirection
18906 data. If the data is an empty string or a string that has no effect (consists
18907 entirely of comments), the router declines.
18908
18909 .cindex "NFS" "checking for file existence"
18910 If the attempt to open the file fails with a &"does not exist"& error, Exim
18911 runs a check on the containing directory,
18912 unless &%ignore_enotdir%& is true (see below).
18913 If the directory does not appear to exist, delivery is deferred. This can
18914 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18915 is a mount problem. If the containing directory does exist, but the file does
18916 not, the router declines.
18917
18918
18919 .option file_transport redirect string&!! unset
18920 .vindex "&$address_file$&"
18921 A &(redirect)& router sets up a direct delivery to a file when a path name not
18922 ending in a slash is specified as a new &"address"&. The transport used is
18923 specified by this option, which, after expansion, must be the name of a
18924 configured transport. This should normally be an &(appendfile)& transport. When
18925 it is running, the file name is in &$address_file$&.
18926
18927
18928 .option filter_prepend_home redirect boolean true
18929 When this option is true, if a &(save)& command in an Exim filter specifies a
18930 relative path, and &$home$& is defined, it is automatically prepended to the
18931 relative path. If this option is set false, this action does not happen. The
18932 relative path is then passed to the transport unmodified.
18933
18934
18935 .option forbid_blackhole redirect boolean false
18936 If this option is true, the &':blackhole:'& item may not appear in a
18937 redirection list.
18938
18939
18940 .option forbid_exim_filter redirect boolean false
18941 If this option is set true, only Sieve filters are permitted when
18942 &%allow_filter%& is true.
18943
18944
18945
18946
18947 .option forbid_file redirect boolean false
18948 .cindex "delivery" "to file; forbidding"
18949 .cindex "Sieve filter" "forbidding delivery to a file"
18950 .cindex "Sieve filter" "&""keep""& facility; disabling"
18951 If this option is true, this router may not generate a new address that
18952 specifies delivery to a local file or directory, either from a filter or from a
18953 conventional forward file. This option is forced to be true if &%one_time%& is
18954 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18955 locks out the Sieve's &"keep"& facility.
18956
18957
18958 .option forbid_filter_dlfunc redirect boolean false
18959 .cindex "filter" "locking out certain features"
18960 If this option is true, string expansions in Exim filters are not allowed to
18961 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18962 functions.
18963
18964 .option forbid_filter_existstest redirect boolean false
18965 .cindex "expansion" "statting a file"
18966 If this option is true, string expansions in Exim filters are not allowed to
18967 make use of the &%exists%& condition or the &%stat%& expansion item.
18968
18969 .option forbid_filter_logwrite redirect boolean false
18970 If this option is true, use of the logging facility in Exim filters is not
18971 permitted. Logging is in any case available only if the filter is being run
18972 under some unprivileged uid (which is normally the case for ordinary users'
18973 &_.forward_& files).
18974
18975
18976 .option forbid_filter_lookup redirect boolean false
18977 If this option is true, string expansions in Exim filter files are not allowed
18978 to make use of &%lookup%& items.
18979
18980
18981 .option forbid_filter_perl redirect boolean false
18982 This option has an effect only if Exim is built with embedded Perl support. If
18983 it is true, string expansions in Exim filter files are not allowed to make use
18984 of the embedded Perl support.
18985
18986
18987 .option forbid_filter_readfile redirect boolean false
18988 If this option is true, string expansions in Exim filter files are not allowed
18989 to make use of &%readfile%& items.
18990
18991
18992 .option forbid_filter_readsocket redirect boolean false
18993 If this option is true, string expansions in Exim filter files are not allowed
18994 to make use of &%readsocket%& items.
18995
18996
18997 .option forbid_filter_reply redirect boolean false
18998 If this option is true, this router may not generate an automatic reply
18999 message. Automatic replies can be generated only from Exim or Sieve filter
19000 files, not from traditional forward files. This option is forced to be true if
19001 &%one_time%& is set.
19002
19003
19004 .option forbid_filter_run redirect boolean false
19005 If this option is true, string expansions in Exim filter files are not allowed
19006 to make use of &%run%& items.
19007
19008
19009 .option forbid_include redirect boolean false
19010 If this option is true, items of the form
19011 .code
19012 :include:<path name>
19013 .endd
19014 are not permitted in non-filter redirection lists.
19015
19016
19017 .option forbid_pipe redirect boolean false
19018 .cindex "delivery" "to pipe; forbidding"
19019 If this option is true, this router may not generate a new address which
19020 specifies delivery to a pipe, either from an Exim filter or from a conventional
19021 forward file. This option is forced to be true if &%one_time%& is set.
19022
19023
19024 .option forbid_sieve_filter redirect boolean false
19025 If this option is set true, only Exim filters are permitted when
19026 &%allow_filter%& is true.
19027
19028
19029 .cindex "SMTP" "error codes"
19030 .option forbid_smtp_code redirect boolean false
19031 If this option is set true, any SMTP error codes that are present at the start
19032 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19033 the default codes (451 and 550, respectively) are always used.
19034
19035
19036
19037
19038 .option hide_child_in_errmsg redirect boolean false
19039 .cindex "bounce message" "redirection details; suppressing"
19040 If this option is true, it prevents Exim from quoting a child address if it
19041 generates a bounce or delay message for it. Instead it says &"an address
19042 generated from <&'the top level address'&>"&. Of course, this applies only to
19043 bounces generated locally. If a message is forwarded to another host, &'its'&
19044 bounce may well quote the generated address.
19045
19046
19047 .option ignore_eacces redirect boolean false
19048 .cindex "EACCES"
19049 If this option is set and an attempt to open a redirection file yields the
19050 EACCES error (permission denied), the &(redirect)& router behaves as if the
19051 file did not exist.
19052
19053
19054 .option ignore_enotdir redirect boolean false
19055 .cindex "ENOTDIR"
19056 If this option is set and an attempt to open a redirection file yields the
19057 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19058 router behaves as if the file did not exist.
19059
19060 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19061 router that has the &%file%& option set discovers that the file does not exist
19062 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19063 against unmounted NFS directories. If the parent can not be statted, delivery
19064 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19065 is set, because that option tells Exim to ignore &"something on the path is not
19066 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19067 that some operating systems give ENOENT where others give ENOTDIR.
19068
19069
19070
19071 .option include_directory redirect string unset
19072 If this option is set, the path names of any &':include:'& items in a
19073 redirection list must start with this directory.
19074
19075
19076 .option modemask redirect "octal integer" 022
19077 This specifies mode bits which must not be set for a file specified by the
19078 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19079
19080
19081 .option one_time redirect boolean false
19082 .cindex "one-time aliasing/forwarding expansion"
19083 .cindex "alias file" "one-time expansion"
19084 .cindex "forward file" "one-time expansion"
19085 .cindex "mailing lists" "one-time expansion"
19086 .cindex "address redirection" "one-time expansion"
19087 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19088 files each time it tries to deliver a message causes a problem when one or more
19089 of the generated addresses fails be delivered at the first attempt. The problem
19090 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19091 but of what happens when the redirection list changes during the time that the
19092 message is on Exim's queue. This is particularly true in the case of mailing
19093 lists, where new subscribers might receive copies of messages that were posted
19094 before they subscribed.
19095
19096 If &%one_time%& is set and any addresses generated by the router fail to
19097 deliver at the first attempt, the failing addresses are added to the message as
19098 &"top level"& addresses, and the parent address that generated them is marked
19099 &"delivered"&. Thus, redirection does not happen again at the next delivery
19100 attempt.
19101
19102 &*Warning 1*&: Any header line addition or removal that is specified by this
19103 router would be lost if delivery did not succeed at the first attempt. For this
19104 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19105 permitted when &%one_time%& is set.
19106
19107 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19108 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19109 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19110
19111 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19112 &%one_time%&.
19113
19114 The original top-level address is remembered with each of the generated
19115 addresses, and is output in any log messages. However, any intermediate parent
19116 addresses are not recorded. This makes a difference to the log only if
19117 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19118 typically be used for mailing lists, where there is normally just one level of
19119 expansion.
19120
19121
19122 .option owners redirect "string list" unset
19123 .cindex "ownership" "alias file"
19124 .cindex "ownership" "forward file"
19125 .cindex "alias file" "ownership"
19126 .cindex "forward file" "ownership"
19127 This specifies a list of permitted owners for the file specified by &%file%&.
19128 This list is in addition to the local user when &%check_local_user%& is set.
19129 See &%check_owner%& above.
19130
19131
19132 .option owngroups redirect "string list" unset
19133 This specifies a list of permitted groups for the file specified by &%file%&.
19134 The list is in addition to the local user's primary group when
19135 &%check_local_user%& is set. See &%check_group%& above.
19136
19137
19138 .option pipe_transport redirect string&!! unset
19139 .vindex "&$address_pipe$&"
19140 A &(redirect)& router sets up a direct delivery to a pipe when a string
19141 starting with a vertical bar character is specified as a new &"address"&. The
19142 transport used is specified by this option, which, after expansion, must be the
19143 name of a configured transport. This should normally be a &(pipe)& transport.
19144 When the transport is run, the pipe command is in &$address_pipe$&.
19145
19146
19147 .option qualify_domain redirect string&!! unset
19148 .vindex "&$qualify_recipient$&"
19149 If this option is set, and an unqualified address (one without a domain) is
19150 generated, and that address would normally be qualified by the global setting
19151 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19152 expanding this string. If the expansion fails, the router declines. If you want
19153 to revert to the default, you can have the expansion generate
19154 &$qualify_recipient$&.
19155
19156 This option applies to all unqualified addresses generated by Exim filters,
19157 but for traditional &_.forward_& files, it applies only to addresses that are
19158 not preceded by a backslash. Sieve filters cannot generate unqualified
19159 addresses.
19160
19161 .option qualify_preserve_domain redirect boolean false
19162 .cindex "domain" "in redirection; preserving"
19163 .cindex "preserving domain in redirection"
19164 .cindex "address redirection" "domain; preserving"
19165 If this option is set, the router's local &%qualify_domain%& option must not be
19166 set (a configuration error occurs if it is). If an unqualified address (one
19167 without a domain) is generated, it is qualified with the domain of the parent
19168 address (the immediately preceding ancestor) instead of the global
19169 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19170 this applies whether or not the address is preceded by a backslash.
19171
19172
19173 .option repeat_use redirect boolean true
19174 If this option is set false, the router is skipped for a child address that has
19175 any ancestor that was routed by this router. This test happens before any of
19176 the other preconditions are tested. Exim's default anti-looping rules skip
19177 only when the ancestor is the same as the current address. See also
19178 &%check_ancestor%& above and the generic &%redirect_router%& option.
19179
19180
19181 .option reply_transport redirect string&!! unset
19182 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19183 &%vacation%& command is used in a filter file. The transport used is specified
19184 by this option, which, after expansion, must be the name of a configured
19185 transport. This should normally be an &(autoreply)& transport. Other transports
19186 are unlikely to do anything sensible or useful.
19187
19188
19189 .option rewrite redirect boolean true
19190 .cindex "address redirection" "disabling rewriting"
19191 If this option is set false, addresses generated by the router are not
19192 subject to address rewriting. Otherwise, they are treated like new addresses
19193 and are rewritten according to the global rewriting rules.
19194
19195
19196 .option sieve_subaddress redirect string&!! unset
19197 The value of this option is passed to a Sieve filter to specify the
19198 :subaddress part of an address.
19199
19200 .option sieve_useraddress redirect string&!! unset
19201 The value of this option is passed to a Sieve filter to specify the :user part
19202 of an address. However, if it is unset, the entire original local part
19203 (including any prefix or suffix) is used for :user.
19204
19205
19206 .option sieve_vacation_directory redirect string&!! unset
19207 .cindex "Sieve filter" "vacation directory"
19208 To enable the &"vacation"& extension for Sieve filters, you must set
19209 &%sieve_vacation_directory%& to the directory where vacation databases are held
19210 (do not put anything else in that directory), and ensure that the
19211 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19212 needs their own directory; Exim will create it if necessary.
19213
19214
19215
19216 .option skip_syntax_errors redirect boolean false
19217 .cindex "forward file" "broken"
19218 .cindex "address redirection" "broken files"
19219 .cindex "alias file" "broken"
19220 .cindex "broken alias or forward files"
19221 .cindex "ignoring faulty addresses"
19222 .cindex "skipping faulty addresses"
19223 .cindex "error" "skipping bad syntax"
19224 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19225 non-filter redirection data are skipped, and each failing address is logged. If
19226 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19227 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19228 are expanded and placed at the head of the error message generated by
19229 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19230 be the same address as the generic &%errors_to%& option. The
19231 &%skip_syntax_errors%& option is often used when handling mailing lists.
19232
19233 If all the addresses in a redirection list are skipped because of syntax
19234 errors, the router declines to handle the original address, and it is passed to
19235 the following routers.
19236
19237 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19238 error in the filter causes filtering to be abandoned without any action being
19239 taken. The incident is logged, and the router declines to handle the address,
19240 so it is passed to the following routers.
19241
19242 .cindex "Sieve filter" "syntax errors in"
19243 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19244 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19245 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19246
19247 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19248 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19249 option, used with an address that does not get redirected, can be used to
19250 notify users of these errors, by means of a router like this:
19251 .code
19252 userforward:
19253   driver = redirect
19254   allow_filter
19255   check_local_user
19256   file = $home/.forward
19257   file_transport = address_file
19258   pipe_transport = address_pipe
19259   reply_transport = address_reply
19260   no_verify
19261   skip_syntax_errors
19262   syntax_errors_to = real-$local_part@$domain
19263   syntax_errors_text = \
19264    This is an automatically generated message. An error has\n\
19265    been found in your .forward file. Details of the error are\n\
19266    reported below. While this error persists, you will receive\n\
19267    a copy of this message for every message that is addressed\n\
19268    to you. If your .forward file is a filter file, or if it is\n\
19269    a non-filter file containing no valid forwarding addresses,\n\
19270    a copy of each incoming message will be put in your normal\n\
19271    mailbox. If a non-filter file contains at least one valid\n\
19272    forwarding address, forwarding to the valid addresses will\n\
19273    happen, and those will be the only deliveries that occur.
19274 .endd
19275 You also need a router to ensure that local addresses that are prefixed by
19276 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19277 put this immediately before the &(userforward)& router:
19278 .code
19279 real_localuser:
19280   driver = accept
19281   check_local_user
19282   local_part_prefix = real-
19283   transport = local_delivery
19284 .endd
19285 For security, it would probably be a good idea to restrict the use of this
19286 router to locally-generated messages, using a condition such as this:
19287 .code
19288   condition = ${if match {$sender_host_address}\
19289                          {\N^(|127\.0\.0\.1)$\N}}
19290 .endd
19291
19292
19293 .option syntax_errors_text redirect string&!! unset
19294 See &%skip_syntax_errors%& above.
19295
19296
19297 .option syntax_errors_to redirect string unset
19298 See &%skip_syntax_errors%& above.
19299 .ecindex IIDredrou1
19300 .ecindex IIDredrou2
19301
19302
19303
19304
19305
19306
19307 . ////////////////////////////////////////////////////////////////////////////
19308 . ////////////////////////////////////////////////////////////////////////////
19309
19310 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19311          "Environment for local transports"
19312 .scindex IIDenvlotra1 "local transports" "environment for"
19313 .scindex IIDenvlotra2 "environment for local transports"
19314 .scindex IIDenvlotra3 "transport" "local; environment for"
19315 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19316 transport can be thought of as similar to a pipe.) Exim always runs transports
19317 in subprocesses, under specified uids and gids. Typical deliveries to local
19318 mailboxes run under the uid and gid of the local user.
19319
19320 Exim also sets a specific current directory while running the transport; for
19321 some transports a home directory setting is also relevant. The &(pipe)&
19322 transport is the only one that sets up environment variables; see section
19323 &<<SECTpipeenv>>& for details.
19324
19325 The values used for the uid, gid, and the directories may come from several
19326 different places. In many cases, the router that handles the address associates
19327 settings with that address as a result of its &%check_local_user%&, &%group%&,
19328 or &%user%& options. However, values may also be given in the transport's own
19329 configuration, and these override anything that comes from the router.
19330
19331
19332
19333 .section "Concurrent deliveries" "SECID131"
19334 .cindex "concurrent deliveries"
19335 .cindex "simultaneous deliveries"
19336 If two different messages for the same local recipient arrive more or less
19337 simultaneously, the two delivery processes are likely to run concurrently. When
19338 the &(appendfile)& transport is used to write to a file, Exim applies locking
19339 rules to stop concurrent processes from writing to the same file at the same
19340 time.
19341
19342 However, when you use a &(pipe)& transport, it is up to you to arrange any
19343 locking that is needed. Here is a silly example:
19344 .code
19345 my_transport:
19346   driver = pipe
19347   command = /bin/sh -c 'cat >>/some/file'
19348 .endd
19349 This is supposed to write the message at the end of the file. However, if two
19350 messages arrive at the same time, the file will be scrambled. You can use the
19351 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19352 file using the same algorithm that Exim itself uses.
19353
19354
19355
19356
19357 .section "Uids and gids" "SECTenvuidgid"
19358 .cindex "local transports" "uid and gid"
19359 .cindex "transport" "local; uid and gid"
19360 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19361 overrides any group that the router set in the address, even if &%user%& is not
19362 set for the transport. This makes it possible, for example, to run local mail
19363 delivery under the uid of the recipient (set by the router), but in a special
19364 group (set by the transport). For example:
19365 .code
19366 # Routers ...
19367 # User/group are set by check_local_user in this router
19368 local_users:
19369   driver = accept
19370   check_local_user
19371   transport = group_delivery
19372
19373 # Transports ...
19374 # This transport overrides the group
19375 group_delivery:
19376   driver = appendfile
19377   file = /var/spool/mail/$local_part
19378   group = mail
19379 .endd
19380 If &%user%& is set for a transport, its value overrides what is set in the
19381 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19382 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19383 set.
19384
19385 .oindex "&%initgroups%&"
19386 When the uid is taken from the transport's configuration, the &[initgroups()]&
19387 function is called for the groups associated with that uid if the
19388 &%initgroups%& option is set for the transport. When the uid is not specified
19389 by the transport, but is associated with the address by a router, the option
19390 for calling &[initgroups()]& is taken from the router configuration.
19391
19392 .cindex "&(pipe)& transport" "uid for"
19393 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19394 is set and &%user%& is not set, the uid of the process that called Exim to
19395 receive the message is used, and if &%group%& is not set, the corresponding
19396 original gid is also used.
19397
19398 This is the detailed preference order for obtaining a gid; the first of the
19399 following that is set is used:
19400
19401 .ilist
19402 A &%group%& setting of the transport;
19403 .next
19404 A &%group%& setting of the router;
19405 .next
19406 A gid associated with a user setting of the router, either as a result of
19407 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19408 .next
19409 The group associated with a non-numeric &%user%& setting of the transport;
19410 .next
19411 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19412 the uid is the creator's uid;
19413 .next
19414 The Exim gid if the Exim uid is being used as a default.
19415 .endlist
19416
19417 If, for example, the user is specified numerically on the router and there are
19418 no group settings, no gid is available. In this situation, an error occurs.
19419 This is different for the uid, for which there always is an ultimate default.
19420 The first of the following that is set is used:
19421
19422 .ilist
19423 A &%user%& setting of the transport;
19424 .next
19425 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19426 .next
19427 A &%user%& setting of the router;
19428 .next
19429 A &%check_local_user%& setting of the router;
19430 .next
19431 The Exim uid.
19432 .endlist
19433
19434 Of course, an error will still occur if the uid that is chosen is on the
19435 &%never_users%& list.
19436
19437
19438
19439
19440
19441 .section "Current and home directories" "SECID132"
19442 .cindex "current directory for local transport"
19443 .cindex "home directory" "for local transport"
19444 .cindex "transport" "local; home directory for"
19445 .cindex "transport" "local; current directory for"
19446 Routers may set current and home directories for local transports by means of
19447 the &%transport_current_directory%& and &%transport_home_directory%& options.
19448 However, if the transport's &%current_directory%& or &%home_directory%& options
19449 are set, they override the router's values. In detail, the home directory
19450 for a local transport is taken from the first of these values that is set:
19451
19452 .ilist
19453 The &%home_directory%& option on the transport;
19454 .next
19455 The &%transport_home_directory%& option on the router;
19456 .next
19457 The password data if &%check_local_user%& is set on the router;
19458 .next
19459 The &%router_home_directory%& option on the router.
19460 .endlist
19461
19462 The current directory is taken from the first of these values that is set:
19463
19464 .ilist
19465 The &%current_directory%& option on the transport;
19466 .next
19467 The &%transport_current_directory%& option on the router.
19468 .endlist
19469
19470
19471 If neither the router nor the transport sets a current directory, Exim uses the
19472 value of the home directory, if it is set. Otherwise it sets the current
19473 directory to &_/_& before running a local transport.
19474
19475
19476
19477 .section "Expansion variables derived from the address" "SECID133"
19478 .vindex "&$domain$&"
19479 .vindex "&$local_part$&"
19480 .vindex "&$original_domain$&"
19481 Normally a local delivery is handling a single address, and in that case the
19482 variables such as &$domain$& and &$local_part$& are set during local
19483 deliveries. However, in some circumstances more than one address may be handled
19484 at once (for example, while writing batch SMTP for onward transmission by some
19485 other means). In this case, the variables associated with the local part are
19486 never set, &$domain$& is set only if all the addresses have the same domain,
19487 and &$original_domain$& is never set.
19488 .ecindex IIDenvlotra1
19489 .ecindex IIDenvlotra2
19490 .ecindex IIDenvlotra3
19491
19492
19493
19494
19495
19496
19497
19498 . ////////////////////////////////////////////////////////////////////////////
19499 . ////////////////////////////////////////////////////////////////////////////
19500
19501 .chapter "Generic options for transports" "CHAPtransportgeneric"
19502 .scindex IIDgenoptra1 "generic options" "transport"
19503 .scindex IIDgenoptra2 "options" "generic; for transports"
19504 .scindex IIDgenoptra3 "transport" "generic options for"
19505 The following generic options apply to all transports:
19506
19507
19508 .option body_only transports boolean false
19509 .cindex "transport" "body only"
19510 .cindex "message" "transporting body only"
19511 .cindex "body of message" "transporting"
19512 If this option is set, the message's headers are not transported. It is
19513 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19514 or &(pipe)& transports, the settings of &%message_prefix%& and
19515 &%message_suffix%& should be checked, because this option does not
19516 automatically suppress them.
19517
19518
19519 .option current_directory transports string&!! unset
19520 .cindex "transport" "current directory for"
19521 This specifies the current directory that is to be set while running the
19522 transport, overriding any value that may have been set by the router.
19523 If the expansion fails for any reason, including forced failure, an error is
19524 logged, and delivery is deferred.
19525
19526
19527 .option disable_logging transports boolean false
19528 If this option is set true, nothing is logged for any
19529 deliveries by the transport or for any
19530 transport errors. You should not set this option unless you really, really know
19531 what you are doing.
19532
19533
19534 .option debug_print transports string&!! unset
19535 .cindex "testing" "variables in drivers"
19536 If this option is set and debugging is enabled (see the &%-d%& command line
19537 option), the string is expanded and included in the debugging output when the
19538 transport is run.
19539 If expansion of the string fails, the error message is written to the debugging
19540 output, and Exim carries on processing.
19541 This facility is provided to help with checking out the values of variables and
19542 so on when debugging driver configurations. For example, if a &%headers_add%&
19543 option is not working properly, &%debug_print%& could be used to output the
19544 variables it references. A newline is added to the text if it does not end with
19545 one.
19546
19547
19548 .option delivery_date_add transports boolean false
19549 .cindex "&'Delivery-date:'& header line"
19550 If this option is true, a &'Delivery-date:'& header is added to the message.
19551 This gives the actual time the delivery was made. As this is not a standard
19552 header, Exim has a configuration option (&%delivery_date_remove%&) which
19553 requests its removal from incoming messages, so that delivered messages can
19554 safely be resent to other recipients.
19555
19556
19557 .option driver transports string unset
19558 This specifies which of the available transport drivers is to be used.
19559 There is no default, and this option must be set for every transport.
19560
19561
19562 .option envelope_to_add transports boolean false
19563 .cindex "&'Envelope-to:'& header line"
19564 If this option is true, an &'Envelope-to:'& header is added to the message.
19565 This gives the original address(es) in the incoming envelope that caused this
19566 delivery to happen. More than one address may be present if the transport is
19567 configured to handle several addresses at once, or if more than one original
19568 address was redirected to the same final address. As this is not a standard
19569 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19570 its removal from incoming messages, so that delivered messages can safely be
19571 resent to other recipients.
19572
19573
19574 .option group transports string&!! "Exim group"
19575 .cindex "transport" "group; specifying"
19576 This option specifies a gid for running the transport process, overriding any
19577 value that the router supplies, and also overriding any value associated with
19578 &%user%& (see below).
19579
19580
19581 .option headers_add transports string&!! unset
19582 .cindex "header lines" "adding in transport"
19583 .cindex "transport" "header lines; adding"
19584 This option specifies a string of text that is expanded and added to the header
19585 portion of a message as it is transported, as described in section
19586 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19587 routers. If the result of the expansion is an empty string, or if the expansion
19588 is forced to fail, no action is taken. Other expansion failures are treated as
19589 errors and cause the delivery to be deferred.
19590
19591 Unlike most options, &%headers_add%& can be specified multiple times
19592 for a transport; all listed headers are added.
19593
19594
19595
19596 .option headers_only transports boolean false
19597 .cindex "transport" "header lines only"
19598 .cindex "message" "transporting headers only"
19599 .cindex "header lines" "transporting"
19600 If this option is set, the message's body is not transported. It is mutually
19601 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19602 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19603 checked, since this option does not automatically suppress them.
19604
19605
19606 .option headers_remove transports string&!! unset
19607 .cindex "header lines" "removing"
19608 .cindex "transport" "header lines; removing"
19609 This option specifies a string that is expanded into a list of header names;
19610 these headers are omitted from the message as it is transported, as described
19611 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19612 routers. If the result of the expansion is an empty string, or if the expansion
19613 is forced to fail, no action is taken. Other expansion failures are treated as
19614 errors and cause the delivery to be deferred.
19615
19616 Unlike most options, &%headers_remove%& can be specified multiple times
19617 for a router; all listed headers are added.
19618
19619
19620
19621 .option headers_rewrite transports string unset
19622 .cindex "transport" "header lines; rewriting"
19623 .cindex "rewriting" "at transport time"
19624 This option allows addresses in header lines to be rewritten at transport time,
19625 that is, as the message is being copied to its destination. The contents of the
19626 option are a colon-separated list of rewriting rules. Each rule is in exactly
19627 the same form as one of the general rewriting rules that are applied when a
19628 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19629 example,
19630 .code
19631 headers_rewrite = a@b c@d f : \
19632                   x@y w@z
19633 .endd
19634 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19635 &'w@z'& in all address-bearing header lines. The rules are applied to the
19636 header lines just before they are written out at transport time, so they affect
19637 only those copies of the message that pass through the transport. However, only
19638 the message's original header lines, and any that were added by a system
19639 filter, are rewritten. If a router or transport adds header lines, they are not
19640 affected by this option. These rewriting rules are &'not'& applied to the
19641 envelope. You can change the return path using &%return_path%&, but you cannot
19642 change envelope recipients at this time.
19643
19644
19645 .option home_directory transports string&!! unset
19646 .cindex "transport" "home directory for"
19647 .vindex "&$home$&"
19648 This option specifies a home directory setting for a local transport,
19649 overriding any value that may be set by the router. The home directory is
19650 placed in &$home$& while expanding the transport's private options. It is also
19651 used as the current directory if no current directory is set by the
19652 &%current_directory%& option on the transport or the
19653 &%transport_current_directory%& option on the router. If the expansion fails
19654 for any reason, including forced failure, an error is logged, and delivery is
19655 deferred.
19656
19657
19658 .option initgroups transports boolean false
19659 .cindex "additional groups"
19660 .cindex "groups" "additional"
19661 .cindex "transport" "group; additional"
19662 If this option is true and the uid for the delivery process is provided by the
19663 transport, the &[initgroups()]& function is called when running the transport
19664 to ensure that any additional groups associated with the uid are set up.
19665
19666
19667 .option message_size_limit transports string&!! 0
19668 .cindex "limit" "message size per transport"
19669 .cindex "size" "of message, limit"
19670 .cindex "transport" "message size; limiting"
19671 This option controls the size of messages passed through the transport. It is
19672 expanded before use; the result of the expansion must be a sequence of decimal
19673 digits, optionally followed by K or M. If the expansion fails for any reason,
19674 including forced failure, or if the result is not of the required form,
19675 delivery is deferred. If the value is greater than zero and the size of a
19676 message exceeds this limit, the address is failed. If there is any chance that
19677 the resulting bounce message could be routed to the same transport, you should
19678 ensure that &%return_size_limit%& is less than the transport's
19679 &%message_size_limit%&, as otherwise the bounce message will fail to get
19680 delivered.
19681
19682
19683
19684 .option rcpt_include_affixes transports boolean false
19685 .cindex "prefix" "for local part, including in envelope"
19686 .cindex "suffix for local part" "including in envelope"
19687 .cindex "local part" "prefix"
19688 .cindex "local part" "suffix"
19689 When this option is false (the default), and an address that has had any
19690 affixes (prefixes or suffixes) removed from the local part is delivered by any
19691 form of SMTP or LMTP, the affixes are not included. For example, if a router
19692 that contains
19693 .code
19694 local_part_prefix = *-
19695 .endd
19696 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19697 is delivered with
19698 .code
19699 RCPT TO:<xyz@some.domain>
19700 .endd
19701 This is also the case when an ACL-time callout is being used to verify a
19702 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19703 whole local part is included in the RCPT command. This option applies to BSMTP
19704 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19705 &(lmtp)& and &(smtp)& transports.
19706
19707
19708 .option retry_use_local_part transports boolean "see below"
19709 .cindex "hints database" "retry keys"
19710 When a delivery suffers a temporary failure, a retry record is created
19711 in Exim's hints database. For remote deliveries, the key for the retry record
19712 is based on the name and/or IP address of the failing remote host. For local
19713 deliveries, the key is normally the entire address, including both the local
19714 part and the domain. This is suitable for most common cases of local delivery
19715 temporary failure &-- for example, exceeding a mailbox quota should delay only
19716 deliveries to that mailbox, not to the whole domain.
19717
19718 However, in some special cases you may want to treat a temporary local delivery
19719 as a failure associated with the domain, and not with a particular local part.
19720 (For example, if you are storing all mail for some domain in files.) You can do
19721 this by setting &%retry_use_local_part%& false.
19722
19723 For all the local transports, its default value is true. For remote transports,
19724 the default value is false for tidiness, but changing the value has no effect
19725 on a remote transport in the current implementation.
19726
19727
19728 .option return_path transports string&!! unset
19729 .cindex "envelope sender"
19730 .cindex "transport" "return path; changing"
19731 .cindex "return path" "changing in transport"
19732 If this option is set, the string is expanded at transport time and replaces
19733 the existing return path (envelope sender) value in the copy of the message
19734 that is being delivered. An empty return path is permitted. This feature is
19735 designed for remote deliveries, where the value of this option is used in the
19736 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19737 only effect is to change the address that is placed in the &'Return-path:'&
19738 header line, if one is added to the message (see the next option).
19739
19740 &*Note:*& A changed return path is not logged unless you add
19741 &%return_path_on_delivery%& to the log selector.
19742
19743 .vindex "&$return_path$&"
19744 The expansion can refer to the existing value via &$return_path$&. This is
19745 either the message's envelope sender, or an address set by the
19746 &%errors_to%& option on a router. If the expansion is forced to fail, no
19747 replacement occurs; if it fails for another reason, delivery is deferred. This
19748 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19749 section &<<SECTverp>>&.
19750
19751 &*Note*&: If a delivery error is detected locally, including the case when a
19752 remote server rejects a message at SMTP time, the bounce message is not sent to
19753 the value of this option. It is sent to the previously set errors address.
19754 This defaults to the incoming sender address, but can be changed by setting
19755 &%errors_to%& in a router.
19756
19757
19758
19759 .option return_path_add transports boolean false
19760 .cindex "&'Return-path:'& header line"
19761 If this option is true, a &'Return-path:'& header is added to the message.
19762 Although the return path is normally available in the prefix line of BSD
19763 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19764 have easy access to it.
19765
19766 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19767 the delivery SMTP server makes the final delivery"&. This implies that this
19768 header should not be present in incoming messages. Exim has a configuration
19769 option, &%return_path_remove%&, which requests removal of this header from
19770 incoming messages, so that delivered messages can safely be resent to other
19771 recipients.
19772
19773
19774 .option shadow_condition transports string&!! unset
19775 See &%shadow_transport%& below.
19776
19777
19778 .option shadow_transport transports string unset
19779 .cindex "shadow transport"
19780 .cindex "transport" "shadow"
19781 A local transport may set the &%shadow_transport%& option to the name of
19782 another local transport. Shadow remote transports are not supported.
19783
19784 Whenever a delivery to the main transport succeeds, and either
19785 &%shadow_condition%& is unset, or its expansion does not result in the empty
19786 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19787 passed to the shadow transport, with the same delivery address or addresses. If
19788 expansion fails, no action is taken except that non-forced expansion failures
19789 cause a log line to be written.
19790
19791 The result of the shadow transport is discarded and does not affect the
19792 subsequent processing of the message. Only a single level of shadowing is
19793 provided; the &%shadow_transport%& option is ignored on any transport when it
19794 is running as a shadow. Options concerned with output from pipes are also
19795 ignored. The log line for the successful delivery has an item added on the end,
19796 of the form
19797 .code
19798 ST=<shadow transport name>
19799 .endd
19800 If the shadow transport did not succeed, the error message is put in
19801 parentheses afterwards. Shadow transports can be used for a number of different
19802 purposes, including keeping more detailed log information than Exim normally
19803 provides, and implementing automatic acknowledgment policies based on message
19804 headers that some sites insist on.
19805
19806
19807 .option transport_filter transports string&!! unset
19808 .cindex "transport" "filter"
19809 .cindex "filter" "transport filter"
19810 This option sets up a filtering (in the Unix shell sense) process for messages
19811 at transport time. It should not be confused with mail filtering as set up by
19812 individual users or via a system filter.
19813
19814 When the message is about to be written out, the command specified by
19815 &%transport_filter%& is started up in a separate, parallel process, and
19816 the entire message, including the header lines, is passed to it on its standard
19817 input (this in fact is done from a third process, to avoid deadlock). The
19818 command must be specified as an absolute path.
19819
19820 The lines of the message that are written to the transport filter are
19821 terminated by newline (&"\n"&). The message is passed to the filter before any
19822 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19823 lines beginning with a dot, and also before any processing implied by the
19824 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19825 &(pipe)& transports.
19826
19827 The standard error for the filter process is set to the same destination as its
19828 standard output; this is read and written to the message's ultimate
19829 destination. The process that writes the message to the filter, the
19830 filter itself, and the original process that reads the result and delivers it
19831 are all run in parallel, like a shell pipeline.
19832
19833 The filter can perform any transformations it likes, but of course should take
19834 care not to break RFC 2822 syntax. Exim does not check the result, except to
19835 test for a final newline when SMTP is in use. All messages transmitted over
19836 SMTP must end with a newline, so Exim supplies one if it is missing.
19837
19838 .cindex "content scanning" "per user"
19839 A transport filter can be used to provide content-scanning on a per-user basis
19840 at delivery time if the only required effect of the scan is to modify the
19841 message. For example, a content scan could insert a new header line containing
19842 a spam score. This could be interpreted by a filter in the user's MUA. It is
19843 not possible to discard a message at this stage.
19844
19845 .cindex "SMTP" "SIZE"
19846 A problem might arise if the filter increases the size of a message that is
19847 being sent down an SMTP connection. If the receiving SMTP server has indicated
19848 support for the SIZE parameter, Exim will have sent the size of the message
19849 at the start of the SMTP session. If what is actually sent is substantially
19850 more, the server might reject the message. This can be worked round by setting
19851 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19852 additions to the message, or to disable the use of SIZE altogether.
19853
19854 .vindex "&$pipe_addresses$&"
19855 The value of the &%transport_filter%& option is the command string for starting
19856 the filter, which is run directly from Exim, not under a shell. The string is
19857 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19858 Exim breaks it up into arguments and then expands each argument separately (see
19859 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19860 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19861 of arguments, one for each address that applies to this delivery. (This isn't
19862 an ideal name for this feature here, but as it was already implemented for the
19863 &(pipe)& transport, it seemed sensible not to change it.)
19864
19865 .vindex "&$host$&"
19866 .vindex "&$host_address$&"
19867 The expansion variables &$host$& and &$host_address$& are available when the
19868 transport is a remote one. They contain the name and IP address of the host to
19869 which the message is being sent. For example:
19870 .code
19871 transport_filter = /some/directory/transport-filter.pl \
19872   $host $host_address $sender_address $pipe_addresses
19873 .endd
19874
19875 Two problems arise if you want to use more complicated expansion items to
19876 generate transport filter commands, both of which due to the fact that the
19877 command is split up &'before'& expansion.
19878 .ilist
19879 If an expansion item contains white space, you must quote it, so that it is all
19880 part of the same command item. If the entire option setting is one such
19881 expansion item, you have to take care what kind of quoting you use. For
19882 example:
19883 .code
19884 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19885 .endd
19886 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19887 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19888 stripped by Exim when it read the option's value. When the value is used, if
19889 the single quotes were missing, the line would be split into two items,
19890 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19891 Exim tried to expand the first one.
19892 .next
19893 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19894 expansion cannot generate multiple arguments, or a command name followed by
19895 arguments. Consider this example:
19896 .code
19897 transport_filter = ${lookup{$host}lsearch{/a/file}\
19898                     {$value}{/bin/cat}}
19899 .endd
19900 The result of the lookup is interpreted as the name of the command, even
19901 if it contains white space. The simplest way round this is to use a shell:
19902 .code
19903 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19904                                {$value}{/bin/cat}}
19905 .endd
19906 .endlist
19907
19908 The filter process is run under the same uid and gid as the normal delivery.
19909 For remote deliveries this is the Exim uid/gid by default. The command should
19910 normally yield a zero return code. Transport filters are not supposed to fail.
19911 A non-zero code is taken to mean that the transport filter encountered some
19912 serious problem. Delivery of the message is deferred; the message remains on
19913 the queue and is tried again later. It is not possible to cause a message to be
19914 bounced from a transport filter.
19915
19916 If a transport filter is set on an autoreply transport, the original message is
19917 passed through the filter as it is being copied into the newly generated
19918 message, which happens if the &%return_message%& option is set.
19919
19920
19921 .option transport_filter_timeout transports time 5m
19922 .cindex "transport" "filter, timeout"
19923 When Exim is reading the output of a transport filter, it applies a timeout
19924 that can be set by this option. Exceeding the timeout is normally treated as a
19925 temporary delivery failure. However, if a transport filter is used with a
19926 &(pipe)& transport, a timeout in the transport filter is treated in the same
19927 way as a timeout in the pipe command itself. By default, a timeout is a hard
19928 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19929 becomes a temporary error.
19930
19931
19932 .option user transports string&!! "Exim user"
19933 .cindex "uid (user id)" "local delivery"
19934 .cindex "transport" "user, specifying"
19935 This option specifies the user under whose uid the delivery process is to be
19936 run, overriding any uid that may have been set by the router. If the user is
19937 given as a name, the uid is looked up from the password data, and the
19938 associated group is taken as the value of the gid to be used if the &%group%&
19939 option is not set.
19940
19941 For deliveries that use local transports, a user and group are normally
19942 specified explicitly or implicitly (for example, as a result of
19943 &%check_local_user%&) by the router or transport.
19944
19945 .cindex "hints database" "access by remote transport"
19946 For remote transports, you should leave this option unset unless you really are
19947 sure you know what you are doing. When a remote transport is running, it needs
19948 to be able to access Exim's hints databases, because each host may have its own
19949 retry data.
19950 .ecindex IIDgenoptra1
19951 .ecindex IIDgenoptra2
19952 .ecindex IIDgenoptra3
19953
19954
19955
19956
19957
19958
19959 . ////////////////////////////////////////////////////////////////////////////
19960 . ////////////////////////////////////////////////////////////////////////////
19961
19962 .chapter "Address batching in local transports" "CHAPbatching" &&&
19963          "Address batching"
19964 .cindex "transport" "local; address batching in"
19965 The only remote transport (&(smtp)&) is normally configured to handle more than
19966 one address at a time, so that when several addresses are routed to the same
19967 remote host, just one copy of the message is sent. Local transports, however,
19968 normally handle one address at a time. That is, a separate instance of the
19969 transport is run for each address that is routed to the transport. A separate
19970 copy of the message is delivered each time.
19971
19972 .cindex "batched local delivery"
19973 .oindex "&%batch_max%&"
19974 .oindex "&%batch_id%&"
19975 In special cases, it may be desirable to handle several addresses at once in a
19976 local transport, for example:
19977
19978 .ilist
19979 In an &(appendfile)& transport, when storing messages in files for later
19980 delivery by some other means, a single copy of the message with multiple
19981 recipients saves space.
19982 .next
19983 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19984 a single copy saves time, and is the normal way LMTP is expected to work.
19985 .next
19986 In a &(pipe)& transport, when passing the message
19987 to a scanner program or
19988 to some other delivery mechanism such as UUCP, multiple recipients may be
19989 acceptable.
19990 .endlist
19991
19992 These three local transports all have the same options for controlling multiple
19993 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19994 repeating the information for each transport, these options are described here.
19995
19996 The &%batch_max%& option specifies the maximum number of addresses that can be
19997 delivered together in a single run of the transport. Its default value is one
19998 (no batching). When more than one address is routed to a transport that has a
19999 &%batch_max%& value greater than one, the addresses are delivered in a batch
20000 (that is, in a single run of the transport with multiple recipients), subject
20001 to certain conditions:
20002
20003 .ilist
20004 .vindex "&$local_part$&"
20005 If any of the transport's options contain a reference to &$local_part$&, no
20006 batching is possible.
20007 .next
20008 .vindex "&$domain$&"
20009 If any of the transport's options contain a reference to &$domain$&, only
20010 addresses with the same domain are batched.
20011 .next
20012 .cindex "customizing" "batching condition"
20013 If &%batch_id%& is set, it is expanded for each address, and only those
20014 addresses with the same expanded value are batched. This allows you to specify
20015 customized batching conditions. Failure of the expansion for any reason,
20016 including forced failure, disables batching, but it does not stop the delivery
20017 from taking place.
20018 .next
20019 Batched addresses must also have the same errors address (where to send
20020 delivery errors), the same header additions and removals, the same user and
20021 group for the transport, and if a host list is present, the first host must
20022 be the same.
20023 .endlist
20024
20025 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20026 both when the file or pipe command is specified in the transport, and when it
20027 is specified by a &(redirect)& router, but all the batched addresses must of
20028 course be routed to the same file or pipe command. These two transports have an
20029 option called &%use_bsmtp%&, which causes them to deliver the message in
20030 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20031 &%check_string%& and &%escape_string%& options are forced to the values
20032 .code
20033 check_string = "."
20034 escape_string = ".."
20035 .endd
20036 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20037 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20038 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20039
20040 .cindex "&'Envelope-to:'& header line"
20041 If the generic &%envelope_to_add%& option is set for a batching transport, the
20042 &'Envelope-to:'& header that is added to the message contains all the addresses
20043 that are being processed together. If you are using a batching &(appendfile)&
20044 transport without &%use_bsmtp%&, the only way to preserve the recipient
20045 addresses is to set the &%envelope_to_add%& option.
20046
20047 .cindex "&(pipe)& transport" "with multiple addresses"
20048 .vindex "&$pipe_addresses$&"
20049 If you are using a &(pipe)& transport without BSMTP, and setting the
20050 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20051 the command. This is not a true variable; it is a bit of magic that causes each
20052 of the recipient addresses to be inserted into the command as a separate
20053 argument. This provides a way of accessing all the addresses that are being
20054 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20055 are specified by a &(redirect)& router.
20056
20057
20058
20059
20060 . ////////////////////////////////////////////////////////////////////////////
20061 . ////////////////////////////////////////////////////////////////////////////
20062
20063 .chapter "The appendfile transport" "CHAPappendfile"
20064 .scindex IIDapptra1 "&(appendfile)& transport"
20065 .scindex IIDapptra2 "transports" "&(appendfile)&"
20066 .cindex "directory creation"
20067 .cindex "creating directories"
20068 The &(appendfile)& transport delivers a message by appending it to an existing
20069 file, or by creating an entirely new file in a specified directory. Single
20070 files to which messages are appended can be in the traditional Unix mailbox
20071 format, or optionally in the MBX format supported by the Pine MUA and
20072 University of Washington IMAP daemon, &'inter alia'&. When each message is
20073 being delivered as a separate file, &"maildir"& format can optionally be used
20074 to give added protection against failures that happen part-way through the
20075 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20076 supported. For all file formats, Exim attempts to create as many levels of
20077 directory as necessary, provided that &%create_directory%& is set.
20078
20079 The code for the optional formats is not included in the Exim binary by
20080 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20081 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20082 included.
20083
20084 .cindex "quota" "system"
20085 Exim recognizes system quota errors, and generates an appropriate message. Exim
20086 also supports its own quota control within the transport, for use when the
20087 system facility is unavailable or cannot be used for some reason.
20088
20089 If there is an error while appending to a file (for example, quota exceeded or
20090 partition filled), Exim attempts to reset the file's length and last
20091 modification time back to what they were before. If there is an error while
20092 creating an entirely new file, the new file is removed.
20093
20094 Before appending to a file, a number of security checks are made, and the
20095 file is locked. A detailed description is given below, after the list of
20096 private options.
20097
20098 The &(appendfile)& transport is most commonly used for local deliveries to
20099 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20100 putting messages into files for remote delivery by some means other than Exim.
20101 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20102 option).
20103
20104
20105
20106 .section "The file and directory options" "SECTfildiropt"
20107 The &%file%& option specifies a single file, to which the message is appended;
20108 the &%directory%& option specifies a directory, in which a new file containing
20109 the message is created. Only one of these two options can be set, and for
20110 normal deliveries to mailboxes, one of them &'must'& be set.
20111
20112 .vindex "&$address_file$&"
20113 .vindex "&$local_part$&"
20114 However, &(appendfile)& is also used for delivering messages to files or
20115 directories whose names (or parts of names) are obtained from alias,
20116 forwarding, or filtering operations (for example, a &%save%& command in a
20117 user's Exim filter). When such a transport is running, &$local_part$& contains
20118 the local part that was aliased or forwarded, and &$address_file$& contains the
20119 name (or partial name) of the file or directory generated by the redirection
20120 operation. There are two cases:
20121
20122 .ilist
20123 If neither &%file%& nor &%directory%& is set, the redirection operation
20124 must specify an absolute path (one that begins with &`/`&). This is the most
20125 common case when users with local accounts use filtering to sort mail into
20126 different folders. See for example, the &(address_file)& transport in the
20127 default configuration. If the path ends with a slash, it is assumed to be the
20128 name of a directory. A delivery to a directory can also be forced by setting
20129 &%maildir_format%& or &%mailstore_format%&.
20130 .next
20131 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20132 used to determine the file or directory name for the delivery. Normally, the
20133 contents of &$address_file$& are used in some way in the string expansion.
20134 .endlist
20135
20136
20137 .cindex "Sieve filter" "configuring &(appendfile)&"
20138 .cindex "Sieve filter" "relative mailbox path handling"
20139 As an example of the second case, consider an environment where users do not
20140 have home directories. They may be permitted to use Exim filter commands of the
20141 form:
20142 .code
20143 save folder23
20144 .endd
20145 or Sieve filter commands of the form:
20146 .code
20147 require "fileinto";
20148 fileinto "folder23";
20149 .endd
20150 In this situation, the expansion of &%file%& or &%directory%& in the transport
20151 must transform the relative path into an appropriate absolute file name. In the
20152 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20153 is used as a result of a &"keep"& action in the filter. This example shows one
20154 way of handling this requirement:
20155 .code
20156 file = ${if eq{$address_file}{inbox} \
20157             {/var/mail/$local_part} \
20158             {${if eq{${substr_0_1:$address_file}}{/} \
20159                   {$address_file} \
20160                   {$home/mail/$address_file} \
20161             }} \
20162        }
20163 .endd
20164 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20165 location, absolute paths are used without change, and other folders are in the
20166 &_mail_& directory within the home directory.
20167
20168 &*Note 1*&: While processing an Exim filter, a relative path such as
20169 &_folder23_& is turned into an absolute path if a home directory is known to
20170 the router. In particular, this is the case if &%check_local_user%& is set. If
20171 you want to prevent this happening at routing time, you can set
20172 &%router_home_directory%& empty. This forces the router to pass the relative
20173 path to the transport.
20174
20175 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20176 the &%file%& or &%directory%& option is still used if it is set.
20177
20178
20179
20180
20181 .section "Private options for appendfile" "SECID134"
20182 .cindex "options" "&(appendfile)& transport"
20183
20184
20185
20186 .option allow_fifo appendfile boolean false
20187 .cindex "fifo (named pipe)"
20188 .cindex "named pipe (fifo)"
20189 .cindex "pipe" "named (fifo)"
20190 Setting this option permits delivery to named pipes (FIFOs) as well as to
20191 regular files. If no process is reading the named pipe at delivery time, the
20192 delivery is deferred.
20193
20194
20195 .option allow_symlink appendfile boolean false
20196 .cindex "symbolic link" "to mailbox"
20197 .cindex "mailbox" "symbolic link"
20198 By default, &(appendfile)& will not deliver if the path name for the file is
20199 that of a symbolic link. Setting this option relaxes that constraint, but there
20200 are security issues involved in the use of symbolic links. Be sure you know
20201 what you are doing if you set this. Details of exactly what this option affects
20202 are included in the discussion which follows this list of options.
20203
20204
20205 .option batch_id appendfile string&!! unset
20206 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20207 However, batching is automatically disabled for &(appendfile)& deliveries that
20208 happen as a result of forwarding or aliasing or other redirection directly to a
20209 file.
20210
20211
20212 .option batch_max appendfile integer 1
20213 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20214
20215
20216 .option check_group appendfile boolean false
20217 When this option is set, the group owner of the file defined by the &%file%&
20218 option is checked to see that it is the same as the group under which the
20219 delivery process is running. The default setting is false because the default
20220 file mode is 0600, which means that the group is irrelevant.
20221
20222
20223 .option check_owner appendfile boolean true
20224 When this option is set, the owner of the file defined by the &%file%& option
20225 is checked to ensure that it is the same as the user under which the delivery
20226 process is running.
20227
20228
20229 .option check_string appendfile string "see below"
20230 .cindex "&""From""& line"
20231 As &(appendfile)& writes the message, the start of each line is tested for
20232 matching &%check_string%&, and if it does, the initial matching characters are
20233 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20234 a literal string, not a regular expression, and the case of any letters it
20235 contains is significant.
20236
20237 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20238 are forced to &"."& and &".."& respectively, and any settings in the
20239 configuration are ignored. Otherwise, they default to &"From&~"& and
20240 &">From&~"& when the &%file%& option is set, and unset when any of the
20241 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20242
20243 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20244 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20245 &"From&~"& indicates the start of a new message. All four options need changing
20246 if another format is used. For example, to deliver to mailboxes in MMDF format:
20247 .cindex "MMDF format mailbox"
20248 .cindex "mailbox" "MMDF format"
20249 .code
20250 check_string = "\1\1\1\1\n"
20251 escape_string = "\1\1\1\1 \n"
20252 message_prefix = "\1\1\1\1\n"
20253 message_suffix = "\1\1\1\1\n"
20254 .endd
20255 .option create_directory appendfile boolean true
20256 .cindex "directory creation"
20257 When this option is true, Exim attempts to create any missing superior
20258 directories for the file that it is about to write. A created directory's mode
20259 is given by the &%directory_mode%& option.
20260
20261 The group ownership of a newly created directory is highly dependent on the
20262 operating system (and possibly the file system) that is being used. For
20263 example, in Solaris, if the parent directory has the setgid bit set, its group
20264 is propagated to the child; if not, the currently set group is used. However,
20265 in FreeBSD, the parent's group is always used.
20266
20267
20268
20269 .option create_file appendfile string anywhere
20270 This option constrains the location of files and directories that are created
20271 by this transport. It applies to files defined by the &%file%& option and
20272 directories defined by the &%directory%& option. In the case of maildir
20273 delivery, it applies to the top level directory, not the maildir directories
20274 beneath.
20275
20276 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20277 &"belowhome"&. In the second and third cases, a home directory must have been
20278 set for the transport. This option is not useful when an explicit file name is
20279 given for normal mailbox deliveries. It is intended for the case when file
20280 names are generated from users' &_.forward_& files. These are usually handled
20281 by an &(appendfile)& transport called &%address_file%&. See also
20282 &%file_must_exist%&.
20283
20284
20285 .option directory appendfile string&!! unset
20286 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20287 or &%directory%& must be set, unless the delivery is the direct result of a
20288 redirection (see section &<<SECTfildiropt>>&).
20289
20290 When &%directory%& is set, the string is expanded, and the message is delivered
20291 into a new file or files in or below the given directory, instead of being
20292 appended to a single mailbox file. A number of different formats are provided
20293 (see &%maildir_format%& and &%mailstore_format%&), and see section
20294 &<<SECTopdir>>& for further details of this form of delivery.
20295
20296
20297 .option directory_file appendfile string&!! "see below"
20298 .cindex "base62"
20299 .vindex "&$inode$&"
20300 When &%directory%& is set, but neither &%maildir_format%& nor
20301 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20302 whose name is obtained by expanding this string. The default value is:
20303 .code
20304 q${base62:$tod_epoch}-$inode
20305 .endd
20306 This generates a unique name from the current time, in base 62 form, and the
20307 inode of the file. The variable &$inode$& is available only when expanding this
20308 option.
20309
20310
20311 .option directory_mode appendfile "octal integer" 0700
20312 If &(appendfile)& creates any directories as a result of the
20313 &%create_directory%& option, their mode is specified by this option.
20314
20315
20316 .option escape_string appendfile string "see description"
20317 See &%check_string%& above.
20318
20319
20320 .option file appendfile string&!! unset
20321 This option is mutually exclusive with the &%directory%& option, but one of
20322 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20323 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20324 specifies a single file, to which the message is appended. One or more of
20325 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20326 &%file%&.
20327
20328 .cindex "NFS" "lock file"
20329 .cindex "locking files"
20330 .cindex "lock files"
20331 If you are using more than one host to deliver over NFS into the same
20332 mailboxes, you should always use lock files.
20333
20334 The string value is expanded for each delivery, and must yield an absolute
20335 path. The most common settings of this option are variations on one of these
20336 examples:
20337 .code
20338 file = /var/spool/mail/$local_part
20339 file = /home/$local_part/inbox
20340 file = $home/inbox
20341 .endd
20342 .cindex "&""sticky""& bit"
20343 In the first example, all deliveries are done into the same directory. If Exim
20344 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20345 create a file in the directory, so the &"sticky"& bit must be turned on for
20346 deliveries to be possible, or alternatively the &%group%& option can be used to
20347 run the delivery under a group id which has write access to the directory.
20348
20349
20350
20351 .option file_format appendfile string unset
20352 .cindex "file" "mailbox; checking existing format"
20353 This option requests the transport to check the format of an existing file
20354 before adding to it. The check consists of matching a specific string at the
20355 start of the file. The value of the option consists of an even number of
20356 colon-separated strings. The first of each pair is the test string, and the
20357 second is the name of a transport. If the transport associated with a matched
20358 string is not the current transport, control is passed over to the other
20359 transport. For example, suppose the standard &(local_delivery)& transport has
20360 this added to it:
20361 .code
20362 file_format = "From       : local_delivery :\
20363                \1\1\1\1\n : local_mmdf_delivery"
20364 .endd
20365 Mailboxes that begin with &"From"& are still handled by this transport, but if
20366 a mailbox begins with four binary ones followed by a newline, control is passed
20367 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20368 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20369 is assumed to match the current transport. If the start of a mailbox doesn't
20370 match any string, or if the transport named for a given string is not defined,
20371 delivery is deferred.
20372
20373
20374 .option file_must_exist appendfile boolean false
20375 If this option is true, the file specified by the &%file%& option must exist.
20376 A temporary error occurs if it does not, causing delivery to be deferred.
20377 If this option is false, the file is created if it does not exist.
20378
20379
20380 .option lock_fcntl_timeout appendfile time 0s
20381 .cindex "timeout" "mailbox locking"
20382 .cindex "mailbox" "locking, blocking and non-blocking"
20383 .cindex "locking files"
20384 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20385 when locking an open mailbox file. If the call fails, the delivery process
20386 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20387 Non-blocking calls are used so that the file is not kept open during the wait
20388 for the lock; the reason for this is to make it as safe as possible for
20389 deliveries over NFS in the case when processes might be accessing an NFS
20390 mailbox without using a lock file. This should not be done, but
20391 misunderstandings and hence misconfigurations are not unknown.
20392
20393 On a busy system, however, the performance of a non-blocking lock approach is
20394 not as good as using a blocking lock with a timeout. In this case, the waiting
20395 is done inside the system call, and Exim's delivery process acquires the lock
20396 and can proceed as soon as the previous lock holder releases it.
20397
20398 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20399 timeout, are used. There may still be some retrying: the maximum number of
20400 retries is
20401 .code
20402 (lock_retries * lock_interval) / lock_fcntl_timeout
20403 .endd
20404 rounded up to the next whole number. In other words, the total time during
20405 which &(appendfile)& is trying to get a lock is roughly the same, unless
20406 &%lock_fcntl_timeout%& is set very large.
20407
20408 You should consider setting this option if you are getting a lot of delayed
20409 local deliveries because of errors of the form
20410 .code
20411 failed to lock mailbox /some/file (fcntl)
20412 .endd
20413
20414 .option lock_flock_timeout appendfile time 0s
20415 This timeout applies to file locking when using &[flock()]& (see
20416 &%use_flock%&); the timeout operates in a similar manner to
20417 &%lock_fcntl_timeout%&.
20418
20419
20420 .option lock_interval appendfile time 3s
20421 This specifies the time to wait between attempts to lock the file. See below
20422 for details of locking.
20423
20424
20425 .option lock_retries appendfile integer 10
20426 This specifies the maximum number of attempts to lock the file. A value of zero
20427 is treated as 1. See below for details of locking.
20428
20429
20430 .option lockfile_mode appendfile "octal integer" 0600
20431 This specifies the mode of the created lock file, when a lock file is being
20432 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20433
20434
20435 .option lockfile_timeout appendfile time 30m
20436 .cindex "timeout" "mailbox locking"
20437 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20438 exists and is older than this value, it is assumed to have been left behind by
20439 accident, and Exim attempts to remove it.
20440
20441
20442 .option mailbox_filecount appendfile string&!! unset
20443 .cindex "mailbox" "specifying size of"
20444 .cindex "size" "of mailbox"
20445 If this option is set, it is expanded, and the result is taken as the current
20446 number of files in the mailbox. It must be a decimal number, optionally
20447 followed by K or M. This provides a way of obtaining this information from an
20448 external source that maintains the data.
20449
20450
20451 .option mailbox_size appendfile string&!! unset
20452 .cindex "mailbox" "specifying size of"
20453 .cindex "size" "of mailbox"
20454 If this option is set, it is expanded, and the result is taken as the current
20455 size the mailbox. It must be a decimal number, optionally followed by K or M.
20456 This provides a way of obtaining this information from an external source that
20457 maintains the data. This is likely to be helpful for maildir deliveries where
20458 it is computationally expensive to compute the size of a mailbox.
20459
20460
20461
20462 .option maildir_format appendfile boolean false
20463 .cindex "maildir format" "specifying"
20464 If this option is set with the &%directory%& option, the delivery is into a new
20465 file, in the &"maildir"& format that is used by other mail software. When the
20466 transport is activated directly from a &(redirect)& router (for example, the
20467 &(address_file)& transport in the default configuration), setting
20468 &%maildir_format%& causes the path received from the router to be treated as a
20469 directory, whether or not it ends with &`/`&. This option is available only if
20470 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20471 &<<SECTmaildirdelivery>>& below for further details.
20472
20473
20474 .option maildir_quota_directory_regex appendfile string "See below"
20475 .cindex "maildir format" "quota; directories included in"
20476 .cindex "quota" "maildir; directories included in"
20477 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20478 a regular expression for specifying directories, relative to the quota
20479 directory (see &%quota_directory%&), that should be included in the quota
20480 calculation. The default value is:
20481 .code
20482 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20483 .endd
20484 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20485 (directories whose names begin with a dot). If you want to exclude the
20486 &_Trash_&
20487 folder from the count (as some sites do), you need to change this setting to
20488 .code
20489 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20490 .endd
20491 This uses a negative lookahead in the regular expression to exclude the
20492 directory whose name is &_.Trash_&. When a directory is excluded from quota
20493 calculations, quota processing is bypassed for any messages that are delivered
20494 directly into that directory.
20495
20496
20497 .option maildir_retries appendfile integer 10
20498 This option specifies the number of times to retry when writing a file in
20499 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20500
20501
20502 .option maildir_tag appendfile string&!! unset
20503 This option applies only to deliveries in maildir format, and is described in
20504 section &<<SECTmaildirdelivery>>& below.
20505
20506
20507 .option maildir_use_size_file appendfile&!! boolean false
20508 .cindex "maildir format" "&_maildirsize_& file"
20509 The result of string expansion for this option must be a valid boolean value.
20510 If it is true, it enables support for &_maildirsize_& files. Exim
20511 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20512 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20513 value is zero. See &%maildir_quota_directory_regex%& above and section
20514 &<<SECTmaildirdelivery>>& below for further details.
20515
20516 .option maildirfolder_create_regex appendfile string unset
20517 .cindex "maildir format" "&_maildirfolder_& file"
20518 .cindex "&_maildirfolder_&, creating"
20519 The value of this option is a regular expression. If it is unset, it has no
20520 effect. Otherwise, before a maildir delivery takes place, the pattern is
20521 matched against the name of the maildir directory, that is, the directory
20522 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20523 delivery. If there is a match, Exim checks for the existence of a file called
20524 &_maildirfolder_& in the directory, and creates it if it does not exist.
20525 See section &<<SECTmaildirdelivery>>& for more details.
20526
20527
20528 .option mailstore_format appendfile boolean false
20529 .cindex "mailstore format" "specifying"
20530 If this option is set with the &%directory%& option, the delivery is into two
20531 new files in  &"mailstore"& format. The option is available only if
20532 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20533 below for further details.
20534
20535
20536 .option mailstore_prefix appendfile string&!! unset
20537 This option applies only to deliveries in mailstore format, and is described in
20538 section &<<SECTopdir>>& below.
20539
20540
20541 .option mailstore_suffix appendfile string&!! unset
20542 This option applies only to deliveries in mailstore format, and is described in
20543 section &<<SECTopdir>>& below.
20544
20545
20546 .option mbx_format appendfile boolean false
20547 .cindex "locking files"
20548 .cindex "file" "locking"
20549 .cindex "file" "MBX format"
20550 .cindex "MBX format, specifying"
20551 This option is available only if Exim has been compiled with SUPPORT_MBX
20552 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20553 the message is appended to the mailbox file in MBX format instead of
20554 traditional Unix format. This format is supported by Pine4 and its associated
20555 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20556
20557 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20558 automatically changed by the use of &%mbx_format%&. They should normally be set
20559 empty when using MBX format, so this option almost always appears in this
20560 combination:
20561 .code
20562 mbx_format = true
20563 message_prefix =
20564 message_suffix =
20565 .endd
20566 If none of the locking options are mentioned in the configuration,
20567 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20568 is possible to specify the other kinds of locking with &%mbx_format%&, but
20569 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20570 interworks with &'c-client'&, providing for shared access to the mailbox. It
20571 should not be used if any program that does not use this form of locking is
20572 going to access the mailbox, nor should it be used if the mailbox file is NFS
20573 mounted, because it works only when the mailbox is accessed from a single host.
20574
20575 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20576 the standard version of &'c-client'&, because as long as it has a mailbox open
20577 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20578 append messages to it.
20579
20580
20581 .option message_prefix appendfile string&!! "see below"
20582 .cindex "&""From""& line"
20583 The string specified here is expanded and output at the start of every message.
20584 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20585 in which case it is:
20586 .code
20587 message_prefix = "From ${if def:return_path{$return_path}\
20588   {MAILER-DAEMON}} $tod_bsdinbox\n"
20589 .endd
20590 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20591 &`\n`& to &`\r\n`& in &%message_prefix%&.
20592
20593 .option message_suffix appendfile string&!! "see below"
20594 The string specified here is expanded and output at the end of every message.
20595 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20596 in which case it is a single newline character. The suffix can be suppressed by
20597 setting
20598 .code
20599 message_suffix =
20600 .endd
20601 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20602 &`\n`& to &`\r\n`& in &%message_suffix%&.
20603
20604 .option mode appendfile "octal integer" 0600
20605 If the output file is created, it is given this mode. If it already exists and
20606 has wider permissions, they are reduced to this mode. If it has narrower
20607 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20608 if the delivery is the result of a &%save%& command in a filter file specifying
20609 a particular mode, the mode of the output file is always forced to take that
20610 value, and this option is ignored.
20611
20612
20613 .option mode_fail_narrower appendfile boolean true
20614 This option applies in the case when an existing mailbox file has a narrower
20615 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20616 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20617 continues with the delivery attempt, using the existing mode of the file.
20618
20619
20620 .option notify_comsat appendfile boolean false
20621 If this option is true, the &'comsat'& daemon is notified after every
20622 successful delivery to a user mailbox. This is the daemon that notifies logged
20623 on users about incoming mail.
20624
20625
20626 .option quota appendfile string&!! unset
20627 .cindex "quota" "imposed by Exim"
20628 This option imposes a limit on the size of the file to which Exim is appending,
20629 or to the total space used in the directory tree when the &%directory%& option
20630 is set. In the latter case, computation of the space used is expensive, because
20631 all the files in the directory (and any sub-directories) have to be
20632 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20633 &%maildir_use_size_file%& for ways to avoid this in environments where users
20634 have no shell access to their mailboxes).
20635
20636 As there is no interlock against two simultaneous deliveries into a
20637 multi-file mailbox, it is possible for the quota to be overrun in this case.
20638 For single-file mailboxes, of course, an interlock is a necessity.
20639
20640 A file's size is taken as its &'used'& value. Because of blocking effects, this
20641 may be a lot less than the actual amount of disk space allocated to the file.
20642 If the sizes of a number of files are being added up, the rounding effect can
20643 become quite noticeable, especially on systems that have large block sizes.
20644 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20645 the obvious value which users understand most easily.
20646
20647 The value of the option is expanded, and must then be a numerical value
20648 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20649 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20650 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20651 be handled.
20652
20653 &*Note*&: A value of zero is interpreted as &"no quota"&.
20654
20655 The expansion happens while Exim is running as root, before it changes uid for
20656 the delivery. This means that files that are inaccessible to the end user can
20657 be used to hold quota values that are looked up in the expansion. When delivery
20658 fails because this quota is exceeded, the handling of the error is as for
20659 system quota failures.
20660
20661 By default, Exim's quota checking mimics system quotas, and restricts the
20662 mailbox to the specified maximum size, though the value is not accurate to the
20663 last byte, owing to separator lines and additional headers that may get added
20664 during message delivery. When a mailbox is nearly full, large messages may get
20665 refused even though small ones are accepted, because the size of the current
20666 message is added to the quota when the check is made. This behaviour can be
20667 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20668 for exceeding the quota does not include the current message. Thus, deliveries
20669 continue until the quota has been exceeded; thereafter, no further messages are
20670 delivered. See also &%quota_warn_threshold%&.
20671
20672
20673 .option quota_directory appendfile string&!! unset
20674 This option defines the directory to check for quota purposes when delivering
20675 into individual files. The default is the delivery directory, or, if a file
20676 called &_maildirfolder_& exists in a maildir directory, the parent of the
20677 delivery directory.
20678
20679
20680 .option quota_filecount appendfile string&!! 0
20681 This option applies when the &%directory%& option is set. It limits the total
20682 number of files in the directory (compare the inode limit in system quotas). It
20683 can only be used if &%quota%& is also set. The value is expanded; an expansion
20684 failure causes delivery to be deferred. A value of zero is interpreted as
20685 &"no quota"&.
20686
20687
20688 .option quota_is_inclusive appendfile boolean true
20689 See &%quota%& above.
20690
20691
20692 .option quota_size_regex appendfile string unset
20693 This option applies when one of the delivery modes that writes a separate file
20694 for each message is being used. When Exim wants to find the size of one of
20695 these files in order to test the quota, it first checks &%quota_size_regex%&.
20696 If this is set to a regular expression that matches the file name, and it
20697 captures one string, that string is interpreted as a representation of the
20698 file's size. The value of &%quota_size_regex%& is not expanded.
20699
20700 This feature is useful only when users have no shell access to their mailboxes
20701 &-- otherwise they could defeat the quota simply by renaming the files. This
20702 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20703 the file length to the file name. For example:
20704 .code
20705 maildir_tag = ,S=$message_size
20706 quota_size_regex = ,S=(\d+)
20707 .endd
20708 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20709 number of lines in the message.
20710
20711 The regular expression should not assume that the length is at the end of the
20712 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20713 sometimes add other information onto the ends of message file names.
20714
20715 Section &<<SECID136>>& contains further information.
20716
20717
20718 .option quota_warn_message appendfile string&!! "see below"
20719 See below for the use of this option. If it is not set when
20720 &%quota_warn_threshold%& is set, it defaults to
20721 .code
20722 quota_warn_message = "\
20723   To: $local_part@$domain\n\
20724   Subject: Your mailbox\n\n\
20725   This message is automatically created \
20726   by mail delivery software.\n\n\
20727   The size of your mailbox has exceeded \
20728   a warning threshold that is\n\
20729   set by the system administrator.\n"
20730 .endd
20731
20732
20733 .option quota_warn_threshold appendfile string&!! 0
20734 .cindex "quota" "warning threshold"
20735 .cindex "mailbox" "size warning"
20736 .cindex "size" "of mailbox"
20737 This option is expanded in the same way as &%quota%& (see above). If the
20738 resulting value is greater than zero, and delivery of the message causes the
20739 size of the file or total space in the directory tree to cross the given
20740 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20741 may be specified as a percentage of it by following the value with a percent
20742 sign. For example:
20743 .code
20744 quota = 10M
20745 quota_warn_threshold = 75%
20746 .endd
20747 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20748 percent sign is ignored.
20749
20750 The warning message itself is specified by the &%quota_warn_message%& option,
20751 and it must start with a &'To:'& header line containing the recipient(s) of the
20752 warning message. These do not necessarily have to include the recipient(s) of
20753 the original message. A &'Subject:'& line should also normally be supplied. You
20754 can include any other header lines that you want. If you do not include a
20755 &'From:'& line, the default is:
20756 .code
20757 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20758 .endd
20759 .oindex &%errors_reply_to%&
20760 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20761 option.
20762
20763 The &%quota%& option does not have to be set in order to use this option; they
20764 are independent of one another except when the threshold is specified as a
20765 percentage.
20766
20767
20768 .option use_bsmtp appendfile boolean false
20769 .cindex "envelope sender"
20770 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20771 format, with the envelope sender and recipient(s) included as SMTP commands. If
20772 you want to include a leading HELO command with such messages, you can do
20773 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20774 for details of batch SMTP.
20775
20776
20777 .option use_crlf appendfile boolean false
20778 .cindex "carriage return"
20779 .cindex "linefeed"
20780 This option causes lines to be terminated with the two-character CRLF sequence
20781 (carriage return, linefeed) instead of just a linefeed character. In the case
20782 of batched SMTP, the byte sequence written to the file is then an exact image
20783 of what would be sent down a real SMTP connection.
20784
20785 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20786 (which are used to supply the traditional &"From&~"& and blank line separators
20787 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20788 carriage return characters if these are needed. In cases where these options
20789 have non-empty defaults, the values end with a single linefeed, so they must be
20790 changed to end with &`\r\n`& if &%use_crlf%& is set.
20791
20792
20793 .option use_fcntl_lock appendfile boolean "see below"
20794 This option controls the use of the &[fcntl()]& function to lock a file for
20795 exclusive use when a message is being appended. It is set by default unless
20796 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20797 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20798 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20799
20800
20801 .option use_flock_lock appendfile boolean false
20802 This option is provided to support the use of &[flock()]& for file locking, for
20803 the few situations where it is needed. Most modern operating systems support
20804 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20805 each other. Exim uses &[fcntl()]& locking by default.
20806
20807 This option is required only if you are using an operating system where
20808 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20809 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20810 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20811
20812 .cindex "Solaris" "&[flock()]& support"
20813 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20814 have it (and some, I think, provide a not quite right version built on top of
20815 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20816 the ability to use it, and any attempt to do so will cause a configuration
20817 error.
20818
20819 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20820 is just being mapped onto &[fcntl()]& by the OS).
20821
20822
20823 .option use_lockfile appendfile boolean "see below"
20824 If this option is turned off, Exim does not attempt to create a lock file when
20825 appending to a mailbox file. In this situation, the only locking is by
20826 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20827 sure that every MUA that is ever going to look at your users' mailboxes uses
20828 &[fcntl()]& rather than a lock file, and even then only when you are not
20829 delivering over NFS from more than one host.
20830
20831 .cindex "NFS" "lock file"
20832 In order to append to an NFS file safely from more than one host, it is
20833 necessary to take out a lock &'before'& opening the file, and the lock file
20834 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20835 file corruption.
20836
20837 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20838 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20839 except when &%mbx_format%& is set.
20840
20841
20842 .option use_mbx_lock appendfile boolean "see below"
20843 This option is available only if Exim has been compiled with SUPPORT_MBX
20844 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20845 locking rules be used. It is set by default if &%mbx_format%& is set and none
20846 of the locking options are mentioned in the configuration. The locking rules
20847 are the same as are used by the &'c-client'& library that underlies Pine and
20848 the IMAP4 and POP daemons that come with it (see the discussion below). The
20849 rules allow for shared access to the mailbox. However, this kind of locking
20850 does not work when the mailbox is NFS mounted.
20851
20852 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20853 &%use_flock_lock%& to control what kind of locking is used in implementing the
20854 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20855 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20856
20857
20858
20859
20860 .section "Operational details for appending" "SECTopappend"
20861 .cindex "appending to a file"
20862 .cindex "file" "appending"
20863 Before appending to a file, the following preparations are made:
20864
20865 .ilist
20866 If the name of the file is &_/dev/null_&, no action is taken, and a success
20867 return is given.
20868
20869 .next
20870 .cindex "directory creation"
20871 If any directories on the file's path are missing, Exim creates them if the
20872 &%create_directory%& option is set. A created directory's mode is given by the
20873 &%directory_mode%& option.
20874
20875 .next
20876 If &%file_format%& is set, the format of an existing file is checked. If this
20877 indicates that a different transport should be used, control is passed to that
20878 transport.
20879
20880 .next
20881 .cindex "file" "locking"
20882 .cindex "locking files"
20883 .cindex "NFS" "lock file"
20884 If &%use_lockfile%& is set, a lock file is built in a way that will work
20885 reliably over NFS, as follows:
20886
20887 .olist
20888 Create a &"hitching post"& file whose name is that of the lock file with the
20889 current time, primary host name, and process id added, by opening for writing
20890 as a new file. If this fails with an access error, delivery is deferred.
20891 .next
20892 Close the hitching post file, and hard link it to the lock file name.
20893 .next
20894 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20895 Unlink the hitching post name.
20896 .next
20897 Otherwise, use &[stat()]& to get information about the hitching post file, and
20898 then unlink hitching post name. If the number of links is exactly two, creation
20899 of the lock file succeeded but something (for example, an NFS server crash and
20900 restart) caused this fact not to be communicated to the &[link()]& call.
20901 .next
20902 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20903 up to &%lock_retries%& times. However, since any program that writes to a
20904 mailbox should complete its task very quickly, it is reasonable to time out old
20905 lock files that are normally the result of user agent and system crashes. If an
20906 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20907 it before trying again.
20908 .endlist olist
20909
20910 .next
20911 A call is made to &[lstat()]& to discover whether the main file exists, and if
20912 so, what its characteristics are. If &[lstat()]& fails for any reason other
20913 than non-existence, delivery is deferred.
20914
20915 .next
20916 .cindex "symbolic link" "to mailbox"
20917 .cindex "mailbox" "symbolic link"
20918 If the file does exist and is a symbolic link, delivery is deferred, unless the
20919 &%allow_symlink%& option is set, in which case the ownership of the link is
20920 checked, and then &[stat()]& is called to find out about the real file, which
20921 is then subjected to the checks below. The check on the top-level link
20922 ownership prevents one user creating a link for another's mailbox in a sticky
20923 directory, though allowing symbolic links in this case is definitely not a good
20924 idea. If there is a chain of symbolic links, the intermediate ones are not
20925 checked.
20926
20927 .next
20928 If the file already exists but is not a regular file, or if the file's owner
20929 and group (if the group is being checked &-- see &%check_group%& above) are
20930 different from the user and group under which the delivery is running,
20931 delivery is deferred.
20932
20933 .next
20934 If the file's permissions are more generous than specified, they are reduced.
20935 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20936 is set false, in which case the delivery is tried using the existing
20937 permissions.
20938
20939 .next
20940 The file's inode number is saved, and the file is then opened for appending.
20941 If this fails because the file has vanished, &(appendfile)& behaves as if it
20942 hadn't existed (see below). For any other failures, delivery is deferred.
20943
20944 .next
20945 If the file is opened successfully, check that the inode number hasn't
20946 changed, that it is still a regular file, and that the owner and permissions
20947 have not changed. If anything is wrong, defer delivery and freeze the message.
20948
20949 .next
20950 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20951 option is set. Otherwise, check that the file is being created in a permitted
20952 directory if the &%create_file%& option is set (deferring on failure), and then
20953 open for writing as a new file, with the O_EXCL and O_CREAT options,
20954 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20955 set). In this case, which can happen if the link points to a non-existent file,
20956 the file is opened for writing using O_CREAT but not O_EXCL, because
20957 that prevents link following.
20958
20959 .next
20960 .cindex "loop" "while file testing"
20961 If opening fails because the file exists, obey the tests given above for
20962 existing files. However, to avoid looping in a situation where the file is
20963 being continuously created and destroyed, the exists/not-exists loop is broken
20964 after 10 repetitions, and the message is then frozen.
20965
20966 .next
20967 If opening fails with any other error, defer delivery.
20968
20969 .next
20970 .cindex "file" "locking"
20971 .cindex "locking files"
20972 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20973 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20974 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20975 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20976 file, and an exclusive lock on the file whose name is
20977 .code
20978 /tmp/.<device-number>.<inode-number>
20979 .endd
20980 using the device and inode numbers of the open mailbox file, in accordance with
20981 the MBX locking rules. This file is created with a mode that is specified by
20982 the &%lockfile_mode%& option.
20983
20984 If Exim fails to lock the file, there are two possible courses of action,
20985 depending on the value of the locking timeout. This is obtained from
20986 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20987
20988 If the timeout value is zero, the file is closed, Exim waits for
20989 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20990 to lock it again. This happens up to &%lock_retries%& times, after which the
20991 delivery is deferred.
20992
20993 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20994 &[flock()]& are used (with the given timeout), so there has already been some
20995 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20996 immediately. It retries up to
20997 .code
20998 (lock_retries * lock_interval) / <timeout>
20999 .endd
21000 times (rounded up).
21001 .endlist
21002
21003 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21004 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21005
21006
21007 .section "Operational details for delivery to a new file" "SECTopdir"
21008 .cindex "delivery" "to single file"
21009 .cindex "&""From""& line"
21010 When the &%directory%& option is set instead of &%file%&, each message is
21011 delivered into a newly-created file or set of files. When &(appendfile)& is
21012 activated directly from a &(redirect)& router, neither &%file%& nor
21013 &%directory%& is normally set, because the path for delivery is supplied by the
21014 router. (See for example, the &(address_file)& transport in the default
21015 configuration.) In this case, delivery is to a new file if either the path name
21016 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21017
21018 No locking is required while writing the message to a new file, so the various
21019 locking options of the transport are ignored. The &"From"& line that by default
21020 separates messages in a single file is not normally needed, nor is the escaping
21021 of message lines that start with &"From"&, and there is no need to ensure a
21022 newline at the end of each message. Consequently, the default values for
21023 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21024 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21025
21026 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21027 the files in the delivery directory by default. However, you can specify a
21028 different directory by setting &%quota_directory%&. Also, for maildir
21029 deliveries (see below) the &_maildirfolder_& convention is honoured.
21030
21031
21032 .cindex "maildir format"
21033 .cindex "mailstore format"
21034 There are three different ways in which delivery to individual files can be
21035 done, controlled by the settings of the &%maildir_format%& and
21036 &%mailstore_format%& options. Note that code to support maildir or mailstore
21037 formats is not included in the binary unless SUPPORT_MAILDIR or
21038 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21039
21040 .cindex "directory creation"
21041 In all three cases an attempt is made to create the directory and any necessary
21042 sub-directories if they do not exist, provided that the &%create_directory%&
21043 option is set (the default). The location of a created directory can be
21044 constrained by setting &%create_file%&. A created directory's mode is given by
21045 the &%directory_mode%& option. If creation fails, or if the
21046 &%create_directory%& option is not set when creation is required, delivery is
21047 deferred.
21048
21049
21050
21051 .section "Maildir delivery" "SECTmaildirdelivery"
21052 .cindex "maildir format" "description of"
21053 If the &%maildir_format%& option is true, Exim delivers each message by writing
21054 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21055 directory that is defined by the &%directory%& option (the &"delivery
21056 directory"&). If the delivery is successful, the file is renamed into the
21057 &_new_& subdirectory.
21058
21059 In the file name, <&'stime'&> is the current time of day in seconds, and
21060 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21061 Exim checks that the time-of-day clock has moved on by at least one microsecond
21062 before terminating the delivery process. This guarantees uniqueness for the
21063 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21064 opening it. If any response other than ENOENT (does not exist) is given,
21065 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21066
21067 Before Exim carries out a maildir delivery, it ensures that subdirectories
21068 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21069 do not exist, Exim tries to create them and any superior directories in their
21070 path, subject to the &%create_directory%& and &%create_file%& options. If the
21071 &%maildirfolder_create_regex%& option is set, and the regular expression it
21072 contains matches the delivery directory, Exim also ensures that a file called
21073 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21074 &_maildirfolder_& file cannot be created, delivery is deferred.
21075
21076 These features make it possible to use Exim to create all the necessary files
21077 and directories in a maildir mailbox, including subdirectories for maildir++
21078 folders. Consider this example:
21079 .code
21080 maildir_format = true
21081 directory = /var/mail/$local_part\
21082            ${if eq{$local_part_suffix}{}{}\
21083            {/.${substr_1:$local_part_suffix}}}
21084 maildirfolder_create_regex = /\.[^/]+$
21085 .endd
21086 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21087 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21088 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21089 not match this name, so Exim will not look for or create the file
21090 &_/var/mail/pimbo/maildirfolder_&, though it will create
21091 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21092
21093 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21094 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21095 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21096 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21097 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21098
21099 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21100 not inadvertently match the toplevel maildir directory, because a
21101 &_maildirfolder_& file at top level would completely break quota calculations.
21102
21103 .cindex "quota" "in maildir delivery"
21104 .cindex "maildir++"
21105 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21106 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21107 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21108 Exim assumes the directory is a maildir++ folder directory, which is one level
21109 down from the user's top level mailbox directory. This causes it to start at
21110 the parent directory instead of the current directory when calculating the
21111 amount of space used.
21112
21113 One problem with delivering into a multi-file mailbox is that it is
21114 computationally expensive to compute the size of the mailbox for quota
21115 checking. Various approaches have been taken to reduce the amount of work
21116 needed. The next two sections describe two of them. A third alternative is to
21117 use some external process for maintaining the size data, and use the expansion
21118 of the &%mailbox_size%& option as a way of importing it into Exim.
21119
21120
21121
21122
21123 .section "Using tags to record message sizes" "SECID135"
21124 If &%maildir_tag%& is set, the string is expanded for each delivery.
21125 When the maildir file is renamed into the &_new_& sub-directory, the
21126 tag is added to its name. However, if adding the tag takes the length of the
21127 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21128 the tag is dropped and the maildir file is created with no tag.
21129
21130
21131 .vindex "&$message_size$&"
21132 Tags can be used to encode the size of files in their names; see
21133 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21134 happens after the message has been written. The value of the &$message_size$&
21135 variable is set to the number of bytes actually written. If the expansion is
21136 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21137 be deferred. The expanded tag may contain any printing characters except &"/"&.
21138 Non-printing characters in the string are ignored; if the resulting string is
21139 empty, it is ignored. If it starts with an alphanumeric character, a leading
21140 colon is inserted; this default has not proven to be the path that popular
21141 maildir implementations have chosen (but changing it in Exim would break
21142 backwards compatibility).
21143
21144 For one common implementation, you might set:
21145 .code
21146 maildir_tag = ,S=${message_size}
21147 .endd
21148 but you should check the documentation of the other software to be sure.
21149
21150 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21151 as this allows Exim to extract the size from your tag, instead of having to
21152 &[stat()]& each message file.
21153
21154
21155 .section "Using a maildirsize file" "SECID136"
21156 .cindex "quota" "in maildir delivery"
21157 .cindex "maildir format" "&_maildirsize_& file"
21158 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21159 storing quota and message size information in a file called &_maildirsize_&
21160 within the toplevel maildir directory. If this file does not exist, Exim
21161 creates it, setting the quota from the &%quota%& option of the transport. If
21162 the maildir directory itself does not exist, it is created before any attempt
21163 to write a &_maildirsize_& file.
21164
21165 The &_maildirsize_& file is used to hold information about the sizes of
21166 messages in the maildir, thus speeding up quota calculations. The quota value
21167 in the file is just a cache; if the quota is changed in the transport, the new
21168 value overrides the cached value when the next message is delivered. The cache
21169 is maintained for the benefit of other programs that access the maildir and
21170 need to know the quota.
21171
21172 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21173 file is maintained (with a zero quota setting), but no quota is imposed.
21174
21175 A regular expression is available for controlling which directories in the
21176 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21177 See the description of the &%maildir_quota_directory_regex%& option above for
21178 details.
21179
21180
21181 .section "Mailstore delivery" "SECID137"
21182 .cindex "mailstore format" "description of"
21183 If the &%mailstore_format%& option is true, each message is written as two
21184 files in the given directory. A unique base name is constructed from the
21185 message id and the current delivery process, and the files that are written use
21186 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21187 contains the message's envelope, and the &_.msg_& file contains the message
21188 itself. The base name is placed in the variable &$mailstore_basename$&.
21189
21190 During delivery, the envelope is first written to a file with the suffix
21191 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21192 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21193 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21194 file before accessing either of them. An alternative approach is to wait for
21195 the absence of a &_.tmp_& file.
21196
21197 The envelope file starts with any text defined by the &%mailstore_prefix%&
21198 option, expanded and terminated by a newline if there isn't one. Then follows
21199 the sender address on one line, then all the recipient addresses, one per line.
21200 There can be more than one recipient only if the &%batch_max%& option is set
21201 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21202 appended to the file, followed by a newline if it does not end with one.
21203
21204 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21205 failure, it is ignored. Other expansion errors are treated as serious
21206 configuration errors, and delivery is deferred. The variable
21207 &$mailstore_basename$& is available for use during these expansions.
21208
21209
21210 .section "Non-special new file delivery" "SECID138"
21211 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21212 file is created directly in the named directory. For example, when delivering
21213 messages into files in batched SMTP format for later delivery to some host (see
21214 section &<<SECTbatchSMTP>>&), a setting such as
21215 .code
21216 directory = /var/bsmtp/$host
21217 .endd
21218 might be used. A message is written to a file with a temporary name, which is
21219 then renamed when the delivery is complete. The final name is obtained by
21220 expanding the contents of the &%directory_file%& option.
21221 .ecindex IIDapptra1
21222 .ecindex IIDapptra2
21223
21224
21225
21226
21227
21228
21229 . ////////////////////////////////////////////////////////////////////////////
21230 . ////////////////////////////////////////////////////////////////////////////
21231
21232 .chapter "The autoreply transport" "CHID8"
21233 .scindex IIDauttra1 "transports" "&(autoreply)&"
21234 .scindex IIDauttra2 "&(autoreply)& transport"
21235 The &(autoreply)& transport is not a true transport in that it does not cause
21236 the message to be transmitted. Instead, it generates a new mail message as an
21237 automatic reply to the incoming message. &'References:'& and
21238 &'Auto-Submitted:'& header lines are included. These are constructed according
21239 to the rules in RFCs 2822 and 3834, respectively.
21240
21241 If the router that passes the message to this transport does not have the
21242 &%unseen%& option set, the original message (for the current recipient) is not
21243 delivered anywhere. However, when the &%unseen%& option is set on the router
21244 that passes the message to this transport, routing of the address continues, so
21245 another router can set up a normal message delivery.
21246
21247
21248 The &(autoreply)& transport is usually run as the result of mail filtering, a
21249 &"vacation"& message being the standard example. However, it can also be run
21250 directly from a router like any other transport. To reduce the possibility of
21251 message cascades, messages created by the &(autoreply)& transport always have
21252 empty envelope sender addresses, like bounce messages.
21253
21254 The parameters of the message to be sent can be specified in the configuration
21255 by options described below. However, these are used only when the address
21256 passed to the transport does not contain its own reply information. When the
21257 transport is run as a consequence of a
21258 &%mail%&
21259 or &%vacation%& command in a filter file, the parameters of the message are
21260 supplied by the filter, and passed with the address. The transport's options
21261 that define the message are then ignored (so they are not usually set in this
21262 case). The message is specified entirely by the filter or by the transport; it
21263 is never built from a mixture of options. However, the &%file_optional%&,
21264 &%mode%&, and &%return_message%& options apply in all cases.
21265
21266 &(Autoreply)& is implemented as a local transport. When used as a result of a
21267 command in a user's filter file, &(autoreply)& normally runs under the uid and
21268 gid of the user, and with appropriate current and home directories (see chapter
21269 &<<CHAPenvironment>>&).
21270
21271 There is a subtle difference between routing a message to a &(pipe)& transport
21272 that generates some text to be returned to the sender, and routing it to an
21273 &(autoreply)& transport. This difference is noticeable only if more than one
21274 address from the same message is so handled. In the case of a pipe, the
21275 separate outputs from the different addresses are gathered up and returned to
21276 the sender in a single message, whereas if &(autoreply)& is used, a separate
21277 message is generated for each address that is passed to it.
21278
21279 Non-printing characters are not permitted in the header lines generated for the
21280 message that &(autoreply)& creates, with the exception of newlines that are
21281 immediately followed by white space. If any non-printing characters are found,
21282 the transport defers.
21283 Whether characters with the top bit set count as printing characters or not is
21284 controlled by the &%print_topbitchars%& global option.
21285
21286 If any of the generic options for manipulating headers (for example,
21287 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21288 of the original message that is included in the generated message when
21289 &%return_message%& is set. They do not apply to the generated message itself.
21290
21291 .vindex "&$sender_address$&"
21292 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21293 the message, indicating that there were no recipients, it does not treat this
21294 as an error. This means that autoreplies sent to &$sender_address$& when this
21295 is empty (because the incoming message is a bounce message) do not cause
21296 problems. They are just discarded.
21297
21298
21299
21300 .section "Private options for autoreply" "SECID139"
21301 .cindex "options" "&(autoreply)& transport"
21302
21303 .option bcc autoreply string&!! unset
21304 This specifies the addresses that are to receive &"blind carbon copies"& of the
21305 message when the message is specified by the transport.
21306
21307
21308 .option cc autoreply string&!! unset
21309 This specifies recipients of the message and the contents of the &'Cc:'& header
21310 when the message is specified by the transport.
21311
21312
21313 .option file autoreply string&!! unset
21314 The contents of the file are sent as the body of the message when the message
21315 is specified by the transport. If both &%file%& and &%text%& are set, the text
21316 string comes first.
21317
21318
21319 .option file_expand autoreply boolean false
21320 If this is set, the contents of the file named by the &%file%& option are
21321 subjected to string expansion as they are added to the message.
21322
21323
21324 .option file_optional autoreply boolean false
21325 If this option is true, no error is generated if the file named by the &%file%&
21326 option or passed with the address does not exist or cannot be read.
21327
21328
21329 .option from autoreply string&!! unset
21330 This specifies the contents of the &'From:'& header when the message is
21331 specified by the transport.
21332
21333
21334 .option headers autoreply string&!! unset
21335 This specifies additional RFC 2822 headers that are to be added to the message
21336 when the message is specified by the transport. Several can be given by using
21337 &"\n"& to separate them. There is no check on the format.
21338
21339
21340 .option log autoreply string&!! unset
21341 This option names a file in which a record of every message sent is logged when
21342 the message is specified by the transport.
21343
21344
21345 .option mode autoreply "octal integer" 0600
21346 If either the log file or the &"once"& file has to be created, this mode is
21347 used.
21348
21349
21350 .option never_mail autoreply "address list&!!" unset
21351 If any run of the transport creates a message with a recipient that matches any
21352 item in the list, that recipient is quietly discarded. If all recipients are
21353 discarded, no message is created. This applies both when the recipients are
21354 generated by a filter and when they are specified in the transport.
21355
21356
21357
21358 .option once autoreply string&!! unset
21359 This option names a file or DBM database in which a record of each &'To:'&
21360 recipient is kept when the message is specified by the transport. &*Note*&:
21361 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21362
21363 If &%once%& is unset, or is set to an empty string, the message is always sent.
21364 By default, if &%once%& is set to a non-empty file name, the message
21365 is not sent if a potential recipient is already listed in the database.
21366 However, if the &%once_repeat%& option specifies a time greater than zero, the
21367 message is sent if that much time has elapsed since a message was last sent to
21368 this recipient. A setting of zero time for &%once_repeat%& (the default)
21369 prevents a message from being sent a second time &-- in this case, zero means
21370 infinity.
21371
21372 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21373 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21374 greater than zero, it changes the way Exim implements the &%once%& option.
21375 Instead of using a DBM file to record every recipient it sends to, it uses a
21376 regular file, whose size will never get larger than the given value.
21377
21378 In the file, Exim keeps a linear list of recipient addresses and the times at
21379 which they were sent messages. If the file is full when a new address needs to
21380 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21381 means that a given recipient may receive multiple messages, but at
21382 unpredictable intervals that depend on the rate of turnover of addresses in the
21383 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21384
21385
21386 .option once_file_size autoreply integer 0
21387 See &%once%& above.
21388
21389
21390 .option once_repeat autoreply time&!! 0s
21391 See &%once%& above.
21392 After expansion, the value of this option must be a valid time value.
21393
21394
21395 .option reply_to autoreply string&!! unset
21396 This specifies the contents of the &'Reply-To:'& header when the message is
21397 specified by the transport.
21398
21399
21400 .option return_message autoreply boolean false
21401 If this is set, a copy of the original message is returned with the new
21402 message, subject to the maximum size set in the &%return_size_limit%& global
21403 configuration option.
21404
21405
21406 .option subject autoreply string&!! unset
21407 This specifies the contents of the &'Subject:'& header when the message is
21408 specified by the transport. It is tempting to quote the original subject in
21409 automatic responses. For example:
21410 .code
21411 subject = Re: $h_subject:
21412 .endd
21413 There is a danger in doing this, however. It may allow a third party to
21414 subscribe your users to an opt-in mailing list, provided that the list accepts
21415 bounce messages as subscription confirmations. Well-managed lists require a
21416 non-bounce message to confirm a subscription, so the danger is relatively
21417 small.
21418
21419
21420
21421 .option text autoreply string&!! unset
21422 This specifies a single string to be used as the body of the message when the
21423 message is specified by the transport. If both &%text%& and &%file%& are set,
21424 the text comes first.
21425
21426
21427 .option to autoreply string&!! unset
21428 This specifies recipients of the message and the contents of the &'To:'& header
21429 when the message is specified by the transport.
21430 .ecindex IIDauttra1
21431 .ecindex IIDauttra2
21432
21433
21434
21435
21436 . ////////////////////////////////////////////////////////////////////////////
21437 . ////////////////////////////////////////////////////////////////////////////
21438
21439 .chapter "The lmtp transport" "CHAPLMTP"
21440 .cindex "transports" "&(lmtp)&"
21441 .cindex "&(lmtp)& transport"
21442 .cindex "LMTP" "over a pipe"
21443 .cindex "LMTP" "over a socket"
21444 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21445 specified command
21446 or by interacting with a Unix domain socket.
21447 This transport is something of a cross between the &(pipe)& and &(smtp)&
21448 transports. Exim also has support for using LMTP over TCP/IP; this is
21449 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21450 to be of minority interest, the default build-time configure in &_src/EDITME_&
21451 has it commented out. You need to ensure that
21452 .code
21453 TRANSPORT_LMTP=yes
21454 .endd
21455 .cindex "options" "&(lmtp)& transport"
21456 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21457 included in the Exim binary. The private options of the &(lmtp)& transport are
21458 as follows:
21459
21460 .option batch_id lmtp string&!! unset
21461 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21462
21463
21464 .option batch_max lmtp integer 1
21465 This limits the number of addresses that can be handled in a single delivery.
21466 Most LMTP servers can handle several addresses at once, so it is normally a
21467 good idea to increase this value. See the description of local delivery
21468 batching in chapter &<<CHAPbatching>>&.
21469
21470
21471 .option command lmtp string&!! unset
21472 This option must be set if &%socket%& is not set. The string is a command which
21473 is run in a separate process. It is split up into a command name and list of
21474 arguments, each of which is separately expanded (so expansion cannot change the
21475 number of arguments). The command is run directly, not via a shell. The message
21476 is passed to the new process using the standard input and output to operate the
21477 LMTP protocol.
21478
21479 .option ignore_quota lmtp boolean false
21480 .cindex "LMTP" "ignoring quota errors"
21481 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21482 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21483 in its response to the LHLO command.
21484
21485 .option socket lmtp string&!! unset
21486 This option must be set if &%command%& is not set. The result of expansion must
21487 be the name of a Unix domain socket. The transport connects to the socket and
21488 delivers the message to it using the LMTP protocol.
21489
21490
21491 .option timeout lmtp time 5m
21492 The transport is aborted if the created process or Unix domain socket does not
21493 respond to LMTP commands or message input within this timeout. Delivery
21494 is deferred, and will be tried again later. Here is an example of a typical
21495 LMTP transport:
21496 .code
21497 lmtp:
21498   driver = lmtp
21499   command = /some/local/lmtp/delivery/program
21500   batch_max = 20
21501   user = exim
21502 .endd
21503 This delivers up to 20 addresses at a time, in a mixture of domains if
21504 necessary, running as the user &'exim'&.
21505
21506
21507
21508 . ////////////////////////////////////////////////////////////////////////////
21509 . ////////////////////////////////////////////////////////////////////////////
21510
21511 .chapter "The pipe transport" "CHAPpipetransport"
21512 .scindex IIDpiptra1 "transports" "&(pipe)&"
21513 .scindex IIDpiptra2 "&(pipe)& transport"
21514 The &(pipe)& transport is used to deliver messages via a pipe to a command
21515 running in another process. One example is the use of &(pipe)& as a
21516 pseudo-remote transport for passing messages to some other delivery mechanism
21517 (such as UUCP). Another is the use by individual users to automatically process
21518 their incoming messages. The &(pipe)& transport can be used in one of the
21519 following ways:
21520
21521 .ilist
21522 .vindex "&$local_part$&"
21523 A router routes one address to a transport in the normal way, and the
21524 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21525 contains the local part of the address (as usual), and the command that is run
21526 is specified by the &%command%& option on the transport.
21527 .next
21528 .vindex "&$pipe_addresses$&"
21529 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21530 transport can handle more than one address in a single run. In this case, when
21531 more than one address is routed to the transport, &$local_part$& is not set
21532 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21533 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21534 that are routed to the transport.
21535 .next
21536 .vindex "&$address_pipe$&"
21537 A router redirects an address directly to a pipe command (for example, from an
21538 alias or forward file). In this case, &$address_pipe$& contains the text of the
21539 pipe command, and the &%command%& option on the transport is ignored. If only
21540 one address is being transported (&%batch_max%& is not greater than one, or
21541 only one address was redirected to this pipe command), &$local_part$& contains
21542 the local part that was redirected.
21543 .endlist
21544
21545
21546 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21547 deliver messages over pipes using the LMTP interactive protocol. This is
21548 implemented by the &(lmtp)& transport.
21549
21550 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21551 &_.forward_& file, the command runs under the uid and gid of that user. In
21552 other cases, the uid and gid have to be specified explicitly, either on the
21553 transport or on the router that handles the address. Current and &"home"&
21554 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21555 details of the local delivery environment and chapter &<<CHAPbatching>>&
21556 for a discussion of local delivery batching.
21557
21558
21559 .section "Concurrent delivery" "SECID140"
21560 If two messages arrive at almost the same time, and both are routed to a pipe
21561 delivery, the two pipe transports may be run concurrently. You must ensure that
21562 any pipe commands you set up are robust against this happening. If the commands
21563 write to a file, the &%exim_lock%& utility might be of use.
21564
21565
21566
21567
21568 .section "Returned status and data" "SECID141"
21569 .cindex "&(pipe)& transport" "returned data"
21570 If the command exits with a non-zero return code, the delivery is deemed to
21571 have failed, unless either the &%ignore_status%& option is set (in which case
21572 the return code is treated as zero), or the return code is one of those listed
21573 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21574 later"&. In this case, delivery is deferred. Details of a permanent failure are
21575 logged, but are not included in the bounce message, which merely contains
21576 &"local delivery failed"&.
21577
21578 If the command exits on a signal and the &%freeze_signal%& option is set then
21579 the message will be frozen in the queue. If that option is not set, a bounce
21580 will be sent as normal.
21581
21582 If the return code is greater than 128 and the command being run is a shell
21583 script, it normally means that the script was terminated by a signal whose
21584 value is the return code minus 128. The &%freeze_signal%& option does not
21585 apply in this case.
21586
21587 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21588 return code is set to 127. This is the value that a shell returns if it is
21589 asked to run a non-existent command. The wording for the log line suggests that
21590 a non-existent command may be the problem.
21591
21592 The &%return_output%& option can affect the result of a pipe delivery. If it is
21593 set and the command produces any output on its standard output or standard
21594 error streams, the command is considered to have failed, even if it gave a zero
21595 return code or if &%ignore_status%& is set. The output from the command is
21596 included as part of the bounce message. The &%return_fail_output%& option is
21597 similar, except that output is returned only when the command exits with a
21598 failure return code, that is, a value other than zero or a code that matches
21599 &%temp_errors%&.
21600
21601
21602
21603 .section "How the command is run" "SECThowcommandrun"
21604 .cindex "&(pipe)& transport" "path for command"
21605 The command line is (by default) broken down into a command name and arguments
21606 by the &(pipe)& transport itself. The &%allow_commands%& and
21607 &%restrict_to_path%& options can be used to restrict the commands that may be
21608 run.
21609
21610 .cindex "quoting" "in pipe command"
21611 Unquoted arguments are delimited by white space. If an argument appears in
21612 double quotes, backslash is interpreted as an escape character in the usual
21613 way. If an argument appears in single quotes, no escaping is done.
21614
21615 String expansion is applied to the command line except when it comes from a
21616 traditional &_.forward_& file (commands from a filter file are expanded). The
21617 expansion is applied to each argument in turn rather than to the whole line.
21618 For this reason, any string expansion item that contains white space must be
21619 quoted so as to be contained within a single argument. A setting such as
21620 .code
21621 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21622 .endd
21623 will not work, because the expansion item gets split between several
21624 arguments. You have to write
21625 .code
21626 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21627 .endd
21628 to ensure that it is all in one argument. The expansion is done in this way,
21629 argument by argument, so that the number of arguments cannot be changed as a
21630 result of expansion, and quotes or backslashes in inserted variables do not
21631 interact with external quoting. However, this leads to problems if you want to
21632 generate multiple arguments (or the command name plus arguments) from a single
21633 expansion. In this situation, the simplest solution is to use a shell. For
21634 example:
21635 .code
21636 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21637 .endd
21638
21639 .cindex "transport" "filter"
21640 .cindex "filter" "transport filter"
21641 .vindex "&$pipe_addresses$&"
21642 Special handling takes place when an argument consists of precisely the text
21643 &`$pipe_addresses`&. This is not a general expansion variable; the only
21644 place this string is recognized is when it appears as an argument for a pipe or
21645 transport filter command. It causes each address that is being handled to be
21646 inserted in the argument list at that point &'as a separate argument'&. This
21647 avoids any problems with spaces or shell metacharacters, and is of use when a
21648 &(pipe)& transport is handling groups of addresses in a batch.
21649
21650 After splitting up into arguments and expansion, the resulting command is run
21651 in a subprocess directly from the transport, &'not'& under a shell. The
21652 message that is being delivered is supplied on the standard input, and the
21653 standard output and standard error are both connected to a single pipe that is
21654 read by Exim. The &%max_output%& option controls how much output the command
21655 may produce, and the &%return_output%& and &%return_fail_output%& options
21656 control what is done with it.
21657
21658 Not running the command under a shell (by default) lessens the security risks
21659 in cases when a command from a user's filter file is built out of data that was
21660 taken from an incoming message. If a shell is required, it can of course be
21661 explicitly specified as the command to be run. However, there are circumstances
21662 where existing commands (for example, in &_.forward_& files) expect to be run
21663 under a shell and cannot easily be modified. To allow for these cases, there is
21664 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21665 works. Instead of breaking up the command line as just described, it expands it
21666 as a single string and passes the result to &_/bin/sh_&. The
21667 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21668 with &%use_shell%&, and the whole mechanism is inherently less secure.
21669
21670
21671
21672 .section "Environment variables" "SECTpipeenv"
21673 .cindex "&(pipe)& transport" "environment for command"
21674 .cindex "environment for pipe transport"
21675 The environment variables listed below are set up when the command is invoked.
21676 This list is a compromise for maximum compatibility with other MTAs. Note that
21677 the &%environment%& option can be used to add additional variables to this
21678 environment.
21679 .display
21680 &`DOMAIN            `&   the domain of the address
21681 &`HOME              `&   the home directory, if set
21682 &`HOST              `&   the host name when called from a router (see below)
21683 &`LOCAL_PART        `&   see below
21684 &`LOCAL_PART_PREFIX `&   see below
21685 &`LOCAL_PART_SUFFIX `&   see below
21686 &`LOGNAME           `&   see below
21687 &`MESSAGE_ID        `&   Exim's local ID for the message
21688 &`PATH              `&   as specified by the &%path%& option below
21689 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21690 &`RECIPIENT         `&   the complete recipient address
21691 &`SENDER            `&   the sender of the message (empty if a bounce)
21692 &`SHELL             `&   &`/bin/sh`&
21693 &`TZ                `&   the value of the &%timezone%& option, if set
21694 &`USER              `&   see below
21695 .endd
21696 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21697 router, LOCAL_PART is set to the local part of the address. When it is
21698 called as a result of a forward or alias expansion, LOCAL_PART is set to
21699 the local part of the address that was expanded. In both cases, any affixes are
21700 removed from the local part, and made available in LOCAL_PART_PREFIX and
21701 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21702 same value as LOCAL_PART for compatibility with other MTAs.
21703
21704 .cindex "HOST"
21705 HOST is set only when a &(pipe)& transport is called from a router that
21706 associates hosts with an address, typically when using &(pipe)& as a
21707 pseudo-remote transport. HOST is set to the first host name specified by
21708 the router.
21709
21710 .cindex "HOME"
21711 If the transport's generic &%home_directory%& option is set, its value is used
21712 for the HOME environment variable. Otherwise, a home directory may be set
21713 by the router's &%transport_home_directory%& option, which defaults to the
21714 user's home directory if &%check_local_user%& is set.
21715
21716
21717 .section "Private options for pipe" "SECID142"
21718 .cindex "options" "&(pipe)& transport"
21719
21720
21721
21722 .option allow_commands pipe "string list&!!" unset
21723 .cindex "&(pipe)& transport" "permitted commands"
21724 The string is expanded, and is then interpreted as a colon-separated list of
21725 permitted commands. If &%restrict_to_path%& is not set, the only commands
21726 permitted are those in the &%allow_commands%& list. They need not be absolute
21727 paths; the &%path%& option is still used for relative paths. If
21728 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21729 in the &%allow_commands%& list, or a name without any slashes that is found on
21730 the path. In other words, if neither &%allow_commands%& nor
21731 &%restrict_to_path%& is set, there is no restriction on the command, but
21732 otherwise only commands that are permitted by one or the other are allowed. For
21733 example, if
21734 .code
21735 allow_commands = /usr/bin/vacation
21736 .endd
21737 and &%restrict_to_path%& is not set, the only permitted command is
21738 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21739 &%use_shell%& is set.
21740
21741
21742 .option batch_id pipe string&!! unset
21743 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21744
21745
21746 .option batch_max pipe integer 1
21747 This limits the number of addresses that can be handled in a single delivery.
21748 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21749
21750
21751 .option check_string pipe string unset
21752 As &(pipe)& writes the message, the start of each line is tested for matching
21753 &%check_string%&, and if it does, the initial matching characters are replaced
21754 by the contents of &%escape_string%&, provided both are set. The value of
21755 &%check_string%& is a literal string, not a regular expression, and the case of
21756 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21757 of &%check_string%& and &%escape_string%& are forced to values that implement
21758 the SMTP escaping protocol. Any settings made in the configuration file are
21759 ignored.
21760
21761
21762 .option command pipe string&!! unset
21763 This option need not be set when &(pipe)& is being used to deliver to pipes
21764 obtained directly from address redirections. In other cases, the option must be
21765 set, to provide a command to be run. It need not yield an absolute path (see
21766 the &%path%& option below). The command is split up into separate arguments by
21767 Exim, and each argument is separately expanded, as described in section
21768 &<<SECThowcommandrun>>& above.
21769
21770
21771 .option environment pipe string&!! unset
21772 .cindex "&(pipe)& transport" "environment for command"
21773 .cindex "environment for &(pipe)& transport"
21774 This option is used to add additional variables to the environment in which the
21775 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21776 a string which is expanded, and then interpreted as a colon-separated list of
21777 environment settings of the form <&'name'&>=<&'value'&>.
21778
21779
21780 .option escape_string pipe string unset
21781 See &%check_string%& above.
21782
21783
21784 .option freeze_exec_fail pipe boolean false
21785 .cindex "exec failure"
21786 .cindex "failure of exec"
21787 .cindex "&(pipe)& transport" "failure of exec"
21788 Failure to exec the command in a pipe transport is by default treated like
21789 any other failure while running the command. However, if &%freeze_exec_fail%&
21790 is set, failure to exec is treated specially, and causes the message to be
21791 frozen, whatever the setting of &%ignore_status%&.
21792
21793
21794 .option freeze_signal pipe boolean false
21795 .cindex "signal exit"
21796 .cindex "&(pipe)& transport", "signal exit"
21797 Normally if the process run by a command in a pipe transport exits on a signal,
21798 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21799 frozen in Exim's queue instead.
21800
21801
21802 .option ignore_status pipe boolean false
21803 If this option is true, the status returned by the subprocess that is set up to
21804 run the command is ignored, and Exim behaves as if zero had been returned.
21805 Otherwise, a non-zero status or termination by signal causes an error return
21806 from the transport unless the status value is one of those listed in
21807 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21808
21809 &*Note*&: This option does not apply to timeouts, which do not return a status.
21810 See the &%timeout_defer%& option for how timeouts are handled.
21811
21812 .option log_defer_output pipe boolean false
21813 .cindex "&(pipe)& transport" "logging output"
21814 If this option is set, and the status returned by the command is
21815 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21816 and any output was produced, the first line of it is written to the main log.
21817
21818
21819 .option log_fail_output pipe boolean false
21820 If this option is set, and the command returns any output, and also ends with a
21821 return code that is neither zero nor one of the return codes listed in
21822 &%temp_errors%& (that is, the delivery failed), the first line of output is
21823 written to the main log. This option and &%log_output%& are mutually exclusive.
21824 Only one of them may be set.
21825
21826
21827
21828 .option log_output pipe boolean false
21829 If this option is set and the command returns any output, the first line of
21830 output is written to the main log, whatever the return code. This option and
21831 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21832
21833
21834
21835 .option max_output pipe integer 20K
21836 This specifies the maximum amount of output that the command may produce on its
21837 standard output and standard error file combined. If the limit is exceeded, the
21838 process running the command is killed. This is intended as a safety measure to
21839 catch runaway processes. The limit is applied independently of the settings of
21840 the options that control what is done with such output (for example,
21841 &%return_output%&). Because of buffering effects, the amount of output may
21842 exceed the limit by a small amount before Exim notices.
21843
21844
21845 .option message_prefix pipe string&!! "see below"
21846 The string specified here is expanded and output at the start of every message.
21847 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21848 .code
21849 message_prefix = \
21850   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21851   ${tod_bsdinbox}\n
21852 .endd
21853 .cindex "Cyrus"
21854 .cindex "&%tmail%&"
21855 .cindex "&""From""& line"
21856 This is required by the commonly used &_/usr/bin/vacation_& program.
21857 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21858 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21859 setting
21860 .code
21861 message_prefix =
21862 .endd
21863 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21864 &`\n`& to &`\r\n`& in &%message_prefix%&.
21865
21866
21867 .option message_suffix pipe string&!! "see below"
21868 The string specified here is expanded and output at the end of every message.
21869 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21870 The suffix can be suppressed by setting
21871 .code
21872 message_suffix =
21873 .endd
21874 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21875 &`\n`& to &`\r\n`& in &%message_suffix%&.
21876
21877
21878 .option path pipe string "see below"
21879 This option specifies the string that is set up in the PATH environment
21880 variable of the subprocess. The default is:
21881 .code
21882 /bin:/usr/bin
21883 .endd
21884 If the &%command%& option does not yield an absolute path name, the command is
21885 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21886 apply to a command specified as a transport filter.
21887
21888
21889 .option permit_coredump pipe boolean false
21890 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21891 a core-dump of a pipe command, enable this command.  This enables core-dumps
21892 during delivery and affects both the Exim binary and the pipe command run.
21893 It is recommended that this option remain off unless and until you have a need
21894 for it and that this only be enabled when needed, as the risk of excessive
21895 resource consumption can be quite high.  Note also that Exim is typically
21896 installed as a setuid binary and most operating systems will inhibit coredumps
21897 of these by default, so further OS-specific action may be required.
21898
21899
21900 .option pipe_as_creator pipe boolean false
21901 .cindex "uid (user id)" "local delivery"
21902 If the generic &%user%& option is not set and this option is true, the delivery
21903 process is run under the uid that was in force when Exim was originally called
21904 to accept the message. If the group id is not otherwise set (via the generic
21905 &%group%& option), the gid that was in force when Exim was originally called to
21906 accept the message is used.
21907
21908
21909 .option restrict_to_path pipe boolean false
21910 When this option is set, any command name not listed in &%allow_commands%& must
21911 contain no slashes. The command is searched for only in the directories listed
21912 in the &%path%& option. This option is intended for use in the case when a pipe
21913 command has been generated from a user's &_.forward_& file. This is usually
21914 handled by a &(pipe)& transport called &%address_pipe%&.
21915
21916
21917 .option return_fail_output pipe boolean false
21918 If this option is true, and the command produced any output and ended with a
21919 return code other than zero or one of the codes listed in &%temp_errors%& (that
21920 is, the delivery failed), the output is returned in the bounce message.
21921 However, if the message has a null sender (that is, it is itself a bounce
21922 message), output from the command is discarded. This option and
21923 &%return_output%& are mutually exclusive. Only one of them may be set.
21924
21925
21926
21927 .option return_output pipe boolean false
21928 If this option is true, and the command produced any output, the delivery is
21929 deemed to have failed whatever the return code from the command, and the output
21930 is returned in the bounce message. Otherwise, the output is just discarded.
21931 However, if the message has a null sender (that is, it is a bounce message),
21932 output from the command is always discarded, whatever the setting of this
21933 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21934 of them may be set.
21935
21936
21937
21938 .option temp_errors pipe "string list" "see below"
21939 .cindex "&(pipe)& transport" "temporary failure"
21940 This option contains either a colon-separated list of numbers, or a single
21941 asterisk. If &%ignore_status%& is false
21942 and &%return_output%& is not set,
21943 and the command exits with a non-zero return code, the failure is treated as
21944 temporary and the delivery is deferred if the return code matches one of the
21945 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21946 codes are treated as permanent errors. The default setting contains the codes
21947 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21948 compiled on a system that does not define these macros, it assumes values of 75
21949 and 73, respectively.
21950
21951
21952 .option timeout pipe time 1h
21953 If the command fails to complete within this time, it is killed. This normally
21954 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21955 specifies no timeout. In order to ensure that any subprocesses created by the
21956 command are also killed, Exim makes the initial process a process group leader,
21957 and kills the whole process group on a timeout. However, this can be defeated
21958 if one of the processes starts a new process group.
21959
21960 .option timeout_defer pipe boolean false
21961 A timeout in a &(pipe)& transport, either in the command that the transport
21962 runs, or in a transport filter that is associated with it, is by default
21963 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21964 is set true, both kinds of timeout become temporary errors, causing the
21965 delivery to be deferred.
21966
21967 .option umask pipe "octal integer" 022
21968 This specifies the umask setting for the subprocess that runs the command.
21969
21970
21971 .option use_bsmtp pipe boolean false
21972 .cindex "envelope sender"
21973 If this option is set true, the &(pipe)& transport writes messages in &"batch
21974 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21975 commands. If you want to include a leading HELO command with such messages,
21976 you can do so by setting the &%message_prefix%& option. See section
21977 &<<SECTbatchSMTP>>& for details of batch SMTP.
21978
21979 .option use_classresources pipe boolean false
21980 .cindex "class resources (BSD)"
21981 This option is available only when Exim is running on FreeBSD, NetBSD, or
21982 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21983 resource limits when a &(pipe)& transport is run to perform a delivery. The
21984 limits for the uid under which the pipe is to run are obtained from the login
21985 class database.
21986
21987
21988 .option use_crlf pipe boolean false
21989 .cindex "carriage return"
21990 .cindex "linefeed"
21991 This option causes lines to be terminated with the two-character CRLF sequence
21992 (carriage return, linefeed) instead of just a linefeed character. In the case
21993 of batched SMTP, the byte sequence written to the pipe is then an exact image
21994 of what would be sent down a real SMTP connection.
21995
21996 The contents of the &%message_prefix%& and &%message_suffix%& options are
21997 written verbatim, so must contain their own carriage return characters if these
21998 are needed. When &%use_bsmtp%& is not set, the default values for both
21999 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22000 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22001
22002
22003 .option use_shell pipe boolean false
22004 .vindex "&$pipe_addresses$&"
22005 If this option is set, it causes the command to be passed to &_/bin/sh_&
22006 instead of being run directly from the transport, as described in section
22007 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22008 where the command is expected to be run under a shell and cannot easily be
22009 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22010 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22011 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22012 its &%-c%& option.
22013
22014
22015
22016 .section "Using an external local delivery agent" "SECID143"
22017 .cindex "local delivery" "using an external agent"
22018 .cindex "&'procmail'&"
22019 .cindex "external local delivery"
22020 .cindex "delivery" "&'procmail'&"
22021 .cindex "delivery" "by external agent"
22022 The &(pipe)& transport can be used to pass all messages that require local
22023 delivery to a separate local delivery agent such as &%procmail%&. When doing
22024 this, care must be taken to ensure that the pipe is run under an appropriate
22025 uid and gid. In some configurations one wants this to be a uid that is trusted
22026 by the delivery agent to supply the correct sender of the message. It may be
22027 necessary to recompile or reconfigure the delivery agent so that it trusts an
22028 appropriate user. The following is an example transport and router
22029 configuration for &%procmail%&:
22030 .code
22031 # transport
22032 procmail_pipe:
22033   driver = pipe
22034   command = /usr/local/bin/procmail -d $local_part
22035   return_path_add
22036   delivery_date_add
22037   envelope_to_add
22038   check_string = "From "
22039   escape_string = ">From "
22040   umask = 077
22041   user = $local_part
22042   group = mail
22043
22044 # router
22045 procmail:
22046   driver = accept
22047   check_local_user
22048   transport = procmail_pipe
22049 .endd
22050 In this example, the pipe is run as the local user, but with the group set to
22051 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22052 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22053 user to supply a correct sender address. If you do not specify either a
22054 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22055 home directory is the user's home directory by default.
22056
22057 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22058 .code
22059 IFS=" "
22060 .endd
22061 as shown in some &%procmail%& documentation, because Exim does not by default
22062 use a shell to run pipe commands.
22063
22064 .cindex "Cyrus"
22065 The next example shows a transport and a router for a system where local
22066 deliveries are handled by the Cyrus IMAP server.
22067 .code
22068 # transport
22069 local_delivery_cyrus:
22070   driver = pipe
22071   command = /usr/cyrus/bin/deliver \
22072             -m ${substr_1:$local_part_suffix} -- $local_part
22073   user = cyrus
22074   group = mail
22075   return_output
22076   log_output
22077   message_prefix =
22078   message_suffix =
22079
22080 # router
22081 local_user_cyrus:
22082   driver = accept
22083   check_local_user
22084   local_part_suffix = .*
22085   transport = local_delivery_cyrus
22086 .endd
22087 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22088 &%return_output%& to cause any text written by Cyrus to be returned to the
22089 sender.
22090 .ecindex IIDpiptra1
22091 .ecindex IIDpiptra2
22092
22093
22094 . ////////////////////////////////////////////////////////////////////////////
22095 . ////////////////////////////////////////////////////////////////////////////
22096
22097 .chapter "The smtp transport" "CHAPsmtptrans"
22098 .scindex IIDsmttra1 "transports" "&(smtp)&"
22099 .scindex IIDsmttra2 "&(smtp)& transport"
22100 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22101 or LMTP protocol. The list of hosts to try can either be taken from the address
22102 that is being processed (having been set up by the router), or specified
22103 explicitly for the transport. Timeout and retry processing (see chapter
22104 &<<CHAPretry>>&) is applied to each IP address independently.
22105
22106
22107 .section "Multiple messages on a single connection" "SECID144"
22108 The sending of multiple messages over a single TCP/IP connection can arise in
22109 two ways:
22110
22111 .ilist
22112 If a message contains more than &%max_rcpt%& (see below) addresses that are
22113 routed to the same host, more than one copy of the message has to be sent to
22114 that host. In this situation, multiple copies may be sent in a single run of
22115 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22116 does when it has too many addresses to send in one message also depends on the
22117 value of the global &%remote_max_parallel%& option. Details are given in
22118 section &<<SECToutSMTPTCP>>&.)
22119 .next
22120 .cindex "hints database" "remembering routing"
22121 When a message has been successfully delivered over a TCP/IP connection, Exim
22122 looks in its hints database to see if there are any other messages awaiting a
22123 connection to the same host. If there are, a new delivery process is started
22124 for one of them, and the current TCP/IP connection is passed on to it. The new
22125 process may in turn send multiple copies and possibly create yet another
22126 process.
22127 .endlist
22128
22129
22130 For each copy sent over the same TCP/IP connection, a sequence counter is
22131 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22132 no further messages are sent over that connection.
22133
22134
22135
22136 .section "Use of the $host and $host_address variables" "SECID145"
22137 .vindex "&$host$&"
22138 .vindex "&$host_address$&"
22139 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22140 &$host_address$& are the name and IP address of the first host on the host list
22141 passed by the router. However, when the transport is about to connect to a
22142 specific host, and while it is connected to that host, &$host$& and
22143 &$host_address$& are set to the values for that host. These are the values
22144 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22145 &%serialize_hosts%&, and the various TLS options are expanded.
22146
22147
22148 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22149 .vindex &$tls_bits$&
22150 .vindex &$tls_cipher$&
22151 .vindex &$tls_peerdn$&
22152 .vindex &$tls_sni$&
22153 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22154 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22155 are the values that were set when the message was received.
22156 These are the values that are used for options that are expanded before any
22157 SMTP connections are made. Just before each connection is made, these four
22158 variables are emptied. If TLS is subsequently started, they are set to the
22159 appropriate values for the outgoing connection, and these are the values that
22160 are in force when any authenticators are run and when the
22161 &%authenticated_sender%& option is expanded.
22162
22163 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22164 and will be removed in a future release.
22165
22166
22167 .section "Private options for smtp" "SECID146"
22168 .cindex "options" "&(smtp)& transport"
22169 The private options of the &(smtp)& transport are as follows:
22170
22171
22172 .option address_retry_include_sender smtp boolean true
22173 .cindex "4&'xx'& responses" "retrying after"
22174 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22175 is the combination of sender and recipient that is delayed in subsequent queue
22176 runs until the retry time is reached. You can delay the recipient without
22177 reference to the sender (which is what earlier versions of Exim did), by
22178 setting &%address_retry_include_sender%& false. However, this can lead to
22179 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22180
22181 .option allow_localhost smtp boolean false
22182 .cindex "local host" "sending to"
22183 .cindex "fallback" "hosts specified on transport"
22184 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22185 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22186 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22187 the delivery anyway. This should be used only in special cases when the
22188 configuration ensures that no looping will result (for example, a differently
22189 configured Exim is listening on the port to which the message is sent).
22190
22191
22192 .option authenticated_sender smtp string&!! unset
22193 .cindex "Cyrus"
22194 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22195 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22196 overriding any existing authenticated sender value. If the string expansion is
22197 forced to fail, the option is ignored. Other expansion failures cause delivery
22198 to be deferred. If the result of expansion is an empty string, that is also
22199 ignored.
22200
22201 The expansion happens after the outgoing connection has been made and TLS
22202 started, if required. This means that the &$host$&, &$host_address$&,
22203 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22204 particular connection.
22205
22206 If the SMTP session is not authenticated, the expansion of
22207 &%authenticated_sender%& still happens (and can cause the delivery to be
22208 deferred if it fails), but no AUTH= item is added to MAIL commands
22209 unless &%authenticated_sender_force%& is true.
22210
22211 This option allows you to use the &(smtp)& transport in LMTP mode to
22212 deliver mail to Cyrus IMAP and provide the proper local part as the
22213 &"authenticated sender"&, via a setting such as:
22214 .code
22215 authenticated_sender = $local_part
22216 .endd
22217 This removes the need for IMAP subfolders to be assigned special ACLs to
22218 allow direct delivery to those subfolders.
22219
22220 Because of expected uses such as that just described for Cyrus (when no
22221 domain is involved), there is no checking on the syntax of the provided
22222 value.
22223
22224
22225 .option authenticated_sender_force smtp boolean false
22226 If this option is set true, the &%authenticated_sender%& option's value
22227 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22228 authenticated as a client.
22229
22230
22231 .option command_timeout smtp time 5m
22232 This sets a timeout for receiving a response to an SMTP command that has been
22233 sent out. It is also used when waiting for the initial banner line from the
22234 remote host. Its value must not be zero.
22235
22236
22237 .option connect_timeout smtp time 5m
22238 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22239 to a remote host. A setting of zero allows the system timeout (typically
22240 several minutes) to act. To have any effect, the value of this option must be
22241 less than the system timeout. However, it has been observed that on some
22242 systems there is no system timeout, which is why the default value for this
22243 option is 5 minutes, a value recommended by RFC 1123.
22244
22245
22246 .option connection_max_messages smtp integer 500
22247 .cindex "SMTP" "passed connection"
22248 .cindex "SMTP" "multiple deliveries"
22249 .cindex "multiple SMTP deliveries"
22250 This controls the maximum number of separate message deliveries that are sent
22251 over a single TCP/IP connection. If the value is zero, there is no limit.
22252 For testing purposes, this value can be overridden by the &%-oB%& command line
22253 option.
22254
22255
22256 .option data_timeout smtp time 5m
22257 This sets a timeout for the transmission of each block in the data portion of
22258 the message. As a result, the overall timeout for a message depends on the size
22259 of the message. Its value must not be zero. See also &%final_timeout%&.
22260
22261
22262 .option delay_after_cutoff smtp boolean true
22263 This option controls what happens when all remote IP addresses for a given
22264 domain have been inaccessible for so long that they have passed their retry
22265 cutoff times.
22266
22267 In the default state, if the next retry time has not been reached for any of
22268 them, the address is bounced without trying any deliveries. In other words,
22269 Exim delays retrying an IP address after the final cutoff time until a new
22270 retry time is reached, and can therefore bounce an address without ever trying
22271 a delivery, when machines have been down for a long time. Some people are
22272 unhappy at this prospect, so...
22273
22274 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22275 addresses are past their final cutoff time, Exim tries to deliver to those
22276 IP addresses that have not been tried since the message arrived. If there are
22277 none, of if they all fail, the address is bounced. In other words, it does not
22278 delay when a new message arrives, but immediately tries those expired IP
22279 addresses that haven't been tried since the message arrived. If there is a
22280 continuous stream of messages for the dead hosts, unsetting
22281 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22282 to them.
22283
22284
22285 .option dns_qualify_single smtp boolean true
22286 If the &%hosts%& or &%fallback_hosts%& option is being used,
22287 and the &%gethostbyname%& option is false,
22288 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22289 in chapter &<<CHAPdnslookup>>& for more details.
22290
22291
22292 .option dns_search_parents smtp boolean false
22293 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22294 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22295 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22296 details.
22297
22298
22299 .new
22300 .option dscp smtp string&!! unset
22301 .cindex "DCSP" "outbound"
22302 This option causes the DSCP value associated with a socket to be set to one
22303 of a number of fixed strings or to numeric value.
22304 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22305 Common values include &`throughput`&, &`mincost`&, and on newer systems
22306 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22307
22308 The outbound packets from Exim will be marked with this value in the header
22309 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22310 that these values will have any effect, not be stripped by networking
22311 equipment, or do much of anything without cooperation with your Network
22312 Engineer and those of all network operators between the source and destination.
22313 .wen
22314
22315
22316 .option fallback_hosts smtp "string list" unset
22317 .cindex "fallback" "hosts specified on transport"
22318 String expansion is not applied to this option. The argument must be a
22319 colon-separated list of host names or IP addresses, optionally also including
22320 port numbers, though the separator can be changed, as described in section
22321 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22322 item in a &%route_list%& setting for the &(manualroute)& router, as described
22323 in section &<<SECTformatonehostitem>>&.
22324
22325 Fallback hosts can also be specified on routers, which associate them with the
22326 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22327 &%fallback_hosts%& specified on the transport is used only if the address does
22328 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22329 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22330 However, &%hosts_randomize%& does apply to fallback host lists.
22331
22332 If Exim is unable to deliver to any of the hosts for a particular address, and
22333 the errors are not permanent rejections, the address is put on a separate
22334 transport queue with its host list replaced by the fallback hosts, unless the
22335 address was routed via MX records and the current host was in the original MX
22336 list. In that situation, the fallback host list is not used.
22337
22338 Once normal deliveries are complete, the fallback queue is delivered by
22339 re-running the same transports with the new host lists. If several failing
22340 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22341 copy of the message is sent.
22342
22343 The resolution of the host names on the fallback list is controlled by the
22344 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22345 both to cases when the host list comes with the address and when it is taken
22346 from &%hosts%&. This option provides a &"use a smart host only if delivery
22347 fails"& facility.
22348
22349
22350 .option final_timeout smtp time 10m
22351 This is the timeout that applies while waiting for the response to the final
22352 line containing just &"."& that terminates a message. Its value must not be
22353 zero.
22354
22355 .option gethostbyname smtp boolean false
22356 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22357 being used, names are looked up using &[gethostbyname()]&
22358 (or &[getipnodebyname()]& when available)
22359 instead of using the DNS. Of course, that function may in fact use the DNS, but
22360 it may also consult other sources of information such as &_/etc/hosts_&.
22361
22362 .option gnutls_compat_mode smtp boolean unset
22363 This option controls whether GnuTLS is used in compatibility mode in an Exim
22364 server. This reduces security slightly, but improves interworking with older
22365 implementations of TLS.
22366
22367 .option helo_data smtp string&!! "see below"
22368 .cindex "HELO" "argument, setting"
22369 .cindex "EHLO" "argument, setting"
22370 .cindex "LHLO argument setting"
22371 The value of this option is expanded after a connection to a another host has
22372 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22373 command that starts the outgoing SMTP or LMTP session. The default value of the
22374 option is:
22375 .code
22376 $primary_hostname
22377 .endd
22378 During the expansion, the variables &$host$& and &$host_address$& are set to
22379 the identity of the remote host, and the variables &$sending_ip_address$& and
22380 &$sending_port$& are set to the local IP address and port number that are being
22381 used. These variables can be used to generate different values for different
22382 servers or different local IP addresses. For example, if you want the string
22383 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22384 interface address, you could use this:
22385 .code
22386 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22387   {$primary_hostname}}
22388 .endd
22389 The use of &%helo_data%& applies both to sending messages and when doing
22390 callouts.
22391
22392 .option hosts smtp "string list&!!" unset
22393 Hosts are associated with an address by a router such as &(dnslookup)&, which
22394 finds the hosts by looking up the address domain in the DNS, or by
22395 &(manualroute)&, which has lists of hosts in its configuration. However,
22396 email addresses can be passed to the &(smtp)& transport by any router, and not
22397 all of them can provide an associated list of hosts.
22398
22399 The &%hosts%& option specifies a list of hosts to be used if the address being
22400 processed does not have any hosts associated with it. The hosts specified by
22401 &%hosts%& are also used, whether or not the address has its own hosts, if
22402 &%hosts_override%& is set.
22403
22404 The string is first expanded, before being interpreted as a colon-separated
22405 list of host names or IP addresses, possibly including port numbers. The
22406 separator may be changed to something other than colon, as described in section
22407 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22408 item in a &%route_list%& setting for the &(manualroute)& router, as described
22409 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22410 of the &(manualroute)& router is not available here.
22411
22412 If the expansion fails, delivery is deferred. Unless the failure was caused by
22413 the inability to complete a lookup, the error is logged to the panic log as
22414 well as the main log. Host names are looked up either by searching directly for
22415 address records in the DNS or by calling &[gethostbyname()]& (or
22416 &[getipnodebyname()]& when available), depending on the setting of the
22417 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22418 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22419 address are used.
22420
22421 During delivery, the hosts are tried in order, subject to their retry status,
22422 unless &%hosts_randomize%& is set.
22423
22424
22425 .option hosts_avoid_esmtp smtp "host list&!!" unset
22426 .cindex "ESMTP, avoiding use of"
22427 .cindex "HELO" "forcing use of"
22428 .cindex "EHLO" "avoiding use of"
22429 .cindex "PIPELINING" "avoiding the use of"
22430 This option is for use with broken hosts that announce ESMTP facilities (for
22431 example, PIPELINING) and then fail to implement them properly. When a host
22432 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22433 start of the SMTP session. This means that it cannot use any of the ESMTP
22434 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22435
22436
22437 .option hosts_avoid_pipelining smtp "host list&!!" unset
22438 .cindex "PIPELINING" "avoiding the use of"
22439 Exim will not use the SMTP PIPELINING extension when delivering to any host
22440 that matches this list, even if the server host advertises PIPELINING support.
22441
22442
22443 .option hosts_avoid_tls smtp "host list&!!" unset
22444 .cindex "TLS" "avoiding for certain hosts"
22445 Exim will not try to start a TLS session when delivering to any host that
22446 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22447
22448 .option hosts_verify_avoid_tls smtp "host list&!!" *
22449 .cindex "TLS" "avoiding for certain hosts"
22450 Exim will not try to start a TLS session for a verify callout,
22451 or when delivering in cutthrough mode,
22452 to any host that matches this list.
22453 Note that the default is to not use TLS.
22454
22455
22456 .option hosts_max_try smtp integer 5
22457 .cindex "host" "maximum number to try"
22458 .cindex "limit" "number of hosts tried"
22459 .cindex "limit" "number of MX tried"
22460 .cindex "MX record" "maximum tried"
22461 This option limits the number of IP addresses that are tried for any one
22462 delivery in cases where there are temporary delivery errors. Section
22463 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22464
22465
22466 .option hosts_max_try_hardlimit smtp integer 50
22467 This is an additional check on the maximum number of IP addresses that Exim
22468 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22469 why it exists.
22470
22471
22472
22473 .option hosts_nopass_tls smtp "host list&!!" unset
22474 .cindex "TLS" "passing connection"
22475 .cindex "multiple SMTP deliveries"
22476 .cindex "TLS" "multiple message deliveries"
22477 For any host that matches this list, a connection on which a TLS session has
22478 been started will not be passed to a new delivery process for sending another
22479 message on the same connection. See section &<<SECTmulmessam>>& for an
22480 explanation of when this might be needed.
22481
22482
22483 .option hosts_override smtp boolean false
22484 If this option is set and the &%hosts%& option is also set, any hosts that are
22485 attached to the address are ignored, and instead the hosts specified by the
22486 &%hosts%& option are always used. This option does not apply to
22487 &%fallback_hosts%&.
22488
22489
22490 .option hosts_randomize smtp boolean false
22491 .cindex "randomized host list"
22492 .cindex "host" "list of; randomized"
22493 .cindex "fallback" "randomized hosts"
22494 If this option is set, and either the list of hosts is taken from the
22495 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22496 were not obtained from MX records (this includes fallback hosts from the
22497 router), and were not randomized by the router, the order of trying the hosts
22498 is randomized each time the transport runs. Randomizing the order of a host
22499 list can be used to do crude load sharing.
22500
22501 When &%hosts_randomize%& is true, a host list may be split into groups whose
22502 order is separately randomized. This makes it possible to set up MX-like
22503 behaviour. The boundaries between groups are indicated by an item that is just
22504 &`+`& in the host list. For example:
22505 .code
22506 hosts = host1:host2:host3:+:host4:host5
22507 .endd
22508 The order of the first three hosts and the order of the last two hosts is
22509 randomized for each use, but the first three always end up before the last two.
22510 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22511
22512 .option hosts_require_auth smtp "host list&!!" unset
22513 .cindex "authentication" "required by client"
22514 This option provides a list of servers for which authentication must succeed
22515 before Exim will try to transfer a message. If authentication fails for
22516 servers which are not in this list, Exim tries to send unauthenticated. If
22517 authentication fails for one of these servers, delivery is deferred. This
22518 temporary error is detectable in the retry rules, so it can be turned into a
22519 hard failure if required. See also &%hosts_try_auth%&, and chapter
22520 &<<CHAPSMTPAUTH>>& for details of authentication.
22521
22522
22523 .option hosts_require_tls smtp "host list&!!" unset
22524 .cindex "TLS" "requiring for certain servers"
22525 Exim will insist on using a TLS session when delivering to any host that
22526 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22527 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22528 incoming messages, use an appropriate ACL.
22529
22530 .option hosts_try_auth smtp "host list&!!" unset
22531 .cindex "authentication" "optional in client"
22532 This option provides a list of servers to which, provided they announce
22533 authentication support, Exim will attempt to authenticate as a client when it
22534 connects. If authentication fails, Exim will try to transfer the message
22535 unauthenticated. See also &%hosts_require_auth%&, and chapter
22536 &<<CHAPSMTPAUTH>>& for details of authentication.
22537
22538 .option interface smtp "string list&!!" unset
22539 .cindex "bind IP address"
22540 .cindex "IP address" "binding"
22541 .vindex "&$host$&"
22542 .vindex "&$host_address$&"
22543 This option specifies which interface to bind to when making an outgoing SMTP
22544 call. The value is an IP address, not an interface name such as
22545 &`eth0`&. Do not confuse this with the interface address that was used when a
22546 message was received, which is in &$received_ip_address$&, formerly known as
22547 &$interface_address$&. The name was changed to minimize confusion with the
22548 outgoing interface address. There is no variable that contains an outgoing
22549 interface address because, unless it is set by this option, its value is
22550 unknown.
22551
22552 During the expansion of the &%interface%& option the variables &$host$& and
22553 &$host_address$& refer to the host to which a connection is about to be made
22554 during the expansion of the string. Forced expansion failure, or an empty
22555 string result causes the option to be ignored. Otherwise, after expansion, the
22556 string must be a list of IP addresses, colon-separated by default, but the
22557 separator can be changed in the usual way. For example:
22558 .code
22559 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22560 .endd
22561 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22562 connection. If none of them are the correct type, the option is ignored. If
22563 &%interface%& is not set, or is ignored, the system's IP functions choose which
22564 interface to use if the host has more than one.
22565
22566
22567 .option keepalive smtp boolean true
22568 .cindex "keepalive" "on outgoing connection"
22569 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22570 connections. When set, it causes the kernel to probe idle connections
22571 periodically, by sending packets with &"old"& sequence numbers. The other end
22572 of the connection should send a acknowledgment if the connection is still okay
22573 or a reset if the connection has been aborted. The reason for doing this is
22574 that it has the beneficial effect of freeing up certain types of connection
22575 that can get stuck when the remote host is disconnected without tidying up the
22576 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22577 unreachable hosts.
22578
22579
22580 .option lmtp_ignore_quota smtp boolean false
22581 .cindex "LMTP" "ignoring quota errors"
22582 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22583 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22584 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22585
22586 .option max_rcpt smtp integer 100
22587 .cindex "RCPT" "maximum number of outgoing"
22588 This option limits the number of RCPT commands that are sent in a single
22589 SMTP message transaction. Each set of addresses is treated independently, and
22590 so can cause parallel connections to the same host if &%remote_max_parallel%&
22591 permits this.
22592
22593
22594 .option multi_domain smtp boolean true
22595 .vindex "&$domain$&"
22596 When this option is set, the &(smtp)& transport can handle a number of
22597 addresses containing a mixture of different domains provided they all resolve
22598 to the same list of hosts. Turning the option off restricts the transport to
22599 handling only one domain at a time. This is useful if you want to use
22600 &$domain$& in an expansion for the transport, because it is set only when there
22601 is a single domain involved in a remote delivery.
22602
22603
22604 .option port smtp string&!! "see below"
22605 .cindex "port" "sending TCP/IP"
22606 .cindex "TCP/IP" "setting outgoing port"
22607 This option specifies the TCP/IP port on the server to which Exim connects.
22608 &*Note:*& Do not confuse this with the port that was used when a message was
22609 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22610 The name was changed to minimize confusion with the outgoing port. There is no
22611 variable that contains an outgoing port.
22612
22613 If the value of this option begins with a digit it is taken as a port number;
22614 otherwise it is looked up using &[getservbyname()]&. The default value is
22615 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22616 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22617 is deferred.
22618
22619
22620
22621 .option protocol smtp string smtp
22622 .cindex "LMTP" "over TCP/IP"
22623 .cindex "ssmtp protocol" "outbound"
22624 .cindex "TLS" "SSL-on-connect outbound"
22625 .vindex "&$port$&"
22626 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22627 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22628 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22629 deliveries into closed message stores. Exim also has support for running LMTP
22630 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22631
22632 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22633 changes to &"smtps"&, and the transport initiates TLS immediately after
22634 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22635 The Internet standards bodies strongly discourage use of this mode.
22636
22637
22638 .option retry_include_ip_address smtp boolean true
22639 Exim normally includes both the host name and the IP address in the key it
22640 constructs for indexing retry data after a temporary delivery failure. This
22641 means that when one of several IP addresses for a host is failing, it gets
22642 tried periodically (controlled by the retry rules), but use of the other IP
22643 addresses is not affected.
22644
22645 However, in some dialup environments hosts are assigned a different IP address
22646 each time they connect. In this situation the use of the IP address as part of
22647 the retry key leads to undesirable behaviour. Setting this option false causes
22648 Exim to use only the host name. This should normally be done on a separate
22649 instance of the &(smtp)& transport, set up specially to handle the dialup
22650 hosts.
22651
22652
22653 .option serialize_hosts smtp "host list&!!" unset
22654 .cindex "serializing connections"
22655 .cindex "host" "serializing connections"
22656 Because Exim operates in a distributed manner, if several messages for the same
22657 host arrive at around the same time, more than one simultaneous connection to
22658 the remote host can occur. This is not usually a problem except when there is a
22659 slow link between the hosts. In that situation it may be helpful to restrict
22660 Exim to one connection at a time. This can be done by setting
22661 &%serialize_hosts%& to match the relevant hosts.
22662
22663 .cindex "hints database" "serializing deliveries to a host"
22664 Exim implements serialization by means of a hints database in which a record is
22665 written whenever a process connects to one of the restricted hosts. The record
22666 is deleted when the connection is completed. Obviously there is scope for
22667 records to get left lying around if there is a system or program crash. To
22668 guard against this, Exim ignores any records that are more than six hours old.
22669
22670 If you set up this kind of serialization, you should also arrange to delete the
22671 relevant hints database whenever your system reboots. The names of the files
22672 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22673 may be one or two files, depending on the type of DBM in use. The same files
22674 are used for ETRN serialization.
22675
22676
22677 .option size_addition smtp integer 1024
22678 .cindex "SMTP" "SIZE"
22679 .cindex "message" "size issue for transport filter"
22680 .cindex "size" "of message"
22681 .cindex "transport" "filter"
22682 .cindex "filter" "transport filter"
22683 If a remote SMTP server indicates that it supports the SIZE option of the
22684 MAIL command, Exim uses this to pass over the message size at the start of
22685 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22686 sends, to allow for headers and other text that may be added during delivery by
22687 configuration options or in a transport filter. It may be necessary to increase
22688 this if a lot of text is added to messages.
22689
22690 Alternatively, if the value of &%size_addition%& is set negative, it disables
22691 the use of the SIZE option altogether.
22692
22693
22694 .option tls_certificate smtp string&!! unset
22695 .cindex "TLS" "client certificate, location of"
22696 .cindex "certificate" "client, location of"
22697 .vindex "&$host$&"
22698 .vindex "&$host_address$&"
22699 The value of this option must be the absolute path to a file which contains the
22700 client's certificate, for possible use when sending a message over an encrypted
22701 connection. The values of &$host$& and &$host_address$& are set to the name and
22702 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22703 details of TLS.
22704
22705 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22706 certificate when sending messages as a client. The global option of the same
22707 name specifies the certificate for Exim as a server; it is not automatically
22708 assumed that the same certificate should be used when Exim is operating as a
22709 client.
22710
22711
22712 .option tls_crl smtp string&!! unset
22713 .cindex "TLS" "client certificate revocation list"
22714 .cindex "certificate" "revocation list for client"
22715 This option specifies a certificate revocation list. The expanded value must
22716 be the name of a file that contains a CRL in PEM format.
22717
22718
22719 .new
22720 .option tls_dh_min_bits smtp integer 1024
22721 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
22722 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
22723 key agreement is negotiated, the server will provide a large prime number
22724 for use.  This option establishes the minimum acceptable size of that number.
22725 If the parameter offered by the server is too small, then the TLS handshake
22726 will fail.
22727
22728 Only supported when using GnuTLS.
22729 .wen
22730
22731
22732 .option tls_privatekey smtp string&!! unset
22733 .cindex "TLS" "client private key, location of"
22734 .vindex "&$host$&"
22735 .vindex "&$host_address$&"
22736 The value of this option must be the absolute path to a file which contains the
22737 client's private key. This is used when sending a message over an encrypted
22738 connection using a client certificate. The values of &$host$& and
22739 &$host_address$& are set to the name and address of the server during the
22740 expansion. If this option is unset, or the expansion is forced to fail, or the
22741 result is an empty string, the private key is assumed to be in the same file as
22742 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22743
22744
22745 .option tls_require_ciphers smtp string&!! unset
22746 .cindex "TLS" "requiring specific ciphers"
22747 .cindex "cipher" "requiring specific"
22748 .vindex "&$host$&"
22749 .vindex "&$host_address$&"
22750 The value of this option must be a list of permitted cipher suites, for use
22751 when setting up an outgoing encrypted connection. (There is a global option of
22752 the same name for controlling incoming connections.) The values of &$host$& and
22753 &$host_address$& are set to the name and address of the server during the
22754 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22755 is used in different ways by OpenSSL and GnuTLS (see sections
22756 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22757 ciphers is a preference order.
22758
22759
22760
22761 .option tls_sni smtp string&!! unset
22762 .cindex "TLS" "Server Name Indication"
22763 .vindex "&$tls_sni$&"
22764 If this option is set then it sets the $tls_out_sni variable and causes any
22765 TLS session to pass this value as the Server Name Indication extension to
22766 the remote side, which can be used by the remote side to select an appropriate
22767 certificate and private key for the session.
22768
22769 See &<<SECTtlssni>>& for more information.
22770
22771 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
22772 TLS extensions.
22773
22774
22775
22776
22777 .option tls_tempfail_tryclear smtp boolean true
22778 .cindex "4&'xx'& responses" "to STARTTLS"
22779 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22780 setting up a TLS session, this option determines whether or not Exim should try
22781 to deliver the message unencrypted. If it is set false, delivery to the
22782 current host is deferred; if there are other hosts, they are tried. If this
22783 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22784 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22785 TLS negotiation fails, Exim closes the current connection (because it is in an
22786 unknown state), opens a new one to the same host, and then tries the delivery
22787 in clear.
22788
22789
22790 .option tls_verify_certificates smtp string&!! unset
22791 .cindex "TLS" "server certificate verification"
22792 .cindex "certificate" "verification of server"
22793 .vindex "&$host$&"
22794 .vindex "&$host_address$&"
22795 The value of this option must be the absolute path to a file containing
22796 permitted server certificates, for use when setting up an encrypted connection.
22797 Alternatively, if you are using OpenSSL, you can set
22798 &%tls_verify_certificates%& to the name of a directory containing certificate
22799 files. This does not work with GnuTLS; the option must be set to the name of a
22800 single file if you are using GnuTLS. The values of &$host$& and
22801 &$host_address$& are set to the name and address of the server during the
22802 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22803
22804
22805
22806
22807 .section "How the limits for the number of hosts to try are used" &&&
22808          "SECTvalhosmax"
22809 .cindex "host" "maximum number to try"
22810 .cindex "limit" "hosts; maximum number tried"
22811 There are two options that are concerned with the number of hosts that are
22812 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22813 &%hosts_max_try_hardlimit%&.
22814
22815
22816 The &%hosts_max_try%& option limits the number of hosts that are tried
22817 for a single delivery. However, despite the term &"host"& in its name, the
22818 option actually applies to each IP address independently. In other words, a
22819 multihomed host is treated as several independent hosts, just as it is for
22820 retrying.
22821
22822 Many of the larger ISPs have multiple MX records which often point to
22823 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22824 created as a result of routing one of these domains.
22825
22826 Trying every single IP address on such a long list does not seem sensible; if
22827 several at the top of the list fail, it is reasonable to assume there is some
22828 problem that is likely to affect all of them. Roughly speaking, the value of
22829 &%hosts_max_try%& is the maximum number that are tried before deferring the
22830 delivery. However, the logic cannot be quite that simple.
22831
22832 Firstly, IP addresses that are skipped because their retry times have not
22833 arrived do not count, and in addition, addresses that are past their retry
22834 limits are also not counted, even when they are tried. This means that when
22835 some IP addresses are past their retry limits, more than the value of
22836 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22837 that all IP addresses are considered before timing out an email address (but
22838 see below for an exception).
22839
22840 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22841 list to see if there is a subsequent host with a different (higher valued) MX.
22842 If there is, that host is considered next, and the current IP address is used
22843 but not counted. This behaviour helps in the case of a domain with a retry rule
22844 that hardly ever delays any hosts, as is now explained:
22845
22846 Consider the case of a long list of hosts with one MX value, and a few with a
22847 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22848 hosts at the top of the list are tried at first. With the default retry rule,
22849 which specifies increasing retry times, the higher MX hosts are eventually
22850 tried when those at the top of the list are skipped because they have not
22851 reached their retry times.
22852
22853 However, it is common practice to put a fixed short retry time on domains for
22854 large ISPs, on the grounds that their servers are rarely down for very long.
22855 Unfortunately, these are exactly the domains that tend to resolve to long lists
22856 of hosts. The short retry time means that the lowest MX hosts are tried every
22857 time. The attempts may be in a different order because of random sorting, but
22858 without the special MX check, the higher MX hosts would never be tried until
22859 all the lower MX hosts had timed out (which might be several days), because
22860 there are always some lower MX hosts that have reached their retry times. With
22861 the special check, Exim considers at least one IP address from each MX value at
22862 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22863 reached.
22864
22865 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22866 particular, Exim normally eventually tries all the IP addresses before timing
22867 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22868 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22869 been set up with hundreds of IP addresses for some domains. It can
22870 take a very long time indeed for an address to time out in these cases.
22871
22872 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22873 Exim never tries more than this number of IP addresses; if it hits this limit
22874 and they are all timed out, the email address is bounced, even though not all
22875 possible IP addresses have been tried.
22876 .ecindex IIDsmttra1
22877 .ecindex IIDsmttra2
22878
22879
22880
22881
22882
22883 . ////////////////////////////////////////////////////////////////////////////
22884 . ////////////////////////////////////////////////////////////////////////////
22885
22886 .chapter "Address rewriting" "CHAPrewrite"
22887 .scindex IIDaddrew "rewriting" "addresses"
22888 There are some circumstances in which Exim automatically rewrites domains in
22889 addresses. The two most common are when an address is given without a domain
22890 (referred to as an &"unqualified address"&) or when an address contains an
22891 abbreviated domain that is expanded by DNS lookup.
22892
22893 Unqualified envelope addresses are accepted only for locally submitted
22894 messages, or for messages that are received from hosts matching
22895 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22896 appropriate. Unqualified addresses in header lines are qualified if they are in
22897 locally submitted messages, or messages from hosts that are permitted to send
22898 unqualified envelope addresses. Otherwise, unqualified addresses in header
22899 lines are neither qualified nor rewritten.
22900
22901 One situation in which Exim does &'not'& automatically rewrite a domain is
22902 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22903 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22904 do this. The new RFCs do not contain this suggestion.
22905
22906
22907 .section "Explicitly configured address rewriting" "SECID147"
22908 This chapter describes the rewriting rules that can be used in the
22909 main rewrite section of the configuration file, and also in the generic
22910 &%headers_rewrite%& option that can be set on any transport.
22911
22912 Some people believe that configured address rewriting is a Mortal Sin.
22913 Others believe that life is not possible without it. Exim provides the
22914 facility; you do not have to use it.
22915
22916 The main rewriting rules that appear in the &"rewrite"& section of the
22917 configuration file are applied to addresses in incoming messages, both envelope
22918 addresses and addresses in header lines. Each rule specifies the types of
22919 address to which it applies.
22920
22921 Whether or not addresses in header lines are rewritten depends on the origin of
22922 the headers and the type of rewriting. Global rewriting, that is, rewriting
22923 rules from the rewrite section of the configuration file, is applied only to
22924 those headers that were received with the message. Header lines that are added
22925 by ACLs or by a system filter or by individual routers or transports (which
22926 are specific to individual recipient addresses) are not rewritten by the global
22927 rules.
22928
22929 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22930 applies all headers except those added by routers and transports. That is, as
22931 well as the headers that were received with the message, it also applies to
22932 headers that were added by an ACL or a system filter.
22933
22934
22935 In general, rewriting addresses from your own system or domain has some
22936 legitimacy. Rewriting other addresses should be done only with great care and
22937 in special circumstances. The author of Exim believes that rewriting should be
22938 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22939 Although it can sometimes be used as a routing tool, this is very strongly
22940 discouraged.
22941
22942 There are two commonly encountered circumstances where rewriting is used, as
22943 illustrated by these examples:
22944
22945 .ilist
22946 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22947 exchange mail with each other behind a firewall, but there is only a single
22948 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22949 &'hitch.fict.example'& when sending mail off-site.
22950 .next
22951 A host rewrites the local parts of its own users so that, for example,
22952 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22953 .endlist
22954
22955
22956
22957 .section "When does rewriting happen?" "SECID148"
22958 .cindex "rewriting" "timing of"
22959 .cindex "&ACL;" "rewriting addresses in"
22960 Configured address rewriting can take place at several different stages of a
22961 message's processing.
22962
22963 .vindex "&$sender_address$&"
22964 At the start of an ACL for MAIL, the sender address may have been rewritten
22965 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22966 ordinary rewrite rules have yet been applied. If, however, the sender address
22967 is verified in the ACL, it is rewritten before verification, and remains
22968 rewritten thereafter. The subsequent value of &$sender_address$& is the
22969 rewritten address. This also applies if sender verification happens in a
22970 RCPT ACL. Otherwise, when the sender address is not verified, it is
22971 rewritten as soon as a message's header lines have been received.
22972
22973 .vindex "&$domain$&"
22974 .vindex "&$local_part$&"
22975 Similarly, at the start of an ACL for RCPT, the current recipient's address
22976 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22977 rewrite rules have yet been applied to it. However, the behaviour is different
22978 from the sender address when a recipient is verified. The address is rewritten
22979 for the verification, but the rewriting is not remembered at this stage. The
22980 value of &$local_part$& and &$domain$& after verification are always the same
22981 as they were before (that is, they contain the unrewritten &-- except for
22982 SMTP-time rewriting &-- address).
22983
22984 As soon as a message's header lines have been received, all the envelope
22985 recipient addresses are permanently rewritten, and rewriting is also applied to
22986 the addresses in the header lines (if configured). This happens before adding
22987 any header lines that were specified in MAIL or RCPT ACLs, and
22988 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22989 before the DATA ACL and &[local_scan()]& functions are run.
22990
22991 When an address is being routed, either for delivery or for verification,
22992 rewriting is applied immediately to child addresses that are generated by
22993 redirection, unless &%no_rewrite%& is set on the router.
22994
22995 .cindex "envelope sender" "rewriting at transport time"
22996 .cindex "rewriting" "at transport time"
22997 .cindex "header lines" "rewriting at transport time"
22998 At transport time, additional rewriting of addresses in header lines can be
22999 specified by setting the generic &%headers_rewrite%& option on a transport.
23000 This option contains rules that are identical in form to those in the rewrite
23001 section of the configuration file. They are applied to the original message
23002 header lines and any that were added by ACLs or a system filter. They are not
23003 applied to header lines that are added by routers or the transport.
23004
23005 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23006 transport option. However, it is not possible to rewrite envelope recipients at
23007 transport time.
23008
23009
23010
23011
23012 .section "Testing the rewriting rules that apply on input" "SECID149"
23013 .cindex "rewriting" "testing"
23014 .cindex "testing" "rewriting"
23015 Exim's input rewriting configuration appears in a part of the run time
23016 configuration file headed by &"begin rewrite"&. It can be tested by the
23017 &%-brw%& command line option. This takes an address (which can be a full RFC
23018 2822 address) as its argument. The output is a list of how the address would be
23019 transformed by the rewriting rules for each of the different places it might
23020 appear in an incoming message, that is, for each different header and for the
23021 envelope sender and recipient fields. For example,
23022 .code
23023 exim -brw ph10@exim.workshop.example
23024 .endd
23025 might produce the output
23026 .code
23027 sender: Philip.Hazel@exim.workshop.example
23028 from: Philip.Hazel@exim.workshop.example
23029 to: ph10@exim.workshop.example
23030 cc: ph10@exim.workshop.example
23031 bcc: ph10@exim.workshop.example
23032 reply-to: Philip.Hazel@exim.workshop.example
23033 env-from: Philip.Hazel@exim.workshop.example
23034 env-to: ph10@exim.workshop.example
23035 .endd
23036 which shows that rewriting has been set up for that address when used in any of
23037 the source fields, but not when it appears as a recipient address. At the
23038 present time, there is no equivalent way of testing rewriting rules that are
23039 set for a particular transport.
23040
23041
23042 .section "Rewriting rules" "SECID150"
23043 .cindex "rewriting" "rules"
23044 The rewrite section of the configuration file consists of lines of rewriting
23045 rules in the form
23046 .display
23047 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23048 .endd
23049 Rewriting rules that are specified for the &%headers_rewrite%& generic
23050 transport option are given as a colon-separated list. Each item in the list
23051 takes the same form as a line in the main rewriting configuration (except that
23052 any colons must be doubled, of course).
23053
23054 The formats of source patterns and replacement strings are described below.
23055 Each is terminated by white space, unless enclosed in double quotes, in which
23056 case normal quoting conventions apply inside the quotes. The flags are single
23057 characters which may appear in any order. Spaces and tabs between them are
23058 ignored.
23059
23060 For each address that could potentially be rewritten, the rules are scanned in
23061 order, and replacements for the address from earlier rules can themselves be
23062 replaced by later rules (but see the &"q"& and &"R"& flags).
23063
23064 The order in which addresses are rewritten is undefined, may change between
23065 releases, and must not be relied on, with one exception: when a message is
23066 received, the envelope sender is always rewritten first, before any header
23067 lines are rewritten. For example, the replacement string for a rewrite of an
23068 address in &'To:'& must not assume that the message's address in &'From:'& has
23069 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23070 that the envelope sender has already been rewritten.
23071
23072 .vindex "&$domain$&"
23073 .vindex "&$local_part$&"
23074 The variables &$local_part$& and &$domain$& can be used in the replacement
23075 string to refer to the address that is being rewritten. Note that lookup-driven
23076 rewriting can be done by a rule of the form
23077 .code
23078 *@*   ${lookup ...
23079 .endd
23080 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23081 refer to the address that is being rewritten.
23082
23083
23084 .section "Rewriting patterns" "SECID151"
23085 .cindex "rewriting" "patterns"
23086 .cindex "address list" "in a rewriting pattern"
23087 The source pattern in a rewriting rule is any item which may appear in an
23088 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23089 single-item address list, which means that it is expanded before being tested
23090 against the address. As always, if you use a regular expression as a pattern,
23091 you must take care to escape dollar and backslash characters, or use the &`\N`&
23092 facility to suppress string expansion within the regular expression.
23093
23094 Domains in patterns should be given in lower case. Local parts in patterns are
23095 case-sensitive. If you want to do case-insensitive matching of local parts, you
23096 can use a regular expression that starts with &`^(?i)`&.
23097
23098 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23099 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23100 depending on the type of match which occurred. These can be used in the
23101 replacement string to insert portions of the incoming address. &$0$& always
23102 refers to the complete incoming address. When a regular expression is used, the
23103 numerical variables are set from its capturing subexpressions. For other types
23104 of pattern they are set as follows:
23105
23106 .ilist
23107 If a local part or domain starts with an asterisk, the numerical variables
23108 refer to the character strings matched by asterisks, with &$1$& associated with
23109 the first asterisk, and &$2$& with the second, if present. For example, if the
23110 pattern
23111 .code
23112 *queen@*.fict.example
23113 .endd
23114 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23115 .code
23116 $0 = hearts-queen@wonderland.fict.example
23117 $1 = hearts-
23118 $2 = wonderland
23119 .endd
23120 Note that if the local part does not start with an asterisk, but the domain
23121 does, it is &$1$& that contains the wild part of the domain.
23122
23123 .next
23124 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23125 of the domain are placed in the next available numerical variables. Suppose,
23126 for example, that the address &'foo@bar.baz.example'& is processed by a
23127 rewriting rule of the form
23128 .display
23129 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23130 .endd
23131 and the key in the file that matches the domain is &`*.baz.example`&. Then
23132 .code
23133 $1 = foo
23134 $2 = bar
23135 $3 = baz.example
23136 .endd
23137 If the address &'foo@baz.example'& is looked up, this matches the same
23138 wildcard file entry, and in this case &$2$& is set to the empty string, but
23139 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23140 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23141 whole domain. For non-partial domain lookups, no numerical variables are set.
23142 .endlist
23143
23144
23145 .section "Rewriting replacements" "SECID152"
23146 .cindex "rewriting" "replacements"
23147 If the replacement string for a rule is a single asterisk, addresses that
23148 match the pattern and the flags are &'not'& rewritten, and no subsequent
23149 rewriting rules are scanned. For example,
23150 .code
23151 hatta@lookingglass.fict.example  *  f
23152 .endd
23153 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23154 &'From:'& headers.
23155
23156 .vindex "&$domain$&"
23157 .vindex "&$local_part$&"
23158 If the replacement string is not a single asterisk, it is expanded, and must
23159 yield a fully qualified address. Within the expansion, the variables
23160 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23161 Any letters they contain retain their original case &-- they are not lower
23162 cased. The numerical variables are set up according to the type of pattern that
23163 matched the address, as described above. If the expansion is forced to fail by
23164 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23165 current rule is abandoned, but subsequent rules may take effect. Any other
23166 expansion failure causes the entire rewriting operation to be abandoned, and an
23167 entry written to the panic log.
23168
23169
23170
23171 .section "Rewriting flags" "SECID153"
23172 There are three different kinds of flag that may appear on rewriting rules:
23173
23174 .ilist
23175 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23176 c, f, h, r, s, t.
23177 .next
23178 A flag that specifies rewriting at SMTP time: S.
23179 .next
23180 Flags that control the rewriting process: Q, q, R, w.
23181 .endlist
23182
23183 For rules that are part of the &%headers_rewrite%& generic transport option,
23184 E, F, T, and S are not permitted.
23185
23186
23187
23188 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23189          "SECID154"
23190 .cindex "rewriting" "flags"
23191 If none of the following flag letters, nor the &"S"& flag (see section
23192 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23193 and to both the sender and recipient fields of the envelope, whereas a
23194 transport-time rewriting rule just applies to all headers. Otherwise, the
23195 rewriting rule is skipped unless the relevant addresses are being processed.
23196 .display
23197 &`E`&       rewrite all envelope fields
23198 &`F`&       rewrite the envelope From field
23199 &`T`&       rewrite the envelope To field
23200 &`b`&       rewrite the &'Bcc:'& header
23201 &`c`&       rewrite the &'Cc:'& header
23202 &`f`&       rewrite the &'From:'& header
23203 &`h`&       rewrite all headers
23204 &`r`&       rewrite the &'Reply-To:'& header
23205 &`s`&       rewrite the &'Sender:'& header
23206 &`t`&       rewrite the &'To:'& header
23207 .endd
23208 "All headers" means all of the headers listed above that can be selected
23209 individually, plus their &'Resent-'& versions. It does not include
23210 other headers such as &'Subject:'& etc.
23211
23212 You should be particularly careful about rewriting &'Sender:'& headers, and
23213 restrict this to special known cases in your own domains.
23214
23215
23216 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23217 .cindex "SMTP" "rewriting malformed addresses"
23218 .cindex "RCPT" "rewriting argument of"
23219 .cindex "MAIL" "rewriting argument of"
23220 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23221 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23222 before any other processing; even before syntax checking. The pattern is
23223 required to be a regular expression, and it is matched against the whole of the
23224 data for the command, including any surrounding angle brackets.
23225
23226 .vindex "&$domain$&"
23227 .vindex "&$local_part$&"
23228 This form of rewrite rule allows for the handling of addresses that are not
23229 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23230 input). Because the input is not required to be a syntactically valid address,
23231 the variables &$local_part$& and &$domain$& are not available during the
23232 expansion of the replacement string. The result of rewriting replaces the
23233 original address in the MAIL or RCPT command.
23234
23235
23236 .section "Flags controlling the rewriting process" "SECID155"
23237 There are four flags which control the way the rewriting process works. These
23238 take effect only when a rule is invoked, that is, when the address is of the
23239 correct type (matches the flags) and matches the pattern:
23240
23241 .ilist
23242 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23243 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23244 absence of &"Q"& the rewritten address must always include a domain.
23245 .next
23246 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23247 even if no rewriting actually takes place because of a &"fail"& in the
23248 expansion. The &"q"& flag is not effective if the address is of the wrong type
23249 (does not match the flags) or does not match the pattern.
23250 .next
23251 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23252 address, up to ten times. It can be combined with the &"q"& flag, to stop
23253 rewriting once it fails to match (after at least one successful rewrite).
23254 .next
23255 .cindex "rewriting" "whole addresses"
23256 When an address in a header is rewritten, the rewriting normally applies only
23257 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23258 left unchanged. For example, rewriting might change
23259 .code
23260 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23261 .endd
23262 into
23263 .code
23264 From: Ford Prefect <prefectf@hitch.fict.example>
23265 .endd
23266 .cindex "RFC 2047"
23267 Sometimes there is a need to replace the whole address item, and this can be
23268 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23269 causes an address in a header line to be rewritten, the entire address is
23270 replaced, not just the working part. The replacement must be a complete RFC
23271 2822 address, including the angle brackets if necessary. If text outside angle
23272 brackets contains a character whose value is greater than 126 or less than 32
23273 (except for tab), the text is encoded according to RFC 2047. The character set
23274 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23275
23276 When the &"w"& flag is set on a rule that causes an envelope address to be
23277 rewritten, all but the working part of the replacement address is discarded.
23278 .endlist
23279
23280
23281 .section "Rewriting examples" "SECID156"
23282 Here is an example of the two common rewriting paradigms:
23283 .code
23284 *@*.hitch.fict.example  $1@hitch.fict.example
23285 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23286                      {$value}fail}@hitch.fict.example bctfrF
23287 .endd
23288 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23289 the string expansion to fail if the lookup does not succeed. In this context it
23290 has the effect of leaving the original address unchanged, but Exim goes on to
23291 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23292 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23293 explicitly, which would cause the rewritten address to be the same as before,
23294 at the cost of a small bit of processing. Not supplying either of these is an
23295 error, since the rewritten address would then contain no local part.
23296
23297 The first example above replaces the domain with a superior, more general
23298 domain. This may not be desirable for certain local parts. If the rule
23299 .code
23300 root@*.hitch.fict.example  *
23301 .endd
23302 were inserted before the first rule, rewriting would be suppressed for the
23303 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23304
23305 Rewriting can be made conditional on a number of tests, by making use of
23306 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23307 messages that originate outside the local host:
23308 .code
23309 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23310                          {$1@hitch.fict.example}fail}"
23311 .endd
23312 The replacement string is quoted in this example because it contains white
23313 space.
23314
23315 .cindex "rewriting" "bang paths"
23316 .cindex "bang paths" "rewriting"
23317 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23318 an address it treats it as an unqualified local part which it qualifies with
23319 the local qualification domain (if the source of the message is local or if the
23320 remote host is permitted to send unqualified addresses). Rewriting can
23321 sometimes be used to handle simple bang paths with a fixed number of
23322 components. For example, the rule
23323 .code
23324 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23325 .endd
23326 rewrites a two-component bang path &'host.name!user'& as the domain address
23327 &'user@host.name'&. However, there is a security implication in using this as
23328 a global rewriting rule for envelope addresses. It can provide a backdoor
23329 method for using your system as a relay, because the incoming addresses appear
23330 to be local. If the bang path addresses are received via SMTP, it is safer to
23331 use the &"S"& flag to rewrite them as they are received, so that relay checking
23332 can be done on the rewritten addresses.
23333 .ecindex IIDaddrew
23334
23335
23336
23337
23338
23339 . ////////////////////////////////////////////////////////////////////////////
23340 . ////////////////////////////////////////////////////////////////////////////
23341
23342 .chapter "Retry configuration" "CHAPretry"
23343 .scindex IIDretconf1 "retry" "configuration, description of"
23344 .scindex IIDregconf2 "configuration file" "retry section"
23345 The &"retry"& section of the runtime configuration file contains a list of
23346 retry rules that control how often Exim tries to deliver messages that cannot
23347 be delivered at the first attempt. If there are no retry rules (the section is
23348 empty or not present), there are no retries. In this situation, temporary
23349 errors are treated as permanent. The default configuration contains a single,
23350 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23351 line option can be used to test which retry rule will be used for a given
23352 address, domain and error.
23353
23354 The most common cause of retries is temporary failure to deliver to a remote
23355 host because the host is down, or inaccessible because of a network problem.
23356 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23357 address) basis, not on a per-message basis. Thus, if one message has recently
23358 been delayed, delivery of a new message to the same host is not immediately
23359 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23360 log selector is set, the message
23361 .cindex "retry" "time not reached"
23362 &"retry time not reached"& is written to the main log whenever a delivery is
23363 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23364 the handling of errors during remote deliveries.
23365
23366 Retry processing applies to routing as well as to delivering, except as covered
23367 in the next paragraph. The retry rules do not distinguish between these
23368 actions. It is not possible, for example, to specify different behaviour for
23369 failures to route the domain &'snark.fict.example'& and failures to deliver to
23370 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23371 added complication, so did not implement it. However, although they share the
23372 same retry rule, the actual retry times for routing and transporting a given
23373 domain are maintained independently.
23374
23375 When a delivery is not part of a queue run (typically an immediate delivery on
23376 receipt of a message), the routers are always run, and local deliveries are
23377 always attempted, even if retry times are set for them. This makes for better
23378 behaviour if one particular message is causing problems (for example, causing
23379 quota overflow, or provoking an error in a filter file). If such a delivery
23380 suffers a temporary failure, the retry data is updated as normal, and
23381 subsequent delivery attempts from queue runs occur only when the retry time for
23382 the local address is reached.
23383
23384 .section "Changing retry rules" "SECID157"
23385 If you change the retry rules in your configuration, you should consider
23386 whether or not to delete the retry data that is stored in Exim's spool area in
23387 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23388 always safe; that is why they are called &"hints"&.
23389
23390 The hints retry data contains suggested retry times based on the previous
23391 rules. In the case of a long-running problem with a remote host, it might
23392 record the fact that the host has timed out. If your new rules increase the
23393 timeout time for such a host, you should definitely remove the old retry data
23394 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23395 messages that it should now be retaining.
23396
23397
23398
23399 .section "Format of retry rules" "SECID158"
23400 .cindex "retry" "rules"
23401 Each retry rule occupies one line and consists of three or four parts,
23402 separated by white space: a pattern, an error name, an optional list of sender
23403 addresses, and a list of retry parameters. The pattern and sender lists must be
23404 enclosed in double quotes if they contain white space. The rules are searched
23405 in order until one is found where the pattern, error name, and sender list (if
23406 present) match the failing host or address, the error that occurred, and the
23407 message's sender, respectively.
23408
23409
23410 The pattern is any single item that may appear in an address list (see section
23411 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23412 which means that it is expanded before being tested against the address that
23413 has been delayed. A negated address list item is permitted. Address
23414 list processing treats a plain domain name as if it were preceded by &"*@"&,
23415 which makes it possible for many retry rules to start with just a domain. For
23416 example,
23417 .code
23418 lookingglass.fict.example        *  F,24h,30m;
23419 .endd
23420 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23421 whereas
23422 .code
23423 alice@lookingglass.fict.example  *  F,24h,30m;
23424 .endd
23425 applies only to temporary failures involving the local part &%alice%&.
23426 In practice, almost all rules start with a domain name pattern without a local
23427 part.
23428
23429 .cindex "regular expressions" "in retry rules"
23430 &*Warning*&: If you use a regular expression in a routing rule pattern, it
23431 must match a complete address, not just a domain, because that is how regular
23432 expressions work in address lists.
23433 .display
23434 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23435 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23436 .endd
23437
23438
23439 .section "Choosing which retry rule to use for address errors" "SECID159"
23440 When Exim is looking for a retry rule after a routing attempt has failed (for
23441 example, after a DNS timeout), each line in the retry configuration is tested
23442 against the complete address only if &%retry_use_local_part%& is set for the
23443 router. Otherwise, only the domain is used, except when matching against a
23444 regular expression, when the local part of the address is replaced with &"*"&.
23445 A domain on its own can match a domain pattern, or a pattern that starts with
23446 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23447 &%check_local_user%& is true, and false for other routers.
23448
23449 Similarly, when Exim is looking for a retry rule after a local delivery has
23450 failed (for example, after a mailbox full error), each line in the retry
23451 configuration is tested against the complete address only if
23452 &%retry_use_local_part%& is set for the transport (it defaults true for all
23453 local transports).
23454
23455 .cindex "4&'xx'& responses" "retry rules for"
23456 However, when Exim is looking for a retry rule after a remote delivery attempt
23457 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23458 whole address is always used as the key when searching the retry rules. The
23459 rule that is found is used to create a retry time for the combination of the
23460 failing address and the message's sender. It is the combination of sender and
23461 recipient that is delayed in subsequent queue runs until its retry time is
23462 reached. You can delay the recipient without regard to the sender by setting
23463 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23464 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23465 commands.
23466
23467
23468
23469 .section "Choosing which retry rule to use for host and message errors" &&&
23470          "SECID160"
23471 For a temporary error that is not related to an individual address (for
23472 example, a connection timeout), each line in the retry configuration is checked
23473 twice. First, the name of the remote host is used as a domain name (preceded by
23474 &"*@"& when matching a regular expression). If this does not match the line,
23475 the domain from the email address is tried in a similar fashion. For example,
23476 suppose the MX records for &'a.b.c.example'& are
23477 .code
23478 a.b.c.example  MX  5  x.y.z.example
23479                MX  6  p.q.r.example
23480                MX  7  m.n.o.example
23481 .endd
23482 and the retry rules are
23483 .code
23484 p.q.r.example    *      F,24h,30m;
23485 a.b.c.example    *      F,4d,45m;
23486 .endd
23487 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23488 first rule matches neither the host nor the domain, so Exim looks at the second
23489 rule. This does not match the host, but it does match the domain, so it is used
23490 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23491 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23492 first retry rule is used, because it matches the host.
23493
23494 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23495 first rule to determine retry times, but for all the other hosts for the domain
23496 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23497 routing to &'a.b.c.example'& suffers a temporary failure.
23498
23499 &*Note*&: The host name is used when matching the patterns, not its IP address.
23500 However, if a message is routed directly to an IP address without the use of a
23501 host name, for example, if a &(manualroute)& router contains a setting such as:
23502 .code
23503 route_list = *.a.example  192.168.34.23
23504 .endd
23505 then the &"host name"& that is used when searching for a retry rule is the
23506 textual form of the IP address.
23507
23508 .section "Retry rules for specific errors" "SECID161"
23509 .cindex "retry" "specific errors; specifying"
23510 The second field in a retry rule is the name of a particular error, or an
23511 asterisk, which matches any error. The errors that can be tested for are:
23512
23513 .vlist
23514 .vitem &%auth_failed%&
23515 Authentication failed when trying to send to a host in the
23516 &%hosts_require_auth%& list in an &(smtp)& transport.
23517
23518 .vitem &%data_4xx%&
23519 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23520 after the command, or after sending the message's data.
23521
23522 .vitem &%mail_4xx%&
23523 A 4&'xx'& error was received for an outgoing MAIL command.
23524
23525 .vitem &%rcpt_4xx%&
23526 A 4&'xx'& error was received for an outgoing RCPT command.
23527 .endlist
23528
23529 For the three 4&'xx'& errors, either the first or both of the x's can be given
23530 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23531 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23532 and have retries every ten minutes with a one-hour timeout, you could set up a
23533 retry rule of this form:
23534 .code
23535 the.domain.name  rcpt_452   F,1h,10m
23536 .endd
23537 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23538 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23539
23540 .vlist
23541 .vitem &%lost_connection%&
23542 A server unexpectedly closed the SMTP connection. There may, of course,
23543 legitimate reasons for this (host died, network died), but if it repeats a lot
23544 for the same host, it indicates something odd.
23545
23546 .vitem &%refused_MX%&
23547 A connection to a host obtained from an MX record was refused.
23548
23549 .vitem &%refused_A%&
23550 A connection to a host not obtained from an MX record was refused.
23551
23552 .vitem &%refused%&
23553 A connection was refused.
23554
23555 .vitem &%timeout_connect_MX%&
23556 A connection attempt to a host obtained from an MX record timed out.
23557
23558 .vitem &%timeout_connect_A%&
23559 A connection attempt to a host not obtained from an MX record timed out.
23560
23561 .vitem &%timeout_connect%&
23562 A connection attempt timed out.
23563
23564 .vitem &%timeout_MX%&
23565 There was a timeout while connecting or during an SMTP session with a host
23566 obtained from an MX record.
23567
23568 .vitem &%timeout_A%&
23569 There was a timeout while connecting or during an SMTP session with a host not
23570 obtained from an MX record.
23571
23572 .vitem &%timeout%&
23573 There was a timeout while connecting or during an SMTP session.
23574
23575 .vitem &%tls_required%&
23576 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23577 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23578 to STARTTLS, or there was a problem setting up the TLS connection.
23579
23580 .vitem &%quota%&
23581 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23582 transport.
23583
23584 .vitem &%quota_%&<&'time'&>
23585 .cindex "quota" "error testing in retry rule"
23586 .cindex "retry" "quota error testing"
23587 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23588 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23589 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23590 for four days.
23591 .endlist
23592
23593 .cindex "mailbox" "time of last read"
23594 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23595 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23596 it should be based on the last time that the user accessed the mailbox.
23597 However, it is not always possible to determine this. Exim uses the following
23598 heuristic rules:
23599
23600 .ilist
23601 If the mailbox is a single file, the time of last access (the &"atime"&) is
23602 used. As no new messages are being delivered (because the mailbox is over
23603 quota), Exim does not access the file, so this is the time of last user access.
23604 .next
23605 .cindex "maildir format" "time of last read"
23606 For a maildir delivery, the time of last modification of the &_new_&
23607 subdirectory is used. As the mailbox is over quota, no new files are created in
23608 the &_new_& subdirectory, because no new messages are being delivered. Any
23609 change to the &_new_& subdirectory is therefore assumed to be the result of an
23610 MUA moving a new message to the &_cur_& directory when it is first read. The
23611 time that is used is therefore the last time that the user read a new message.
23612 .next
23613 For other kinds of multi-file mailbox, the time of last access cannot be
23614 obtained, so a retry rule that uses this type of error field is never matched.
23615 .endlist
23616
23617 The quota errors apply both to system-enforced quotas and to Exim's own quota
23618 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23619 when a local delivery is deferred because a partition is full (the ENOSPC
23620 error).
23621
23622
23623
23624 .section "Retry rules for specified senders" "SECID162"
23625 .cindex "retry" "rules; sender-specific"
23626 You can specify retry rules that apply only when the failing message has a
23627 specific sender. In particular, this can be used to define retry rules that
23628 apply only to bounce messages. The third item in a retry rule can be of this
23629 form:
23630 .display
23631 &`senders=`&<&'address list'&>
23632 .endd
23633 The retry timings themselves are then the fourth item. For example:
23634 .code
23635 *   rcpt_4xx   senders=:   F,1h,30m
23636 .endd
23637 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23638 host. If the address list contains white space, it must be enclosed in quotes.
23639 For example:
23640 .code
23641 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23642 .endd
23643 &*Warning*&: This facility can be unhelpful if it is used for host errors
23644 (which do not depend on the recipient). The reason is that the sender is used
23645 only to match the retry rule. Once the rule has been found for a host error,
23646 its contents are used to set a retry time for the host, and this will apply to
23647 all messages, not just those with specific senders.
23648
23649 When testing retry rules using &%-brt%&, you can supply a sender using the
23650 &%-f%& command line option, like this:
23651 .code
23652 exim -f "" -brt user@dom.ain
23653 .endd
23654 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23655 list is never matched.
23656
23657
23658
23659
23660
23661 .section "Retry parameters" "SECID163"
23662 .cindex "retry" "parameters in rules"
23663 The third (or fourth, if a senders list is present) field in a retry rule is a
23664 sequence of retry parameter sets, separated by semicolons. Each set consists of
23665 .display
23666 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23667 .endd
23668 The letter identifies the algorithm for computing a new retry time; the cutoff
23669 time is the time beyond which this algorithm no longer applies, and the
23670 arguments vary the algorithm's action. The cutoff time is measured from the
23671 time that the first failure for the domain (combined with the local part if
23672 relevant) was detected, not from the time the message was received.
23673
23674 .cindex "retry" "algorithms"
23675 .cindex "retry" "fixed intervals"
23676 .cindex "retry" "increasing intervals"
23677 .cindex "retry" "random intervals"
23678 The available algorithms are:
23679
23680 .ilist
23681 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23682 the interval.
23683 .next
23684 &'G'&: retry at geometrically increasing intervals. The first argument
23685 specifies a starting value for the interval, and the second a multiplier, which
23686 is used to increase the size of the interval at each retry.
23687 .next
23688 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23689 retry, the previous interval is multiplied by the factor in order to get a
23690 maximum for the next interval. The minimum interval is the first argument of
23691 the parameter, and an actual interval is chosen randomly between them. Such a
23692 rule has been found to be helpful in cluster configurations when all the
23693 members of the cluster restart at once, and may therefore synchronize their
23694 queue processing times.
23695 .endlist
23696
23697 When computing the next retry time, the algorithm definitions are scanned in
23698 order until one whose cutoff time has not yet passed is reached. This is then
23699 used to compute a new retry time that is later than the current time. In the
23700 case of fixed interval retries, this simply means adding the interval to the
23701 current time. For geometrically increasing intervals, retry intervals are
23702 computed from the rule's parameters until one that is greater than the previous
23703 interval is found. The main configuration variable
23704 .cindex "limit" "retry interval"
23705 .cindex "retry" "interval, maximum"
23706 .oindex "&%retry_interval_max%&"
23707 &%retry_interval_max%& limits the maximum interval between retries. It
23708 cannot be set greater than &`24h`&, which is its default value.
23709
23710 A single remote domain may have a number of hosts associated with it, and each
23711 host may have more than one IP address. Retry algorithms are selected on the
23712 basis of the domain name, but are applied to each IP address independently. If,
23713 for example, a host has two IP addresses and one is unusable, Exim will
23714 generate retry times for it and will not try to use it until its next retry
23715 time comes. Thus the good IP address is likely to be tried first most of the
23716 time.
23717
23718 .cindex "hints database" "use for retrying"
23719 Retry times are hints rather than promises. Exim does not make any attempt to
23720 run deliveries exactly at the computed times. Instead, a queue runner process
23721 starts delivery processes for delayed messages periodically, and these attempt
23722 new deliveries only for those addresses that have passed their next retry time.
23723 If a new message arrives for a deferred address, an immediate delivery attempt
23724 occurs only if the address has passed its retry time. In the absence of new
23725 messages, the minimum time between retries is the interval between queue runner
23726 processes. There is not much point in setting retry times of five minutes if
23727 your queue runners happen only once an hour, unless there are a significant
23728 number of incoming messages (which might be the case on a system that is
23729 sending everything to a smart host, for example).
23730
23731 The data in the retry hints database can be inspected by using the
23732 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23733 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23734 &'exinext'& utility script can be used to find out what the next retry times
23735 are for the hosts associated with a particular mail domain, and also for local
23736 deliveries that have been deferred.
23737
23738
23739 .section "Retry rule examples" "SECID164"
23740 Here are some example retry rules:
23741 .code
23742 alice@wonderland.fict.example quota_5d  F,7d,3h
23743 wonderland.fict.example       quota_5d
23744 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23745 lookingglass.fict.example     *         F,24h,30m;
23746 *                 refused_A   F,2h,20m;
23747 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23748 .endd
23749 The first rule sets up special handling for mail to
23750 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23751 mailbox has not been read for at least 5 days. Retries continue every three
23752 hours for 7 days. The second rule handles over-quota errors for all other local
23753 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23754 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23755 fail are bounced immediately if the mailbox has not been read for at least 5
23756 days.
23757
23758 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23759 happen every 15 minutes for an hour, then with geometrically increasing
23760 intervals until two days have passed since a delivery first failed. After the
23761 first hour there is a delay of one hour, then two hours, then four hours, and
23762 so on (this is a rather extreme example).
23763
23764 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23765 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23766 all other domains, with special action for connection refusal from hosts that
23767 were not obtained from an MX record.
23768
23769 The final rule in a retry configuration should always have asterisks in the
23770 first two fields so as to provide a general catch-all for any addresses that do
23771 not have their own special handling. This example tries every 15 minutes for 2
23772 hours, then with intervals starting at one hour and increasing by a factor of
23773 1.5 up to 16 hours, then every 8 hours up to 5 days.
23774
23775
23776
23777 .section "Timeout of retry data" "SECID165"
23778 .cindex "timeout" "of retry data"
23779 .oindex "&%retry_data_expire%&"
23780 .cindex "hints database" "data expiry"
23781 .cindex "retry" "timeout of data"
23782 Exim timestamps the data that it writes to its retry hints database. When it
23783 consults the data during a delivery it ignores any that is older than the value
23784 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23785 been tried for 7 days, Exim will try to deliver to it immediately a message
23786 arrives, and if that fails, it will calculate a retry time as if it were
23787 failing for the first time.
23788
23789 This improves the behaviour for messages routed to rarely-used hosts such as MX
23790 backups. If such a host was down at one time, and happens to be down again when
23791 Exim tries a month later, using the old retry data would imply that it had been
23792 down all the time, which is not a justified assumption.
23793
23794 If a host really is permanently dead, this behaviour causes a burst of retries
23795 every now and again, but only if messages routed to it are rare. If there is a
23796 message at least once every 7 days the retry data never expires.
23797
23798
23799
23800
23801 .section "Long-term failures" "SECID166"
23802 .cindex "delivery failure, long-term"
23803 .cindex "retry" "after long-term failure"
23804 Special processing happens when an email address has been failing for so long
23805 that the cutoff time for the last algorithm is reached. For example, using the
23806 default retry rule:
23807 .code
23808 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23809 .endd
23810 the cutoff time is four days. Reaching the retry cutoff is independent of how
23811 long any specific message has been failing; it is the length of continuous
23812 failure for the recipient address that counts.
23813
23814 When the cutoff time is reached for a local delivery, or for all the IP
23815 addresses associated with a remote delivery, a subsequent delivery failure
23816 causes Exim to give up on the address, and a bounce message is generated.
23817 In order to cater for new messages that use the failing address, a next retry
23818 time is still computed from the final algorithm, and is used as follows:
23819
23820 For local deliveries, one delivery attempt is always made for any subsequent
23821 messages. If this delivery fails, the address fails immediately. The
23822 post-cutoff retry time is not used.
23823
23824 If the delivery is remote, there are two possibilities, controlled by the
23825 .oindex "&%delay_after_cutoff%&"
23826 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23827 default. Until the post-cutoff retry time for one of the IP addresses is
23828 reached, the failing email address is bounced immediately, without a delivery
23829 attempt taking place. After that time, one new delivery attempt is made to
23830 those IP addresses that are past their retry times, and if that still fails,
23831 the address is bounced and new retry times are computed.
23832
23833 In other words, when all the hosts for a given email address have been failing
23834 for a long time, Exim bounces rather then defers until one of the hosts' retry
23835 times is reached. Then it tries once, and bounces if that attempt fails. This
23836 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23837 to a broken destination, but if the host does recover, Exim will eventually
23838 notice.
23839
23840 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23841 addresses are past their final cutoff time, Exim tries to deliver to those IP
23842 addresses that have not been tried since the message arrived. If there are
23843 no suitable IP addresses, or if they all fail, the address is bounced. In other
23844 words, it does not delay when a new message arrives, but tries the expired
23845 addresses immediately, unless they have been tried since the message arrived.
23846 If there is a continuous stream of messages for the failing domains, setting
23847 &%delay_after_cutoff%& false means that there will be many more attempts to
23848 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23849 true.
23850
23851 .section "Deliveries that work intermittently" "SECID167"
23852 .cindex "retry" "intermittently working deliveries"
23853 Some additional logic is needed to cope with cases where a host is
23854 intermittently available, or when a message has some attribute that prevents
23855 its delivery when others to the same address get through. In this situation,
23856 because some messages are successfully delivered, the &"retry clock"& for the
23857 host or address keeps getting reset by the successful deliveries, and so
23858 failing messages remain on the queue for ever because the cutoff time is never
23859 reached.
23860
23861 Two exceptional actions are applied to prevent this happening. The first
23862 applies to errors that are related to a message rather than a remote host.
23863 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23864 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23865 commands, and quota failures. For this type of error, if a message's arrival
23866 time is earlier than the &"first failed"& time for the error, the earlier time
23867 is used when scanning the retry rules to decide when to try next and when to
23868 time out the address.
23869
23870 The exceptional second action applies in all cases. If a message has been on
23871 the queue for longer than the cutoff time of any applicable retry rule for a
23872 given address, a delivery is attempted for that address, even if it is not yet
23873 time, and if this delivery fails, the address is timed out. A new retry time is
23874 not computed in this case, so that other messages for the same address are
23875 considered immediately.
23876 .ecindex IIDretconf1
23877 .ecindex IIDregconf2
23878
23879
23880
23881
23882
23883
23884 . ////////////////////////////////////////////////////////////////////////////
23885 . ////////////////////////////////////////////////////////////////////////////
23886
23887 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23888 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23889 .scindex IIDauthconf2 "authentication"
23890 The &"authenticators"& section of Exim's run time configuration is concerned
23891 with SMTP authentication. This facility is an extension to the SMTP protocol,
23892 described in RFC 2554, which allows a client SMTP host to authenticate itself
23893 to a server. This is a common way for a server to recognize clients that are
23894 permitted to use it as a relay. SMTP authentication is not of relevance to the
23895 transfer of mail between servers that have no managerial connection with each
23896 other.
23897
23898 .cindex "AUTH" "description of"
23899 Very briefly, the way SMTP authentication works is as follows:
23900
23901 .ilist
23902 The server advertises a number of authentication &'mechanisms'& in response to
23903 the client's EHLO command.
23904 .next
23905 The client issues an AUTH command, naming a specific mechanism. The command
23906 may, optionally, contain some authentication data.
23907 .next
23908 The server may issue one or more &'challenges'&, to which the client must send
23909 appropriate responses. In simple authentication mechanisms, the challenges are
23910 just prompts for user names and passwords. The server does not have to issue
23911 any challenges &-- in some mechanisms the relevant data may all be transmitted
23912 with the AUTH command.
23913 .next
23914 The server either accepts or denies authentication.
23915 .next
23916 If authentication succeeds, the client may optionally make use of the AUTH
23917 option on the MAIL command to pass an authenticated sender in subsequent
23918 mail transactions. Authentication lasts for the remainder of the SMTP
23919 connection.
23920 .next
23921 If authentication fails, the client may give up, or it may try a different
23922 authentication mechanism, or it may try transferring mail over the
23923 unauthenticated connection.
23924 .endlist
23925
23926 If you are setting up a client, and want to know which authentication
23927 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23928 SMTP port) on the server, and issue an EHLO command. The response to this
23929 includes the list of supported mechanisms. For example:
23930 .display
23931 &`$ `&&*&`telnet server.example 25`&*&
23932 &`Trying 192.168.34.25...`&
23933 &`Connected to server.example.`&
23934 &`Escape character is &#x0027;^]&#x0027;.`&
23935 &`220 server.example ESMTP Exim 4.20 ...`&
23936 &*&`ehlo client.example`&*&
23937 &`250-server.example Hello client.example [10.8.4.5]`&
23938 &`250-SIZE 52428800`&
23939 &`250-PIPELINING`&
23940 &`250-AUTH PLAIN`&
23941 &`250 HELP`&
23942 .endd
23943 The second-last line of this example output shows that the server supports
23944 authentication using the PLAIN mechanism. In Exim, the different authentication
23945 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23946 routers and transports, which authenticators are included in the binary is
23947 controlled by build-time definitions. The following are currently available,
23948 included by setting
23949 .code
23950 AUTH_CRAM_MD5=yes
23951 AUTH_CYRUS_SASL=yes
23952 AUTH_DOVECOT=yes
23953 AUTH_GSASL=yes
23954 AUTH_HEIMDAL_GSSAPI=yes
23955 AUTH_PLAINTEXT=yes
23956 AUTH_SPA=yes
23957 .endd
23958 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23959 authentication mechanism (RFC 2195), and the second provides an interface to
23960 the Cyrus SASL authentication library.
23961 The third is an interface to Dovecot's authentication system, delegating the
23962 work via a socket interface.
23963 The fourth provides an interface to the GNU SASL authentication library, which
23964 provides mechanisms but typically not data sources.
23965 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
23966 supporting setting a server keytab.
23967 The sixth can be configured to support
23968 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23969 not formally documented, but used by several MUAs. The seventh authenticator
23970 supports Microsoft's &'Secure Password Authentication'& mechanism.
23971
23972 The authenticators are configured using the same syntax as other drivers (see
23973 section &<<SECTfordricon>>&). If no authenticators are required, no
23974 authentication section need be present in the configuration file. Each
23975 authenticator can in principle have both server and client functions. When Exim
23976 is receiving SMTP mail, it is acting as a server; when it is sending out
23977 messages over SMTP, it is acting as a client. Authenticator configuration
23978 options are provided for use in both these circumstances.
23979
23980 To make it clear which options apply to which situation, the prefixes
23981 &%server_%& and &%client_%& are used on option names that are specific to
23982 either the server or the client function, respectively. Server and client
23983 functions are disabled if none of their options are set. If an authenticator is
23984 to be used for both server and client functions, a single definition, using
23985 both sets of options, is required. For example:
23986 .code
23987 cram:
23988   driver = cram_md5
23989   public_name = CRAM-MD5
23990   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23991   client_name = ph10
23992   client_secret = secret2
23993 .endd
23994 The &%server_%& option is used when Exim is acting as a server, and the
23995 &%client_%& options when it is acting as a client.
23996
23997 Descriptions of the individual authenticators are given in subsequent chapters.
23998 The remainder of this chapter covers the generic options for the
23999 authenticators, followed by general discussion of the way authentication works
24000 in Exim.
24001
24002 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24003 per-mechanism basis.  Please read carefully to determine which variables hold
24004 account labels such as usercodes and which hold passwords or other
24005 authenticating data.
24006
24007 Note that some mechanisms support two different identifiers for accounts: the
24008 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24009 and &'authz'& are commonly encountered.  The American spelling is standard here.
24010 Conceptually, authentication data such as passwords are tied to the identifier
24011 used to authenticate; servers may have rules to permit one user to act as a
24012 second user, so that after login the session is treated as though that second
24013 user had logged in.  That second user is the &'authorization id'&.  A robust
24014 configuration might confirm that the &'authz'& field is empty or matches the
24015 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24016 as verified data, the &'authz'& as an unverified request which the server might
24017 choose to honour.
24018
24019 A &'realm'& is a text string, typically a domain name, presented by a server
24020 to a client to help it select an account and credentials to use.  In some
24021 mechanisms, the client and server provably agree on the realm, but clients
24022 typically can not treat the realm as secure data to be blindly trusted.
24023
24024
24025
24026 .section "Generic options for authenticators" "SECID168"
24027 .cindex "authentication" "generic options"
24028 .cindex "options" "generic; for authenticators"
24029
24030 .option client_condition authenticators string&!! unset
24031 When Exim is authenticating as a client, it skips any authenticator whose
24032 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24033 used, for example, to skip plain text authenticators when the connection is not
24034 encrypted by a setting such as:
24035 .code
24036 client_condition = ${if !eq{$tls_out_cipher}{}}
24037 .endd
24038
24039
24040 .option driver authenticators string unset
24041 This option must always be set. It specifies which of the available
24042 authenticators is to be used.
24043
24044
24045 .option public_name authenticators string unset
24046 This option specifies the name of the authentication mechanism that the driver
24047 implements, and by which it is known to the outside world. These names should
24048 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24049 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24050 defaults to the driver's instance name.
24051
24052
24053 .option server_advertise_condition authenticators string&!! unset
24054 When a server is about to advertise an authentication mechanism, the condition
24055 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24056 mechanism is not advertised.
24057 If the expansion fails, the mechanism is not advertised. If the failure was not
24058 forced, and was not caused by a lookup defer, the incident is logged.
24059 See section &<<SECTauthexiser>>& below for further discussion.
24060
24061
24062 .option server_condition authenticators string&!! unset
24063 This option must be set for a &%plaintext%& server authenticator, where it
24064 is used directly to control authentication. See section &<<SECTplainserver>>&
24065 for details.
24066
24067 For the &(gsasl)& authenticator, this option is required for various
24068 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24069
24070 For the other authenticators, &%server_condition%& can be used as an additional
24071 authentication or authorization mechanism that is applied after the other
24072 authenticator conditions succeed. If it is set, it is expanded when the
24073 authenticator would otherwise return a success code. If the expansion is forced
24074 to fail, authentication fails. Any other expansion failure causes a temporary
24075 error code to be returned. If the result of a successful expansion is an empty
24076 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24077 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24078 other result, a temporary error code is returned, with the expanded string as
24079 the error text.
24080
24081
24082 .option server_debug_print authenticators string&!! unset
24083 If this option is set and authentication debugging is enabled (see the &%-d%&
24084 command line option), the string is expanded and included in the debugging
24085 output when the authenticator is run as a server. This can help with checking
24086 out the values of variables.
24087 If expansion of the string fails, the error message is written to the debugging
24088 output, and Exim carries on processing.
24089
24090
24091 .option server_set_id authenticators string&!! unset
24092 .vindex "&$authenticated_id$&"
24093 When an Exim server successfully authenticates a client, this string is
24094 expanded using data from the authentication, and preserved for any incoming
24095 messages in the variable &$authenticated_id$&. It is also included in the log
24096 lines for incoming messages. For example, a user/password authenticator
24097 configuration might preserve the user name that was used to authenticate, and
24098 refer to it subsequently during delivery of the message.
24099 If expansion fails, the option is ignored.
24100
24101
24102 .option server_mail_auth_condition authenticators string&!! unset
24103 This option allows a server to discard authenticated sender addresses supplied
24104 as part of MAIL commands in SMTP connections that are authenticated by the
24105 driver on which &%server_mail_auth_condition%& is set. The option is not used
24106 as part of the authentication process; instead its (unexpanded) value is
24107 remembered for later use.
24108 How it is used is described in the following section.
24109
24110
24111
24112
24113
24114 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24115 .cindex "authentication" "sender; authenticated"
24116 .cindex "AUTH" "on MAIL command"
24117 When a client supplied an AUTH= item on a MAIL command, Exim applies
24118 the following checks before accepting it as the authenticated sender of the
24119 message:
24120
24121 .ilist
24122 If the connection is not using extended SMTP (that is, HELO was used rather
24123 than EHLO), the use of AUTH= is a syntax error.
24124 .next
24125 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24126 .next
24127 .vindex "&$authenticated_sender$&"
24128 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24129 running, the value of &$authenticated_sender$& is set to the value obtained
24130 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24131 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24132 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24133 given for the MAIL command.
24134 .next
24135 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24136 is accepted and placed in &$authenticated_sender$& only if the client has
24137 authenticated.
24138 .next
24139 If the AUTH= value was accepted by either of the two previous rules, and
24140 the client has authenticated, and the authenticator has a setting for the
24141 &%server_mail_auth_condition%&, the condition is checked at this point. The
24142 valued that was saved from the authenticator is expanded. If the expansion
24143 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24144 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24145 the value of &$authenticated_sender$& is retained and passed on with the
24146 message.
24147 .endlist
24148
24149
24150 When &$authenticated_sender$& is set for a message, it is passed on to other
24151 hosts to which Exim authenticates as a client. Do not confuse this value with
24152 &$authenticated_id$&, which is a string obtained from the authentication
24153 process, and which is not usually a complete email address.
24154
24155 .vindex "&$sender_address$&"
24156 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24157 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24158 therefore make use of &$authenticated_sender$&. The converse is not true: the
24159 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24160 ACL is run.
24161
24162
24163
24164 .section "Authentication on an Exim server" "SECTauthexiser"
24165 .cindex "authentication" "on an Exim server"
24166 When Exim receives an EHLO command, it advertises the public names of those
24167 authenticators that are configured as servers, subject to the following
24168 conditions:
24169
24170 .ilist
24171 The client host must match &%auth_advertise_hosts%& (default *).
24172 .next
24173 It the &%server_advertise_condition%& option is set, its expansion must not
24174 yield the empty string, &"0"&, &"no"&, or &"false"&.
24175 .endlist
24176
24177 The order in which the authenticators are defined controls the order in which
24178 the mechanisms are advertised.
24179
24180 Some mail clients (for example, some versions of Netscape) require the user to
24181 provide a name and password for authentication whenever AUTH is advertised,
24182 even though authentication may not in fact be needed (for example, Exim may be
24183 set up to allow unconditional relaying from the client by an IP address check).
24184 You can make such clients more friendly by not advertising AUTH to them.
24185 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24186 that runs for RCPT) to relay without authentication, you should set
24187 .code
24188 auth_advertise_hosts = ! 10.9.8.0/24
24189 .endd
24190 so that no authentication mechanisms are advertised to them.
24191
24192 The &%server_advertise_condition%& controls the advertisement of individual
24193 authentication mechanisms. For example, it can be used to restrict the
24194 advertisement of a particular mechanism to encrypted connections, by a setting
24195 such as:
24196 .code
24197 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24198 .endd
24199 .vindex "&$tls_in_cipher$&"
24200 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24201 yields &"yes"&, which allows the advertisement to happen.
24202
24203 When an Exim server receives an AUTH command from a client, it rejects it
24204 immediately if AUTH was not advertised in response to an earlier EHLO
24205 command. This is the case if
24206
24207 .ilist
24208 The client host does not match &%auth_advertise_hosts%&; or
24209 .next
24210 No authenticators are configured with server options; or
24211 .next
24212 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24213 server authenticators.
24214 .endlist
24215
24216
24217 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24218 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24219 AUTH is accepted from any client host.
24220
24221 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24222 server authentication mechanism that was advertised in response to EHLO and
24223 that matches the one named in the AUTH command. If it finds one, it runs
24224 the appropriate authentication protocol, and authentication either succeeds or
24225 fails. If there is no matching advertised mechanism, the AUTH command is
24226 rejected with a 504 error.
24227
24228 .vindex "&$received_protocol$&"
24229 .vindex "&$sender_host_authenticated$&"
24230 When a message is received from an authenticated host, the value of
24231 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24232 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24233 public name) of the authenticator driver that successfully authenticated the
24234 client from which the message was received. This variable is empty if there was
24235 no successful authentication.
24236
24237
24238
24239
24240 .section "Testing server authentication" "SECID169"
24241 .cindex "authentication" "testing a server"
24242 .cindex "AUTH" "testing a server"
24243 .cindex "base64 encoding" "creating authentication test data"
24244 Exim's &%-bh%& option can be useful for testing server authentication
24245 configurations. The data for the AUTH command has to be sent using base64
24246 encoding. A quick way to produce such data for testing is the following Perl
24247 script:
24248 .code
24249 use MIME::Base64;
24250 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24251 .endd
24252 .cindex "binary zero" "in authentication data"
24253 This interprets its argument as a Perl string, and then encodes it. The
24254 interpretation as a Perl string allows binary zeros, which are required for
24255 some kinds of authentication, to be included in the data. For example, a
24256 command line to run this script on such data might be
24257 .code
24258 encode '\0user\0password'
24259 .endd
24260 Note the use of single quotes to prevent the shell interpreting the
24261 backslashes, so that they can be interpreted by Perl to specify characters
24262 whose code value is zero.
24263
24264 &*Warning 1*&: If either of the user or password strings starts with an octal
24265 digit, you must use three zeros instead of one after the leading backslash. If
24266 you do not, the octal digit that starts your string will be incorrectly
24267 interpreted as part of the code for the first character.
24268
24269 &*Warning 2*&: If there are characters in the strings that Perl interprets
24270 specially, you must use a Perl escape to prevent them being misinterpreted. For
24271 example, a command such as
24272 .code
24273 encode '\0user@domain.com\0pas$$word'
24274 .endd
24275 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24276
24277 If you have the &%mimencode%& command installed, another way to do produce
24278 base64-encoded strings is to run the command
24279 .code
24280 echo -e -n `\0user\0password' | mimencode
24281 .endd
24282 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24283 in the argument, and the &%-n%& option specifies no newline at the end of its
24284 output. However, not all versions of &%echo%& recognize these options, so you
24285 should check your version before relying on this suggestion.
24286
24287
24288
24289 .section "Authentication by an Exim client" "SECID170"
24290 .cindex "authentication" "on an Exim client"
24291 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24292 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24293 announces support for authentication, and the host matches an entry in either
24294 of these options, Exim (as a client) tries to authenticate as follows:
24295
24296 .ilist
24297 For each authenticator that is configured as a client, in the order in which
24298 they are defined in the configuration, it searches the authentication
24299 mechanisms announced by the server for one whose name matches the public name
24300 of the authenticator.
24301 .next
24302 .vindex "&$host$&"
24303 .vindex "&$host_address$&"
24304 When it finds one that matches, it runs the authenticator's client code. The
24305 variables &$host$& and &$host_address$& are available for any string expansions
24306 that the client might do. They are set to the server's name and IP address. If
24307 any expansion is forced to fail, the authentication attempt is abandoned, and
24308 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24309 delivery to be deferred.
24310 .next
24311 If the result of the authentication attempt is a temporary error or a timeout,
24312 Exim abandons trying to send the message to the host for the moment. It will
24313 try again later. If there are any backup hosts available, they are tried in the
24314 usual way.
24315 .next
24316 If the response to authentication is a permanent error (5&'xx'& code), Exim
24317 carries on searching the list of authenticators and tries another one if
24318 possible. If all authentication attempts give permanent errors, or if there are
24319 no attempts because no mechanisms match (or option expansions force failure),
24320 what happens depends on whether the host matches &%hosts_require_auth%& or
24321 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24322 delivery is deferred. The error can be detected in the retry rules, and thereby
24323 turned into a permanent error if you wish. In the second case, Exim tries to
24324 deliver the message unauthenticated.
24325 .endlist
24326
24327 .cindex "AUTH" "on MAIL command"
24328 When Exim has authenticated itself to a remote server, it adds the AUTH
24329 parameter to the MAIL commands it sends, if it has an authenticated sender for
24330 the message. If the message came from a remote host, the authenticated sender
24331 is the one that was receiving on an incoming MAIL command, provided that the
24332 incoming connection was authenticated and the &%server_mail_auth%& condition
24333 allowed the authenticated sender to be retained. If a local process calls Exim
24334 to send a message, the sender address that is built from the login name and
24335 &%qualify_domain%& is treated as authenticated. However, if the
24336 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24337 the authenticated sender that was received with the message.
24338 .ecindex IIDauthconf1
24339 .ecindex IIDauthconf2
24340
24341
24342
24343
24344
24345
24346 . ////////////////////////////////////////////////////////////////////////////
24347 . ////////////////////////////////////////////////////////////////////////////
24348
24349 .chapter "The plaintext authenticator" "CHAPplaintext"
24350 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24351 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24352 The &(plaintext)& authenticator can be configured to support the PLAIN and
24353 LOGIN authentication mechanisms, both of which transfer authentication data as
24354 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24355 security risk; you are strongly advised to insist on the use of SMTP encryption
24356 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24357 use unencrypted plain text, you should not use the same passwords for SMTP
24358 connections as you do for login accounts.
24359
24360 .section "Plaintext options" "SECID171"
24361 .cindex "options" "&(plaintext)& authenticator (server)"
24362 When configured as a server, &(plaintext)& uses the following options:
24363
24364 .option server_condition authenticators string&!! unset
24365 This is actually a global authentication option, but it must be set in order to
24366 configure the &(plaintext)& driver as a server. Its use is described below.
24367
24368 .option server_prompts plaintext string&!! unset
24369 The contents of this option, after expansion, must be a colon-separated list of
24370 prompt strings. If expansion fails, a temporary authentication rejection is
24371 given.
24372
24373 .section "Using plaintext in a server" "SECTplainserver"
24374 .cindex "AUTH" "in &(plaintext)& authenticator"
24375 .cindex "binary zero" "in &(plaintext)& authenticator"
24376 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24377         "in &(plaintext)& authenticator"
24378 .vindex "&$auth1$&, &$auth2$&, etc"
24379 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24380
24381 When running as a server, &(plaintext)& performs the authentication test by
24382 expanding a string. The data sent by the client with the AUTH command, or in
24383 response to subsequent prompts, is base64 encoded, and so may contain any byte
24384 values when decoded. If any data is supplied with the command, it is treated as
24385 a list of strings, separated by NULs (binary zeros), the first three of which
24386 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24387 (neither LOGIN nor PLAIN uses more than three strings).
24388
24389 For compatibility with previous releases of Exim, the values are also placed in
24390 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24391 variables for this purpose is now deprecated, as it can lead to confusion in
24392 string expansions that also use them for other things.
24393
24394 If there are more strings in &%server_prompts%& than the number of strings
24395 supplied with the AUTH command, the remaining prompts are used to obtain more
24396 data. Each response from the client may be a list of NUL-separated strings.
24397
24398 .vindex "&$authenticated_id$&"
24399 Once a sufficient number of data strings have been received,
24400 &%server_condition%& is expanded. If the expansion is forced to fail,
24401 authentication fails. Any other expansion failure causes a temporary error code
24402 to be returned. If the result of a successful expansion is an empty string,
24403 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24404 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24405 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24406 For any other result, a temporary error code is returned, with the expanded
24407 string as the error text.
24408
24409 &*Warning*&: If you use a lookup in the expansion to find the user's
24410 password, be sure to make the authentication fail if the user is unknown.
24411 There are good and bad examples at the end of the next section.
24412
24413
24414
24415 .section "The PLAIN authentication mechanism" "SECID172"
24416 .cindex "PLAIN authentication mechanism"
24417 .cindex "authentication" "PLAIN mechanism"
24418 .cindex "binary zero" "in &(plaintext)& authenticator"
24419 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24420 sent as one item of data (that is, one combined string containing two NUL
24421 separators). The data is sent either as part of the AUTH command, or
24422 subsequently in response to an empty prompt from the server.
24423
24424 The second and third strings are a user name and a corresponding password.
24425 Using a single fixed user name and password as an example, this could be
24426 configured as follows:
24427 .code
24428 fixed_plain:
24429   driver = plaintext
24430   public_name = PLAIN
24431   server_prompts = :
24432   server_condition = \
24433     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24434   server_set_id = $auth2
24435 .endd
24436 Note that the default result strings from &%if%& (&"true"& or an empty string)
24437 are exactly what we want here, so they need not be specified. Obviously, if the
24438 password contains expansion-significant characters such as dollar, backslash,
24439 or closing brace, they have to be escaped.
24440
24441 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24442 the end of a string list are ignored). If all the data comes as part of the
24443 AUTH command, as is commonly the case, the prompt is not used. This
24444 authenticator is advertised in the response to EHLO as
24445 .code
24446 250-AUTH PLAIN
24447 .endd
24448 and a client host can authenticate itself by sending the command
24449 .code
24450 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24451 .endd
24452 As this contains three strings (more than the number of prompts), no further
24453 data is required from the client. Alternatively, the client may just send
24454 .code
24455 AUTH PLAIN
24456 .endd
24457 to initiate authentication, in which case the server replies with an empty
24458 prompt. The client must respond with the combined data string.
24459
24460 The data string is base64 encoded, as required by the RFC. This example,
24461 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24462 represents a zero byte. This is split up into three strings, the first of which
24463 is empty. The &%server_condition%& option in the authenticator checks that the
24464 second two are &`username`& and &`mysecret`& respectively.
24465
24466 Having just one fixed user name and password, as in this example, is not very
24467 realistic, though for a small organization with only a handful of
24468 authenticating clients it could make sense.
24469
24470 A more sophisticated instance of this authenticator could use the user name in
24471 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24472 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24473 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24474 This is an incorrect example:
24475 .code
24476 server_condition = \
24477   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24478 .endd
24479 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24480 which it then compares to the supplied password (&$auth3$&). Why is this example
24481 incorrect? It works fine for existing users, but consider what happens if a
24482 non-existent user name is given. The lookup fails, but as no success/failure
24483 strings are given for the lookup, it yields an empty string. Thus, to defeat
24484 the authentication, all a client has to do is to supply a non-existent user
24485 name and an empty password. The correct way of writing this test is:
24486 .code
24487 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24488   {${if eq{$value}{$auth3}}} {false}}
24489 .endd
24490 In this case, if the lookup succeeds, the result is checked; if the lookup
24491 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24492 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24493 always fails if its second argument is empty. However, the second way of
24494 writing the test makes the logic clearer.
24495
24496
24497 .section "The LOGIN authentication mechanism" "SECID173"
24498 .cindex "LOGIN authentication mechanism"
24499 .cindex "authentication" "LOGIN mechanism"
24500 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24501 in a number of programs. No data is sent with the AUTH command. Instead, a
24502 user name and password are supplied separately, in response to prompts. The
24503 plaintext authenticator can be configured to support this as in this example:
24504 .code
24505 fixed_login:
24506   driver = plaintext
24507   public_name = LOGIN
24508   server_prompts = User Name : Password
24509   server_condition = \
24510     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24511   server_set_id = $auth1
24512 .endd
24513 Because of the way plaintext operates, this authenticator accepts data supplied
24514 with the AUTH command (in contravention of the specification of LOGIN), but
24515 if the client does not supply it (as is the case for LOGIN clients), the prompt
24516 strings are used to obtain two data items.
24517
24518 Some clients are very particular about the precise text of the prompts. For
24519 example, Outlook Express is reported to recognize only &"Username:"& and
24520 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24521 strings. It uses the &%ldapauth%& expansion condition to check the user
24522 name and password by binding to an LDAP server:
24523 .code
24524 login:
24525   driver = plaintext
24526   public_name = LOGIN
24527   server_prompts = Username:: : Password::
24528   server_condition = ${if and{{ \
24529     !eq{}{$auth1} }{ \
24530     ldapauth{\
24531       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24532       pass=${quote:$auth2} \
24533       ldap://ldap.example.org/} }} }
24534   server_set_id = uid=$auth1,ou=people,o=example.org
24535 .endd
24536 We have to check that the username is not empty before using it, because LDAP
24537 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24538 operator to correctly quote the DN for authentication. However, the basic
24539 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24540 correct one to use for the password, because quoting is needed only to make
24541 the password conform to the Exim syntax. At the LDAP level, the password is an
24542 uninterpreted string.
24543
24544
24545 .section "Support for different kinds of authentication" "SECID174"
24546 A number of string expansion features are provided for the purpose of
24547 interfacing to different ways of user authentication. These include checking
24548 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24549 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24550 &<<SECTexpcond>>&.
24551
24552
24553
24554
24555 .section "Using plaintext in a client" "SECID175"
24556 .cindex "options" "&(plaintext)& authenticator (client)"
24557 The &(plaintext)& authenticator has two client options:
24558
24559 .option client_ignore_invalid_base64 plaintext boolean false
24560 If the client receives a server prompt that is not a valid base64 string,
24561 authentication is abandoned by default. However, if this option is set true,
24562 the error in the challenge is ignored and the client sends the response as
24563 usual.
24564
24565 .option client_send plaintext string&!! unset
24566 The string is a colon-separated list of authentication data strings. Each
24567 string is independently expanded before being sent to the server. The first
24568 string is sent with the AUTH command; any more strings are sent in response
24569 to prompts from the server. Before each string is expanded, the value of the
24570 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24571 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24572 way. Thus, the prompt that is received in response to sending the first string
24573 (with the AUTH command) can be used in the expansion of the second string, and
24574 so on. If an invalid base64 string is received when
24575 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24576 &$auth$&<&'n'&> variable.
24577
24578 &*Note*&: You cannot use expansion to create multiple strings, because
24579 splitting takes priority and happens first.
24580
24581 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24582 the data, further processing is applied to each string before it is sent. If
24583 there are any single circumflex characters in the string, they are converted to
24584 NULs. Should an actual circumflex be required as data, it must be doubled in
24585 the string.
24586
24587 This is an example of a client configuration that implements the PLAIN
24588 authentication mechanism with a fixed user name and password:
24589 .code
24590 fixed_plain:
24591   driver = plaintext
24592   public_name = PLAIN
24593   client_send = ^username^mysecret
24594 .endd
24595 The lack of colons means that the entire text is sent with the AUTH
24596 command, with the circumflex characters converted to NULs. A similar example
24597 that uses the LOGIN mechanism is:
24598 .code
24599 fixed_login:
24600   driver = plaintext
24601   public_name = LOGIN
24602   client_send = : username : mysecret
24603 .endd
24604 The initial colon means that the first string is empty, so no data is sent with
24605 the AUTH command itself. The remaining strings are sent in response to
24606 prompts.
24607 .ecindex IIDplaiauth1
24608 .ecindex IIDplaiauth2
24609
24610
24611
24612
24613 . ////////////////////////////////////////////////////////////////////////////
24614 . ////////////////////////////////////////////////////////////////////////////
24615
24616 .chapter "The cram_md5 authenticator" "CHID9"
24617 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24618 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24619 .cindex "CRAM-MD5 authentication mechanism"
24620 .cindex "authentication" "CRAM-MD5 mechanism"
24621 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24622 sends a challenge string to the client, and the response consists of a user
24623 name and the CRAM-MD5 digest of the challenge string combined with a secret
24624 string (password) which is known to both server and client. Thus, the secret
24625 is not sent over the network as plain text, which makes this authenticator more
24626 secure than &(plaintext)&. However, the downside is that the secret has to be
24627 available in plain text at either end.
24628
24629
24630 .section "Using cram_md5 as a server" "SECID176"
24631 .cindex "options" "&(cram_md5)& authenticator (server)"
24632 This authenticator has one server option, which must be set to configure the
24633 authenticator as a server:
24634
24635 .option server_secret cram_md5 string&!! unset
24636 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24637 When the server receives the client's response, the user name is placed in
24638 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24639 obtain the password for that user. The server then computes the CRAM-MD5 digest
24640 that the client should have sent, and checks that it received the correct
24641 string. If the expansion of &%server_secret%& is forced to fail, authentication
24642 fails. If the expansion fails for some other reason, a temporary error code is
24643 returned to the client.
24644
24645 For compatibility with previous releases of Exim, the user name is also placed
24646 in &$1$&. However, the use of this variables for this purpose is now
24647 deprecated, as it can lead to confusion in string expansions that also use
24648 numeric variables for other things.
24649
24650 For example, the following authenticator checks that the user name given by the
24651 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24652 user name, authentication fails.
24653 .code
24654 fixed_cram:
24655   driver = cram_md5
24656   public_name = CRAM-MD5
24657   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24658   server_set_id = $auth1
24659 .endd
24660 .vindex "&$authenticated_id$&"
24661 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24662 name in &$authenticated_id$&. A more typical configuration might look up the
24663 secret string in a file, using the user name as the key. For example:
24664 .code
24665 lookup_cram:
24666   driver = cram_md5
24667   public_name = CRAM-MD5
24668   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24669                   {$value}fail}
24670   server_set_id = $auth1
24671 .endd
24672 Note that this expansion explicitly forces failure if the lookup fails
24673 because &$auth1$& contains an unknown user name.
24674
24675 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24676 using the relevant libraries, you need to know the realm to specify in the
24677 lookup and then ask for the &"userPassword"& attribute for that user in that
24678 realm, with:
24679 .code
24680 cyrusless_crammd5:
24681   driver = cram_md5
24682   public_name = CRAM-MD5
24683   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24684                   dbmjz{/etc/sasldb2}}
24685   server_set_id = $auth1
24686 .endd
24687
24688 .section "Using cram_md5 as a client" "SECID177"
24689 .cindex "options" "&(cram_md5)& authenticator (client)"
24690 When used as a client, the &(cram_md5)& authenticator has two options:
24691
24692
24693
24694 .option client_name cram_md5 string&!! "the primary host name"
24695 This string is expanded, and the result used as the user name data when
24696 computing the response to the server's challenge.
24697
24698
24699 .option client_secret cram_md5 string&!! unset
24700 This option must be set for the authenticator to work as a client. Its value is
24701 expanded and the result used as the secret string when computing the response.
24702
24703
24704 .vindex "&$host$&"
24705 .vindex "&$host_address$&"
24706 Different user names and secrets can be used for different servers by referring
24707 to &$host$& or &$host_address$& in the options. Forced failure of either
24708 expansion string is treated as an indication that this authenticator is not
24709 prepared to handle this case. Exim moves on to the next configured client
24710 authenticator. Any other expansion failure causes Exim to give up trying to
24711 send the message to the current server.
24712
24713 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24714 strings, is:
24715 .code
24716 fixed_cram:
24717   driver = cram_md5
24718   public_name = CRAM-MD5
24719   client_name = ph10
24720   client_secret = secret
24721 .endd
24722 .ecindex IIDcramauth1
24723 .ecindex IIDcramauth2
24724
24725
24726
24727 . ////////////////////////////////////////////////////////////////////////////
24728 . ////////////////////////////////////////////////////////////////////////////
24729
24730 .chapter "The cyrus_sasl authenticator" "CHID10"
24731 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24732 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24733 .cindex "Cyrus" "SASL library"
24734 .cindex "Kerberos"
24735 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24736 Digital Ltd (&url(http://www.aldigital.co.uk)).
24737
24738 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24739 library implementation of the RFC 2222 (&"Simple Authentication and Security
24740 Layer"&). This library supports a number of authentication mechanisms,
24741 including PLAIN and LOGIN, but also several others that Exim does not support
24742 directly. In particular, there is support for Kerberos authentication.
24743
24744 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24745 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24746 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24747 name of the driver to determine which mechanism to support.
24748
24749 Where access to some kind of secret file is required, for example in GSSAPI
24750 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24751 user, and that the Cyrus SASL library has no way of escalating privileges
24752 by default. You may also find you need to set environment variables,
24753 depending on the driver you are using.
24754
24755 The application name provided by Exim is &"exim"&, so various SASL options may
24756 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24757 Kerberos, note that because of limitations in the GSSAPI interface,
24758 changing the server keytab might need to be communicated down to the Kerberos
24759 layer independently. The mechanism for doing so is dependent upon the Kerberos
24760 implementation.
24761
24762 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
24763 may be set to point to an alternative keytab file. Exim will pass this
24764 variable through from its own inherited environment when started as root or the
24765 Exim user. The keytab file needs to be readable by the Exim user.
24766 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
24767 environment variable.  In practice, for those releases, the Cyrus authenticator
24768 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
24769 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
24770
24771
24772 .section "Using cyrus_sasl as a server" "SECID178"
24773 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24774 (on a successful authentication) into &$auth1$&. For compatibility with
24775 previous releases of Exim, the username is also placed in &$1$&. However, the
24776 use of this variable for this purpose is now deprecated, as it can lead to
24777 confusion in string expansions that also use numeric variables for other
24778 things.
24779
24780
24781 .option server_hostname cyrus_sasl string&!! "see below"
24782 This option selects the hostname that is used when communicating with the
24783 library. The default value is &`$primary_hostname`&. It is up to the underlying
24784 SASL plug-in what it does with this data.
24785
24786
24787 .option server_mech cyrus_sasl string "see below"
24788 This option selects the authentication mechanism this driver should use. The
24789 default is the value of the generic &%public_name%& option. This option allows
24790 you to use a different underlying mechanism from the advertised name. For
24791 example:
24792 .code
24793 sasl:
24794   driver = cyrus_sasl
24795   public_name = X-ANYTHING
24796   server_mech = CRAM-MD5
24797   server_set_id = $auth1
24798 .endd
24799
24800 .option server_realm cyrus_sasl string&!! unset
24801 This specifies the SASL realm that the server claims to be in.
24802
24803
24804 .option server_service cyrus_sasl string &`smtp`&
24805 This is the SASL service that the server claims to implement.
24806
24807
24808 For straightforward cases, you do not need to set any of the authenticator's
24809 private options. All you need to do is to specify an appropriate mechanism as
24810 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24811 PLAIN, you could have two authenticators as follows:
24812 .code
24813 sasl_cram_md5:
24814   driver = cyrus_sasl
24815   public_name = CRAM-MD5
24816   server_set_id = $auth1
24817
24818 sasl_plain:
24819   driver = cyrus_sasl
24820   public_name = PLAIN
24821   server_set_id = $auth2
24822 .endd
24823 Cyrus SASL does implement the LOGIN authentication method, even though it is
24824 not a standard method. It is disabled by default in the source distribution,
24825 but it is present in many binary distributions.
24826 .ecindex IIDcyrauth1
24827 .ecindex IIDcyrauth2
24828
24829
24830
24831
24832 . ////////////////////////////////////////////////////////////////////////////
24833 . ////////////////////////////////////////////////////////////////////////////
24834 .chapter "The dovecot authenticator" "CHAPdovecot"
24835 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24836 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24837 This authenticator is an interface to the authentication facility of the
24838 Dovecot POP/IMAP server, which can support a number of authentication methods.
24839 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24840 to use the same mechanisms for SMTP authentication. This is a server
24841 authenticator only. There is only one option:
24842
24843 .option server_socket dovecot string unset
24844
24845 This option must specify the socket that is the interface to Dovecot
24846 authentication. The &%public_name%& option must specify an authentication
24847 mechanism that Dovecot is configured to support. You can have several
24848 authenticators for different mechanisms. For example:
24849 .code
24850 dovecot_plain:
24851   driver = dovecot
24852   public_name = PLAIN
24853   server_socket = /var/run/dovecot/auth-client
24854   server_set_id = $auth2
24855
24856 dovecot_ntlm:
24857   driver = dovecot
24858   public_name = NTLM
24859   server_socket = /var/run/dovecot/auth-client
24860   server_set_id = $auth1
24861 .endd
24862 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24863 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24864 option is passed in the Dovecot authentication command. If, for a TLS
24865 connection, a client certificate has been verified, the &"valid-client-cert"&
24866 option is passed. When authentication succeeds, the identity of the user
24867 who authenticated is placed in &$auth1$&.
24868 .ecindex IIDdcotauth1
24869 .ecindex IIDdcotauth2
24870
24871
24872 . ////////////////////////////////////////////////////////////////////////////
24873 . ////////////////////////////////////////////////////////////////////////////
24874 .chapter "The gsasl authenticator" "CHAPgsasl"
24875 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
24876 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
24877 .cindex "authentication" "GNU SASL"
24878 .cindex "authentication" "SASL"
24879 .cindex "authentication" "EXTERNAL"
24880 .cindex "authentication" "ANONYMOUS"
24881 .cindex "authentication" "PLAIN"
24882 .cindex "authentication" "LOGIN"
24883 .cindex "authentication" "DIGEST-MD5"
24884 .cindex "authentication" "CRAM-MD5"
24885 .cindex "authentication" "SCRAM-SHA-1"
24886 The &(gsasl)& authenticator provides server integration for the GNU SASL
24887 library and the mechanisms it provides.  This is new as of the 4.80 release
24888 and there are a few areas where the library does not let Exim smoothly
24889 scale to handle future authentication mechanisms, so no guarantee can be
24890 made that any particular new authentication mechanism will be supported
24891 without code changes in Exim.
24892
24893
24894 .option server_channelbinding gsasl boolean false
24895 Some authentication mechanisms are able to use external context at both ends
24896 of the session to bind the authentication to that context, and fail the
24897 authentication process if that context differs.  Specifically, some TLS
24898 ciphersuites can provide identifying information about the cryptographic
24899 context.
24900
24901 This means that certificate identity and verification becomes a non-issue,
24902 as a man-in-the-middle attack will cause the correct client and server to
24903 see different identifiers and authentication will fail.
24904
24905 This is currently only supported when using the GnuTLS library.  This is
24906 only usable by mechanisms which support "channel binding"; at time of
24907 writing, that's the SCRAM family.
24908
24909 This defaults off to ensure smooth upgrade across Exim releases, in case
24910 this option causes some clients to start failing.  Some future release
24911 of Exim may switch the default to be true.
24912
24913
24914 .option server_hostname gsasl string&!! "see below"
24915 This option selects the hostname that is used when communicating with the
24916 library. The default value is &`$primary_hostname`&.
24917 Some mechanisms will use this data.
24918
24919
24920 .option server_mech gsasl string "see below"
24921 This option selects the authentication mechanism this driver should use. The
24922 default is the value of the generic &%public_name%& option. This option allows
24923 you to use a different underlying mechanism from the advertised name. For
24924 example:
24925 .code
24926 sasl:
24927   driver = gsasl
24928   public_name = X-ANYTHING
24929   server_mech = CRAM-MD5
24930   server_set_id = $auth1
24931 .endd
24932
24933
24934 .option server_password gsasl string&!! unset
24935 Various mechanisms need access to the cleartext password on the server, so
24936 that proof-of-possession can be demonstrated on the wire, without sending
24937 the password itself.
24938
24939 The data available for lookup varies per mechanism.
24940 In all cases, &$auth1$& is set to the &'authentication id'&.
24941 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
24942 if available, else the empty string.
24943 The &$auth3$& variable will always be the &'realm'& if available,
24944 else the empty string.
24945
24946 A forced failure will cause authentication to defer.
24947
24948 If using this option, it may make sense to set the &%server_condition%&
24949 option to be simply "true".
24950
24951
24952 .option server_realm gsasl string&!! unset
24953 This specifies the SASL realm that the server claims to be in.
24954 Some mechanisms will use this data.
24955
24956
24957 .option server_scram_iter gsasl string&!! unset
24958 This option provides data for the SCRAM family of mechanisms.
24959 &$auth1$& is not available at evaluation time.
24960 (This may change, as we receive feedback on use)
24961
24962
24963 .option server_scram_salt gsasl string&!! unset
24964 This option provides data for the SCRAM family of mechanisms.
24965 &$auth1$& is not available at evaluation time.
24966 (This may change, as we receive feedback on use)
24967
24968
24969 .option server_service gsasl string &`smtp`&
24970 This is the SASL service that the server claims to implement.
24971 Some mechanisms will use this data.
24972
24973
24974 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
24975 .vindex "&$auth1$&, &$auth2$&, etc"
24976 These may be set when evaluating specific options, as detailed above.
24977 They will also be set when evaluating &%server_condition%&.
24978
24979 Unless otherwise stated below, the &(gsasl)& integration will use the following
24980 meanings for these variables:
24981
24982 .ilist
24983 .vindex "&$auth1$&"
24984 &$auth1$&: the &'authentication id'&
24985 .next
24986 .vindex "&$auth2$&"
24987 &$auth2$&: the &'authorization id'&
24988 .next
24989 .vindex "&$auth3$&"
24990 &$auth3$&: the &'realm'&
24991 .endlist
24992
24993 On a per-mechanism basis:
24994
24995 .ilist
24996 .cindex "authentication" "EXTERNAL"
24997 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
24998 the &%server_condition%& option must be present.
24999 .next
25000 .cindex "authentication" "ANONYMOUS"
25001 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25002 the &%server_condition%& option must be present.
25003 .next
25004 .cindex "authentication" "GSSAPI"
25005 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25006 &$auth2$& will be set to the &'authorization id'&,
25007 the &%server_condition%& option must be present.
25008 .endlist
25009
25010 An &'anonymous token'& is something passed along as an unauthenticated
25011 identifier; this is analogous to FTP anonymous authentication passing an
25012 email address, or software-identifier@, as the "password".
25013
25014
25015 An example showing the password having the realm specified in the callback
25016 and demonstrating a Cyrus SASL to GSASL migration approach is:
25017 .code
25018 gsasl_cyrusless_crammd5:
25019   driver = gsasl
25020   public_name = CRAM-MD5
25021   server_realm = imap.example.org
25022   server_password = ${lookup{$auth1:$auth3:userPassword}\
25023                     dbmjz{/etc/sasldb2}{$value}fail}
25024   server_set_id = ${quote:$auth1}
25025   server_condition = yes
25026 .endd
25027
25028
25029 . ////////////////////////////////////////////////////////////////////////////
25030 . ////////////////////////////////////////////////////////////////////////////
25031
25032 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25033 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25034 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25035 .cindex "authentication" "GSSAPI"
25036 .cindex "authentication" "Kerberos"
25037 The &(heimdal_gssapi)& authenticator provides server integration for the
25038 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25039 reliably.
25040
25041 .option server_hostname heimdal_gssapi string&!! "see below"
25042 This option selects the hostname that is used, with &%server_service%&,
25043 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25044 identifier.  The default value is &`$primary_hostname`&.
25045
25046 .option server_keytab heimdal_gssapi string&!! unset
25047 If set, then Heimdal will not use the system default keytab (typically
25048 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25049 The value should be a pathname, with no &"file:"& prefix.
25050
25051 .option server_service heimdal_gssapi string&!! "smtp"
25052 This option specifies the service identifier used, in conjunction with
25053 &%server_hostname%&, for building the identifer for finding credentials
25054 from the keytab.
25055
25056
25057 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25058 Beware that these variables will typically include a realm, thus will appear
25059 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25060 not verified, so a malicious client can set it to anything.
25061
25062 The &$auth1$& field should be safely trustable as a value from the Key
25063 Distribution Center.  Note that these are not quite email addresses.
25064 Each identifier is for a role, and so the left-hand-side may include a
25065 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25066
25067 .vindex "&$auth1$&, &$auth2$&, etc"
25068 .ilist
25069 .vindex "&$auth1$&"
25070 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25071 .next
25072 .vindex "&$auth2$&"
25073 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25074 authentication.  If that was empty, this will also be set to the
25075 GSS Display Name.
25076 .endlist
25077
25078
25079 . ////////////////////////////////////////////////////////////////////////////
25080 . ////////////////////////////////////////////////////////////////////////////
25081
25082 .chapter "The spa authenticator" "CHAPspa"
25083 .scindex IIDspaauth1 "&(spa)& authenticator"
25084 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25085 .cindex "authentication" "Microsoft Secure Password"
25086 .cindex "authentication" "NTLM"
25087 .cindex "Microsoft Secure Password Authentication"
25088 .cindex "NTLM authentication"
25089 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25090 Password Authentication'& mechanism,
25091 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25092 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25093 taken from the Samba project (&url(http://www.samba.org)). The code for the
25094 server side was subsequently contributed by Tom Kistner. The mechanism works as
25095 follows:
25096
25097 .ilist
25098 After the AUTH command has been accepted, the client sends an SPA
25099 authentication request based on the user name and optional domain.
25100 .next
25101 The server sends back a challenge.
25102 .next
25103 The client builds a challenge response which makes use of the user's password
25104 and sends it to the server, which then accepts or rejects it.
25105 .endlist
25106
25107 Encryption is used to protect the password in transit.
25108
25109
25110
25111 .section "Using spa as a server" "SECID179"
25112 .cindex "options" "&(spa)& authenticator (server)"
25113 The &(spa)& authenticator has just one server option:
25114
25115 .option server_password spa string&!! unset
25116 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25117 This option is expanded, and the result must be the cleartext password for the
25118 authenticating user, whose name is at this point in &$auth1$&. For
25119 compatibility with previous releases of Exim, the user name is also placed in
25120 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25121 it can lead to confusion in string expansions that also use numeric variables
25122 for other things. For example:
25123 .code
25124 spa:
25125   driver = spa
25126   public_name = NTLM
25127   server_password = \
25128     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25129 .endd
25130 If the expansion is forced to fail, authentication fails. Any other expansion
25131 failure causes a temporary error code to be returned.
25132
25133
25134
25135
25136
25137 .section "Using spa as a client" "SECID180"
25138 .cindex "options" "&(spa)& authenticator (client)"
25139 The &(spa)& authenticator has the following client options:
25140
25141
25142
25143 .option client_domain spa string&!! unset
25144 This option specifies an optional domain for the authentication.
25145
25146
25147 .option client_password spa string&!! unset
25148 This option specifies the user's password, and must be set.
25149
25150
25151 .option client_username spa string&!! unset
25152 This option specifies the user name, and must be set. Here is an example of a
25153 configuration of this authenticator for use with the mail servers at
25154 &'msn.com'&:
25155 .code
25156 msn:
25157   driver = spa
25158   public_name = MSN
25159   client_username = msn/msn_username
25160   client_password = msn_plaintext_password
25161   client_domain = DOMAIN_OR_UNSET
25162 .endd
25163 .ecindex IIDspaauth1
25164 .ecindex IIDspaauth2
25165
25166
25167
25168
25169
25170 . ////////////////////////////////////////////////////////////////////////////
25171 . ////////////////////////////////////////////////////////////////////////////
25172
25173 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25174          "Encrypted SMTP connections"
25175 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25176 .scindex IIDencsmtp2 "SMTP" "encryption"
25177 .cindex "TLS" "on SMTP connection"
25178 .cindex "OpenSSL"
25179 .cindex "GnuTLS"
25180 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25181 Sockets Layer), is implemented by making use of the OpenSSL library or the
25182 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25183 cryptographic code in the Exim distribution itself for implementing TLS. In
25184 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25185 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25186 You also need to understand the basic concepts of encryption at a managerial
25187 level, and in particular, the way that public keys, private keys, and
25188 certificates are used.
25189
25190 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25191 connection is established, the client issues a STARTTLS command. If the
25192 server accepts this, the client and the server negotiate an encryption
25193 mechanism. If the negotiation succeeds, the data that subsequently passes
25194 between them is encrypted.
25195
25196 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25197 and if so, what cipher suite is in use, whether the client supplied a
25198 certificate, and whether or not that certificate was verified. This makes it
25199 possible for an Exim server to deny or accept certain commands based on the
25200 encryption state.
25201
25202 &*Warning*&: Certain types of firewall and certain anti-virus products can
25203 disrupt TLS connections. You need to turn off SMTP scanning for these products
25204 in order to get TLS to work.
25205
25206
25207
25208 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25209          "SECID284"
25210 .cindex "ssmtp protocol"
25211 .cindex "smtps protocol"
25212 .cindex "SMTP" "ssmtp protocol"
25213 .cindex "SMTP" "smtps protocol"
25214 Early implementations of encrypted SMTP used a different TCP port from normal
25215 SMTP, and expected an encryption negotiation to start immediately, instead of
25216 waiting for a STARTTLS command from the client using the standard SMTP
25217 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25218 allocated for this purpose.
25219
25220 This approach was abandoned when encrypted SMTP was standardized, but there are
25221 still some legacy clients that use it. Exim supports these clients by means of
25222 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25223 numbers; the most common use is expected to be:
25224 .code
25225 tls_on_connect_ports = 465
25226 .endd
25227 The port numbers specified by this option apply to all SMTP connections, both
25228 via the daemon and via &'inetd'&. You still need to specify all the ports that
25229 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25230 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25231 an extra port &-- rather, it specifies different behaviour on a port that is
25232 defined elsewhere.
25233
25234 There is also a &%-tls-on-connect%& command line option. This overrides
25235 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25236
25237
25238
25239
25240
25241
25242 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25243 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25244 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25245 followed later, when the first versions of GnuTLS were released. To build Exim
25246 to use GnuTLS, you need to set
25247 .code
25248 USE_GNUTLS=yes
25249 .endd
25250 in Local/Makefile, in addition to
25251 .code
25252 SUPPORT_TLS=yes
25253 .endd
25254 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25255 include files and libraries for GnuTLS can be found.
25256
25257 There are some differences in usage when using GnuTLS instead of OpenSSL:
25258
25259 .ilist
25260 The &%tls_verify_certificates%& option must contain the name of a file, not the
25261 name of a directory (for OpenSSL it can be either).
25262 .next
25263 The default value for &%tls_dhparam%& differs for historical reasons.
25264 .next
25265 .vindex "&$tls_in_peerdn$&"
25266 .vindex "&$tls_out_peerdn$&"
25267 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25268 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25269 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25270 .next
25271 OpenSSL identifies cipher suites using hyphens as separators, for example:
25272 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25273 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25274 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25275 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25276 to handle its own older variants) when processing lists of cipher suites in the
25277 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25278 option).
25279 .next
25280 The &%tls_require_ciphers%& options operate differently, as described in the
25281 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25282 .next
25283 .new
25284 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25285 When using OpenSSL, this option is ignored.
25286 (If an API is found to let OpenSSL be configured in this way,
25287 let the Exim Maintainers know and we'll likely use it).
25288 .wen
25289 .next
25290 Some other recently added features may only be available in one or the other.
25291 This should be documented with the feature.  If the documentation does not
25292 explicitly state that the feature is infeasible in the other TLS
25293 implementation, then patches are welcome.
25294 .endlist
25295
25296
25297 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25298 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25299 an explicit path; if the latter, then the text about generation still applies,
25300 but not the chosen filename.
25301 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25302 See the documentation of &%tls_dhparam%& for more information.
25303
25304 GnuTLS uses D-H parameters that may take a substantial amount of time
25305 to compute. It is unreasonable to re-compute them for every TLS session.
25306 Therefore, Exim keeps this data in a file in its spool directory, called
25307 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25308 of bits requested.
25309 The file is owned by the Exim user and is readable only by
25310 its owner. Every Exim process that start up GnuTLS reads the D-H
25311 parameters from this file. If the file does not exist, the first Exim process
25312 that needs it computes the data and writes it to a temporary file which is
25313 renamed once it is complete. It does not matter if several Exim processes do
25314 this simultaneously (apart from wasting a few resources). Once a file is in
25315 place, new Exim processes immediately start using it.
25316
25317 For maximum security, the parameters that are stored in this file should be
25318 recalculated periodically, the frequency depending on your paranoia level.
25319 If you are avoiding using the fixed D-H primes published in RFCs, then you
25320 are concerned about some advanced attacks and will wish to do this; if you do
25321 not regenerate then you might as well stick to the standard primes.
25322
25323 Arranging this is easy in principle; just delete the file when you want new
25324 values to be computed. However, there may be a problem. The calculation of new
25325 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25326 If the system is not very active, &_/dev/random_& may delay returning data
25327 until enough randomness (entropy) is available. This may cause Exim to hang for
25328 a substantial amount of time, causing timeouts on incoming connections.
25329
25330 The solution is to generate the parameters externally to Exim. They are stored
25331 in &_gnutls-params-N_& in PEM format, which means that they can be
25332 generated externally using the &(certtool)& command that is part of GnuTLS.
25333
25334 To replace the parameters with new ones, instead of deleting the file
25335 and letting Exim re-create it, you can generate new parameters using
25336 &(certtool)& and, when this has been done, replace Exim's cache file by
25337 renaming. The relevant commands are something like this:
25338 .code
25339 # ls
25340 [ look for file; assume gnutls-params-2236 is the most recent ]
25341 # rm -f new-params
25342 # touch new-params
25343 # chown exim:exim new-params
25344 # chmod 0600 new-params
25345 # certtool --generate-dh-params --bits 2236 >>new-params
25346 # openssl dhparam -noout -text -in new-params | head
25347 [ check the first line, make sure it's not more than 2236;
25348   if it is, then go back to the start ("rm") and repeat
25349   until the size generated is at most the size requested ]
25350 # chmod 0400 new-params
25351 # mv new-params gnutls-params-2236
25352 .endd
25353 If Exim never has to generate the parameters itself, the possibility of
25354 stalling is removed.
25355
25356 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25357 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25358 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25359 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25360 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25361 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25362 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25363 which applies to all D-H usage, client or server.  If the value returned by
25364 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25365 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25366 limit, which is still much higher than Exim historically used.
25367
25368 The filename and bits used will change as the GnuTLS maintainers change the
25369 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25370 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25371 2432 bits, while NSS is limited to 2236 bits.
25372
25373 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
25374 increase the chance of the generated prime actually being within acceptable
25375 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
25376 procedure above.  There is no sane procedure available to Exim to double-check
25377 the size of the generated prime, so it might still be too large.
25378
25379
25380 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25381 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25382 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25383 There is a function in the OpenSSL library that can be passed a list of cipher
25384 suites before the cipher negotiation takes place. This specifies which ciphers
25385 are acceptable. The list is colon separated and may contain names like
25386 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25387 directly to this function call.
25388 Many systems will install the OpenSSL manual-pages, so you may have
25389 &'ciphers(1)'& available to you.
25390 The following quotation from the OpenSSL
25391 documentation specifies what forms of item are allowed in the cipher string:
25392
25393 .ilist
25394 It can consist of a single cipher suite such as RC4-SHA.
25395 .next
25396 It can represent a list of cipher suites containing a certain algorithm,
25397 or cipher suites of a certain type. For example SHA1 represents all
25398 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25399 SSL v3 algorithms.
25400 .next
25401 Lists of cipher suites can be combined in a single cipher string using
25402 the + character. This is used as a logical and operation. For example
25403 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25404 algorithms.
25405 .endlist
25406
25407 Each cipher string can be optionally preceded by one of the characters &`!`&,
25408 &`-`& or &`+`&.
25409 .ilist
25410 If &`!`& is used, the ciphers are permanently deleted from the list. The
25411 ciphers deleted can never reappear in the list even if they are explicitly
25412 stated.
25413 .next
25414 If &`-`& is used, the ciphers are deleted from the list, but some or all
25415 of the ciphers can be added again by later options.
25416 .next
25417 If &`+`& is used, the ciphers are moved to the end of the list. This
25418 option does not add any new ciphers; it just moves matching existing ones.
25419 .endlist
25420
25421 If none of these characters is present, the string is interpreted as
25422 a list of ciphers to be appended to the current preference list. If the list
25423 includes any ciphers already present they will be ignored: that is, they will
25424 not be moved to the end of the list.
25425 .endlist
25426
25427 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
25428 string:
25429 .code
25430 # note single-quotes to get ! past any shell history expansion
25431 $ openssl ciphers 'HIGH:!MD5:!SHA1'
25432 .endd
25433
25434 This example will let the library defaults be permitted on the MX port, where
25435 there's probably no identity verification anyway, but ups the ante on the
25436 submission ports where the administrator might have some influence on the
25437 choice of clients used:
25438 .code
25439 # OpenSSL variant; see man ciphers(1)
25440 tls_require_ciphers = ${if =={$received_port}{25}\
25441                            {DEFAULT}\
25442                            {HIGH:!MD5:!SHA1}}
25443 .endd
25444
25445
25446
25447 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25448          "SECTreqciphgnu"
25449 .cindex "GnuTLS" "specifying parameters for"
25450 .cindex "TLS" "specifying ciphers (GnuTLS)"
25451 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25452 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25453 .cindex "TLS" "specifying protocols (GnuTLS)"
25454 .cindex "TLS" "specifying priority string (GnuTLS)"
25455 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25456 The GnuTLS library allows the caller to provide a "priority string", documented
25457 as part of the &[gnutls_priority_init]& function.  This is very similar to the
25458 ciphersuite specification in OpenSSL.
25459
25460 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
25461
25462 The &%tls_require_ciphers%& option is available both as an global option,
25463 controlling how Exim behaves as a server, and also as an option of the
25464 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
25465 the value is string expanded.  The resulting string is not an Exim list and
25466 the string is given to the GnuTLS library, so that Exim does not need to be
25467 aware of future feature enhancements of GnuTLS.
25468
25469 Documentation of the strings accepted may be found in the GnuTLS manual, under
25470 "Priority strings".  This is online as
25471 &url(http://www.gnu.org/software/gnutls/manual/html_node/Priority-Strings.html),
25472 but beware that this relates to GnuTLS 3, which may be newer than the version
25473 installed on your system.  If you are using GnuTLS 3,
25474 &url(http://www.gnu.org/software/gnutls/manual/html_node/Listing-the-ciphersuites-in-a-priority-string.html, then the example code)
25475 on that site can be used to test a given string.
25476
25477 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
25478 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
25479 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
25480
25481 This example will let the library defaults be permitted on the MX port, where
25482 there's probably no identity verification anyway, and lowers security further
25483 by increasing compatibility; but this ups the ante on the submission ports
25484 where the administrator might have some influence on the choice of clients
25485 used:
25486 .code
25487 # GnuTLS variant
25488 tls_require_ciphers = ${if =={$received_port}{25}\
25489                            {NORMAL:%COMPAT}\
25490                            {SECURE128}}
25491 .endd
25492
25493
25494 .section "Configuring an Exim server to use TLS" "SECID182"
25495 .cindex "TLS" "configuring an Exim server"
25496 When Exim has been built with TLS support, it advertises the availability of
25497 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25498 but not to any others. The default value of this option is unset, which means
25499 that STARTTLS is not advertised at all. This default is chosen because you
25500 need to set some other options in order to make TLS available, and also it is
25501 sensible for systems that want to use TLS only as a client.
25502
25503 If a client issues a STARTTLS command and there is some configuration
25504 problem in the server, the command is rejected with a 454 error. If the client
25505 persists in trying to issue SMTP commands, all except QUIT are rejected
25506 with the error
25507 .code
25508 554 Security failure
25509 .endd
25510 If a STARTTLS command is issued within an existing TLS session, it is
25511 rejected with a 554 error code.
25512
25513 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25514 match some hosts. You can, of course, set it to * to match all hosts.
25515 However, this is not all you need to do. TLS sessions to a server won't work
25516 without some further configuration at the server end.
25517
25518 It is rumoured that all existing clients that support TLS/SSL use RSA
25519 encryption. To make this work you need to set, in the server,
25520 .code
25521 tls_certificate = /some/file/name
25522 tls_privatekey = /some/file/name
25523 .endd
25524 These options are, in fact, expanded strings, so you can make them depend on
25525 the identity of the client that is connected if you wish. The first file
25526 contains the server's X509 certificate, and the second contains the private key
25527 that goes with it. These files need to be readable by the Exim user, and must
25528 always be given as full path names. They can be the same file if both the
25529 certificate and the key are contained within it. If &%tls_privatekey%& is not
25530 set, or if its expansion is forced to fail or results in an empty string, this
25531 is assumed to be the case. The certificate file may also contain intermediate
25532 certificates that need to be sent to the client to enable it to authenticate
25533 the server's certificate.
25534
25535 If you do not understand about certificates and keys, please try to find a
25536 source of this background information, which is not Exim-specific. (There are a
25537 few comments below in section &<<SECTcerandall>>&.)
25538
25539 &*Note*&: These options do not apply when Exim is operating as a client &--
25540 they apply only in the case of a server. If you need to use a certificate in an
25541 Exim client, you must set the options of the same names in an &(smtp)&
25542 transport.
25543
25544 With just these options, an Exim server will be able to use TLS. It does not
25545 require the client to have a certificate (but see below for how to insist on
25546 this). There is one other option that may be needed in other situations. If
25547 .code
25548 tls_dhparam = /some/file/name
25549 .endd
25550 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25551 with the parameters contained in the file.
25552 Set this to &`none`& to disable use of DH entirely, by making no prime
25553 available:
25554 .code
25555 tls_dhparam = none
25556 .endd
25557 This may also be set to a string identifying a standard prime to be used for
25558 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
25559 used is &`ike23`&.  There are a few standard primes available, see the
25560 documetnation for &%tls_dhparam%& for the complete list.
25561
25562 See the command
25563 .code
25564 openssl dhparam
25565 .endd
25566 for a way of generating file data.
25567
25568 The strings supplied for these three options are expanded every time a client
25569 host connects. It is therefore possible to use different certificates and keys
25570 for different hosts, if you so wish, by making use of the client's IP address
25571 in &$sender_host_address$& to control the expansion. If a string expansion is
25572 forced to fail, Exim behaves as if the option is not set.
25573
25574 .cindex "cipher" "logging"
25575 .cindex "log" "TLS cipher"
25576 .vindex "&$tls_in_cipher$&"
25577 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
25578 an incoming TLS connection. It is included in the &'Received:'& header of an
25579 incoming message (by default &-- you can, of course, change this), and it is
25580 also included in the log line that records a message's arrival, keyed by
25581 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25582 condition can be used to test for specific cipher suites in ACLs.
25583
25584 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25585 can check the name of the cipher suite and vary their actions accordingly. The
25586 cipher suite names vary, depending on which TLS library is being used. For
25587 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25588 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25589 documentation for more details.
25590
25591 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
25592 (again depending on the &%tls_cipher%& log selector).
25593
25594
25595 .section "Requesting and verifying client certificates" "SECID183"
25596 .cindex "certificate" "verification of client"
25597 .cindex "TLS" "client certificate verification"
25598 If you want an Exim server to request a certificate when negotiating a TLS
25599 session with a client, you must set either &%tls_verify_hosts%& or
25600 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25601 apply to all TLS connections. For any host that matches one of these options,
25602 Exim requests a certificate as part of the setup of the TLS session. The
25603 contents of the certificate are verified by comparing it with a list of
25604 expected certificates. These must be available in a file or,
25605 for OpenSSL only (not GnuTLS), a directory, identified by
25606 &%tls_verify_certificates%&.
25607
25608 A file can contain multiple certificates, concatenated end to end. If a
25609 directory is used
25610 (OpenSSL only),
25611 each certificate must be in a separate file, with a name (or a symbolic link)
25612 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25613 certificate. You can compute the relevant hash by running the command
25614 .code
25615 openssl x509 -hash -noout -in /cert/file
25616 .endd
25617 where &_/cert/file_& contains a single certificate.
25618
25619 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25620 what happens if the client does not supply a certificate, or if the certificate
25621 does not match any of the certificates in the collection named by
25622 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25623 attempt to set up a TLS session is aborted, and the incoming connection is
25624 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25625 session continues. ACLs that run for subsequent SMTP commands can detect the
25626 fact that no certificate was verified, and vary their actions accordingly. For
25627 example, you can insist on a certificate before accepting a message for
25628 relaying, but not when the message is destined for local delivery.
25629
25630 .vindex "&$tls_in_peerdn$&"
25631 When a client supplies a certificate (whether it verifies or not), the value of
25632 the Distinguished Name of the certificate is made available in the variable
25633 &$tls_in_peerdn$& during subsequent processing of the message.
25634
25635 .cindex "log" "distinguished name"
25636 Because it is often a long text string, it is not included in the log line or
25637 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25638 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25639 &%received_header_text%& to change the &'Received:'& header. When no
25640 certificate is supplied, &$tls_in_peerdn$& is empty.
25641
25642
25643 .section "Revoked certificates" "SECID184"
25644 .cindex "TLS" "revoked certificates"
25645 .cindex "revocation list"
25646 .cindex "certificate" "revocation list"
25647 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25648 certificates are revoked. If you have such a list, you can pass it to an Exim
25649 server using the global option called &%tls_crl%& and to an Exim client using
25650 an identically named option for the &(smtp)& transport. In each case, the value
25651 of the option is expanded and must then be the name of a file that contains a
25652 CRL in PEM format.
25653
25654
25655 .section "Configuring an Exim client to use TLS" "SECID185"
25656 .cindex "cipher" "logging"
25657 .cindex "log" "TLS cipher"
25658 .cindex "log" "distinguished name"
25659 .cindex "TLS" "configuring an Exim client"
25660 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25661 deliveries as well as to incoming, the latter one causing logging of the
25662 server certificate's DN. The remaining client configuration for TLS is all
25663 within the &(smtp)& transport.
25664
25665 It is not necessary to set any options to have TLS work in the &(smtp)&
25666 transport. If Exim is built with TLS support, and TLS is advertised by a
25667 server, the &(smtp)& transport always tries to start a TLS session. However,
25668 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25669 transport) to a list of server hosts for which TLS should not be used.
25670
25671 If you do not want Exim to attempt to send messages unencrypted when an attempt
25672 to set up an encrypted connection fails in any way, you can set
25673 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25674 those hosts, delivery is always deferred if an encrypted connection cannot be
25675 set up. If there are any other hosts for the address, they are tried in the
25676 usual way.
25677
25678 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25679 the message unencrypted. It always does this if the response to STARTTLS is
25680 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25681 session after a success response code, what happens is controlled by the
25682 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25683 delivery to this host is deferred, and other hosts (if available) are tried. If
25684 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25685 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25686 negotiation fails, Exim closes the current connection (because it is in an
25687 unknown state), opens a new one to the same host, and then tries the delivery
25688 unencrypted.
25689
25690 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25691 transport provide the client with a certificate, which is passed to the server
25692 if it requests it. If the server is Exim, it will request a certificate only if
25693 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25694
25695 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25696 must name a file or,
25697 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25698 expected server certificates. The client verifies the server's certificate
25699 against this collection, taking into account any revoked certificates that are
25700 in the list defined by &%tls_crl%&.
25701
25702 If
25703 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25704 list of permitted cipher suites. If either of these checks fails, delivery to
25705 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25706 alternative hosts, if any.
25707
25708  &*Note*&:
25709 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25710 is operating as a client. Exim does not assume that a server certificate (set
25711 by the global options of the same name) should also be used when operating as a
25712 client.
25713
25714 .vindex "&$host$&"
25715 .vindex "&$host_address$&"
25716 All the TLS options in the &(smtp)& transport are expanded before use, with
25717 &$host$& and &$host_address$& containing the name and address of the server to
25718 which the client is connected. Forced failure of an expansion causes Exim to
25719 behave as if the relevant option were unset.
25720
25721 .vindex &$tls_out_bits$&
25722 .vindex &$tls_out_cipher$&
25723 .vindex &$tls_out_peerdn$&
25724 .vindex &$tls_out_sni$&
25725 Before an SMTP connection is established, the
25726 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
25727 variables are emptied. (Until the first connection, they contain the values
25728 that were set when the message was received.) If STARTTLS is subsequently
25729 successfully obeyed, these variables are set to the relevant values for the
25730 outgoing connection.
25731
25732
25733
25734 .section "Use of TLS Server Name Indication" "SECTtlssni"
25735 .cindex "TLS" "Server Name Indication"
25736 .vindex "&$tls_in_sni$&"
25737 .oindex "&%tls_in_sni%&"
25738 With TLS1.0 or above, there is an extension mechanism by which extra
25739 information can be included at various points in the protocol.  One of these
25740 extensions, documented in RFC 6066 (and before that RFC 4366) is
25741 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
25742 client in the initial handshake, so that the server can examine the servername
25743 within and possibly choose to use different certificates and keys (and more)
25744 for this session.
25745
25746 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
25747 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
25748 address.
25749
25750 With SMTP to MX, there are the same problems here as in choosing the identity
25751 against which to validate a certificate: you can't rely on insecure DNS to
25752 provide the identity which you then cryptographically verify.  So this will
25753 be of limited use in that environment.
25754
25755 With SMTP to Submission, there is a well-defined hostname which clients are
25756 connecting to and can validate certificates against.  Thus clients &*can*&
25757 choose to include this information in the TLS negotiation.  If this becomes
25758 wide-spread, then hosters can choose to present different certificates to
25759 different clients.  Or even negotiate different cipher suites.
25760
25761 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
25762 if not empty, will be sent on a TLS session as part of the handshake.  There's
25763 nothing more to it.  Choosing a sensible value not derived insecurely is the
25764 only point of caution.  The &$tls_out_sni$& variable will be set to this string
25765 for the lifetime of the client connection (including during authentication).
25766
25767 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
25768 received from a client.
25769 It can be logged with the &%log_selector%& item &`+tls_sni`&.
25770
25771 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
25772 option (prior to expansion) then the following options will be re-expanded
25773 during TLS session handshake, to permit alternative values to be chosen:
25774
25775 .ilist
25776 .vindex "&%tls_certificate%&"
25777 &%tls_certificate%&
25778 .next
25779 .vindex "&%tls_crl%&"
25780 &%tls_crl%&
25781 .next
25782 .vindex "&%tls_privatekey%&"
25783 &%tls_privatekey%&
25784 .next
25785 .vindex "&%tls_verify_certificates%&"
25786 &%tls_verify_certificates%&
25787 .endlist
25788
25789 Great care should be taken to deal with matters of case, various injection
25790 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
25791 can always be referenced; it is important to remember that &$tls_sni$& is
25792 arbitrary unverified data provided prior to authentication.
25793
25794 The Exim developers are proceeding cautiously and so far no other TLS options
25795 are re-expanded.
25796
25797 When Exim is built againt OpenSSL, OpenSSL must have been built with support
25798 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
25799 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
25800 see &`-servername`& in the output, then OpenSSL has support.
25801
25802 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
25803 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
25804 built, then you have SNI support).
25805
25806
25807
25808 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
25809          "SECTmulmessam"
25810 .cindex "multiple SMTP deliveries with TLS"
25811 .cindex "TLS" "multiple message deliveries"
25812 Exim sends multiple messages down the same TCP/IP connection by starting up
25813 an entirely new delivery process for each message, passing the socket from
25814 one process to the next. This implementation does not fit well with the use
25815 of TLS, because there is quite a lot of state information associated with a TLS
25816 connection, not just a socket identification. Passing all the state information
25817 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
25818 session before passing the socket to a new process. The new process may then
25819 try to start a new TLS session, and if successful, may try to re-authenticate
25820 if AUTH is in use, before sending the next message.
25821
25822 The RFC is not clear as to whether or not an SMTP session continues in clear
25823 after TLS has been shut down, or whether TLS may be restarted again later, as
25824 just described. However, if the server is Exim, this shutdown and
25825 reinitialization works. It is not known which (if any) other servers operate
25826 successfully if the client closes a TLS session and continues with unencrypted
25827 SMTP, but there are certainly some that do not work. For such servers, Exim
25828 should not pass the socket to another process, because the failure of the
25829 subsequent attempt to use it would cause Exim to record a temporary host error,
25830 and delay other deliveries to that host.
25831
25832 To test for this case, Exim sends an EHLO command to the server after
25833 closing down the TLS session. If this fails in any way, the connection is
25834 closed instead of being passed to a new delivery process, but no retry
25835 information is recorded.
25836
25837 There is also a manual override; you can set &%hosts_nopass_tls%& on the
25838 &(smtp)& transport to match those hosts for which Exim should not pass
25839 connections to new processes if TLS has been used.
25840
25841
25842
25843
25844 .section "Certificates and all that" "SECTcerandall"
25845 .cindex "certificate" "references to discussion"
25846 In order to understand fully how TLS works, you need to know about
25847 certificates, certificate signing, and certificate authorities. This is not the
25848 place to give a tutorial, especially as I do not know very much about it
25849 myself. Some helpful introduction can be found in the FAQ for the SSL addition
25850 to Apache, currently at
25851 .display
25852 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
25853 .endd
25854 Other parts of the &'modssl'& documentation are also helpful, and have
25855 links to further files.
25856 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
25857 0-201-61598-3), contains both introductory and more in-depth descriptions.
25858 Some sample programs taken from the book are available from
25859 .display
25860 &url(http://www.rtfm.com/openssl-examples/)
25861 .endd
25862
25863
25864 .section "Certificate chains" "SECID186"
25865 The file named by &%tls_certificate%& may contain more than one
25866 certificate. This is useful in the case where the certificate that is being
25867 sent is validated by an intermediate certificate which the other end does
25868 not have. Multiple certificates must be in the correct order in the file.
25869 First the host's certificate itself, then the first intermediate
25870 certificate to validate the issuer of the host certificate, then the next
25871 intermediate certificate to validate the issuer of the first intermediate
25872 certificate, and so on, until finally (optionally) the root certificate.
25873 The root certificate must already be trusted by the recipient for
25874 validation to succeed, of course, but if it's not preinstalled, sending the
25875 root certificate along with the rest makes it available for the user to
25876 install if the receiving end is a client MUA that can interact with a user.
25877
25878
25879 .section "Self-signed certificates" "SECID187"
25880 .cindex "certificate" "self-signed"
25881 You can create a self-signed certificate using the &'req'& command provided
25882 with OpenSSL, like this:
25883 . ==== Do not shorten the duration here without reading and considering
25884 . ==== the text below.  Please leave it at 9999 days.
25885 .code
25886 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
25887             -days 9999 -nodes
25888 .endd
25889 &_file1_& and &_file2_& can be the same file; the key and the certificate are
25890 delimited and so can be identified independently. The &%-days%& option
25891 specifies a period for which the certificate is valid. The &%-nodes%& option is
25892 important: if you do not set it, the key is encrypted with a passphrase
25893 that you are prompted for, and any use that is made of the key causes more
25894 prompting for the passphrase. This is not helpful if you are going to use
25895 this certificate and key in an MTA, where prompting is not possible.
25896
25897 . ==== I expect to still be working 26 years from now.  The less technical
25898 . ==== debt I create, in terms of storing up trouble for my later years, the
25899 . ==== happier I will be then.  We really have reached the point where we
25900 . ==== should start, at the very least, provoking thought and making folks
25901 . ==== pause before proceeding, instead of leaving all the fixes until two
25902 . ==== years before 2^31 seconds after the 1970 Unix epoch.
25903 . ==== -pdp, 2012
25904 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
25905 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
25906 the above command might produce a date in the past.  Think carefully about
25907 the lifetime of the systems you're deploying, and either reduce the duration
25908 of the certificate or reconsider your platform deployment.  (At time of
25909 writing, reducing the duration is the most likely choice, but the inexorable
25910 progression of time takes us steadily towards an era where this will not
25911 be a sensible resolution).
25912
25913 A self-signed certificate made in this way is sufficient for testing, and
25914 may be adequate for all your requirements if you are mainly interested in
25915 encrypting transfers, and not in secure identification.
25916
25917 However, many clients require that the certificate presented by the server be a
25918 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
25919 certificate. In this situation, the self-signed certificate described above
25920 must be installed on the client host as a trusted root &'certification
25921 authority'& (CA), and the certificate used by Exim must be a user certificate
25922 signed with that self-signed certificate.
25923
25924 For information on creating self-signed CA certificates and using them to sign
25925 user certificates, see the &'General implementation overview'& chapter of the
25926 Open-source PKI book, available online at
25927 &url(http://ospkibook.sourceforge.net/).
25928 .ecindex IIDencsmtp1
25929 .ecindex IIDencsmtp2
25930
25931
25932
25933 . ////////////////////////////////////////////////////////////////////////////
25934 . ////////////////////////////////////////////////////////////////////////////
25935
25936 .chapter "Access control lists" "CHAPACL"
25937 .scindex IIDacl "&ACL;" "description"
25938 .cindex "control of incoming mail"
25939 .cindex "message" "controlling incoming"
25940 .cindex "policy control" "access control lists"
25941 Access Control Lists (ACLs) are defined in a separate section of the run time
25942 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
25943 name, terminated by a colon. Here is a complete ACL section that contains just
25944 one very small ACL:
25945 .code
25946 begin acl
25947 small_acl:
25948   accept   hosts = one.host.only
25949 .endd
25950 You can have as many lists as you like in the ACL section, and the order in
25951 which they appear does not matter. The lists are self-terminating.
25952
25953 The majority of ACLs are used to control Exim's behaviour when it receives
25954 certain SMTP commands. This applies both to incoming TCP/IP connections, and
25955 when a local process submits a message using SMTP by specifying the &%-bs%&
25956 option. The most common use is for controlling which recipients are accepted
25957 in incoming messages. In addition, you can define an ACL that is used to check
25958 local non-SMTP messages. The default configuration file contains an example of
25959 a realistic ACL for checking RCPT commands. This is discussed in chapter
25960 &<<CHAPdefconfil>>&.
25961
25962
25963 .section "Testing ACLs" "SECID188"
25964 The &%-bh%& command line option provides a way of testing your ACL
25965 configuration locally by running a fake SMTP session with which you interact.
25966 The host &'relay-test.mail-abuse.org'& provides a service for checking your
25967 relaying configuration (see section &<<SECTcheralcon>>& for more details).
25968
25969
25970
25971 .section "Specifying when ACLs are used" "SECID189"
25972 .cindex "&ACL;" "options for specifying"
25973 In order to cause an ACL to be used, you have to name it in one of the relevant
25974 options in the main part of the configuration. These options are:
25975 .cindex "AUTH" "ACL for"
25976 .cindex "DATA" "ACLs for"
25977 .cindex "ETRN" "ACL for"
25978 .cindex "EXPN" "ACL for"
25979 .cindex "HELO" "ACL for"
25980 .cindex "EHLO" "ACL for"
25981 .cindex "MAIL" "ACL for"
25982 .cindex "QUIT, ACL for"
25983 .cindex "RCPT" "ACL for"
25984 .cindex "STARTTLS, ACL for"
25985 .cindex "VRFY" "ACL for"
25986 .cindex "SMTP" "connection, ACL for"
25987 .cindex "non-SMTP messages" "ACLs for"
25988 .cindex "MIME content scanning" "ACL for"
25989
25990 .table2 140pt
25991 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
25992 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
25993 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
25994 .irow &%acl_smtp_auth%&        "ACL for AUTH"
25995 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
25996 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
25997 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
25998 .irow &%acl_smtp_expn%&        "ACL for EXPN"
25999 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26000 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26001 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26002 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26003 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26004 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26005 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26006 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26007 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26008 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26009 .endtable
26010
26011 For example, if you set
26012 .code
26013 acl_smtp_rcpt = small_acl
26014 .endd
26015 the little ACL defined above is used whenever Exim receives a RCPT command
26016 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26017 done when RCPT commands arrive. A rejection of RCPT should cause the
26018 sending MTA to give up on the recipient address contained in the RCPT
26019 command, whereas rejection at other times may cause the client MTA to keep on
26020 trying to deliver the message. It is therefore recommended that you do as much
26021 testing as possible at RCPT time.
26022
26023
26024 .section "The non-SMTP ACLs" "SECID190"
26025 .cindex "non-SMTP messages" "ACLs for"
26026 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26027 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26028 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26029 the state of the SMTP connection such as encryption and authentication) are not
26030 relevant and are forbidden in these ACLs. However, the sender and recipients
26031 are known, so the &%senders%& and &%sender_domains%& conditions and the
26032 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26033 &$authenticated_sender$& are also available. You can specify added header lines
26034 in any of these ACLs.
26035
26036 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26037 non-SMTP message, before any of the message has been read. (This is the
26038 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26039 batched SMTP input, it runs after the DATA command has been reached. The
26040 result of this ACL is ignored; it cannot be used to reject a message. If you
26041 really need to, you could set a value in an ACL variable here and reject based
26042 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26043 controls, and in particular, it can be used to set
26044 .code
26045 control = suppress_local_fixups
26046 .endd
26047 This cannot be used in the other non-SMTP ACLs because by the time they are
26048 run, it is too late.
26049
26050 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26051 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26052
26053 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26054 kind of rejection is treated as permanent, because there is no way of sending a
26055 temporary error for these kinds of message.
26056
26057
26058 .section "The SMTP connect ACL" "SECID191"
26059 .cindex "SMTP" "connection, ACL for"
26060 .oindex &%smtp_banner%&
26061 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26062 session, after the test specified by &%host_reject_connection%& (which is now
26063 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26064 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26065 the message override the banner message that is otherwise specified by the
26066 &%smtp_banner%& option.
26067
26068
26069 .section "The EHLO/HELO ACL" "SECID192"
26070 .cindex "EHLO" "ACL for"
26071 .cindex "HELO" "ACL for"
26072 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26073 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26074 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26075 Note that a client may issue more than one EHLO or HELO command in an SMTP
26076 session, and indeed is required to issue a new EHLO or HELO after successfully
26077 setting up encryption following a STARTTLS command.
26078
26079 If the command is accepted by an &%accept%& verb that has a &%message%&
26080 modifier, the message may not contain more than one line (it will be truncated
26081 at the first newline and a panic logged if it does). Such a message cannot
26082 affect the EHLO options that are listed on the second and subsequent lines of
26083 an EHLO response.
26084
26085
26086 .section "The DATA ACLs" "SECID193"
26087 .cindex "DATA" "ACLs for"
26088 Two ACLs are associated with the DATA command, because it is two-stage
26089 command, with two responses being sent to the client.
26090 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26091 is obeyed. This gives you control after all the RCPT commands, but before
26092 the message itself is received. It offers the opportunity to give a negative
26093 response to the DATA command before the data is transmitted. Header lines
26094 added by MAIL or RCPT ACLs are not visible at this time, but any that
26095 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26096
26097 You cannot test the contents of the message, for example, to verify addresses
26098 in the headers, at RCPT time or when the DATA command is received. Such
26099 tests have to appear in the ACL that is run after the message itself has been
26100 received, before the final response to the DATA command is sent. This is
26101 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26102 associated with the DATA command.
26103
26104 For both of these ACLs, it is not possible to reject individual recipients. An
26105 error response rejects the entire message. Unfortunately, it is known that some
26106 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26107 before or after the data) correctly &-- they keep the message on their queues
26108 and try again later, but that is their problem, though it does waste some of
26109 your resources.
26110
26111
26112 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26113 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26114 enabled (which is the default).
26115
26116 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26117 received, and is executed for each DKIM signature found in a message.  If not
26118 otherwise specified, the default action is to accept.
26119
26120 For details on the operation of DKIM, see chapter &<<CHID12>>&.
26121
26122
26123 .section "The SMTP MIME ACL" "SECID194"
26124 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26125 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26126
26127
26128 .section "The QUIT ACL" "SECTQUITACL"
26129 .cindex "QUIT, ACL for"
26130 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26131 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26132 does not in fact control any access. For this reason, the only verbs that are
26133 permitted are &%accept%& and &%warn%&.
26134
26135 This ACL can be used for tasks such as custom logging at the end of an SMTP
26136 session. For example, you can use ACL variables in other ACLs to count
26137 messages, recipients, etc., and log the totals at QUIT time using one or
26138 more &%logwrite%& modifiers on a &%warn%& verb.
26139
26140 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
26141 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
26142
26143 You do not need to have a final &%accept%&, but if you do, you can use a
26144 &%message%& modifier to specify custom text that is sent as part of the 221
26145 response to QUIT.
26146
26147 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
26148 failure (for example, failure to open a log file, or when Exim is bombing out
26149 because it has detected an unrecoverable error), all SMTP commands from the
26150 client are given temporary error responses until QUIT is received or the
26151 connection is closed. In these special cases, the QUIT ACL does not run.
26152
26153
26154 .section "The not-QUIT ACL" "SECTNOTQUITACL"
26155 .vindex &$acl_smtp_notquit$&
26156 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
26157 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
26158 trouble, such as being unable to write to its log files, this ACL is not run,
26159 because it might try to do things (such as write to log files) that make the
26160 situation even worse.
26161
26162 Like the QUIT ACL, this ACL is provided to make it possible to do customized
26163 logging or to gather statistics, and its outcome is ignored. The &%delay%&
26164 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
26165 and &%warn%&.
26166
26167 .vindex &$smtp_notquit_reason$&
26168 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
26169 to a string that indicates the reason for the termination of the SMTP
26170 connection. The possible values are:
26171 .table2
26172 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
26173 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
26174 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
26175 .irow &`connection-lost`&          "The SMTP connection has been lost"
26176 .irow &`data-timeout`&             "Timeout while reading message data"
26177 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
26178 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
26179 .irow &`signal-exit`&              "SIGTERM or SIGINT"
26180 .irow &`synchronization-error`&    "SMTP synchronization error"
26181 .irow &`tls-failed`&               "TLS failed to start"
26182 .endtable
26183 In most cases when an SMTP connection is closed without having received QUIT,
26184 Exim sends an SMTP response message before actually closing the connection.
26185 With the exception of the &`acl-drop`& case, the default message can be
26186 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
26187 &%drop%& verb in another ACL, it is the message from the other ACL that is
26188 used.
26189
26190
26191 .section "Finding an ACL to use" "SECID195"
26192 .cindex "&ACL;" "finding which to use"
26193 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
26194 you can use different ACLs in different circumstances. For example,
26195 .code
26196 acl_smtp_rcpt = ${if ={25}{$interface_port} \
26197                      {acl_check_rcpt} {acl_check_rcpt_submit} }
26198 .endd
26199 In the default configuration file there are some example settings for
26200 providing an RFC 4409 message submission service on port 587 and a
26201 non-standard &"smtps"& service on port 465. You can use a string
26202 expansion like this to choose an ACL for MUAs on these ports which is
26203 more appropriate for this purpose than the default ACL on port 25.
26204
26205 The expanded string does not have to be the name of an ACL in the
26206 configuration file; there are other possibilities. Having expanded the
26207 string, Exim searches for an ACL as follows:
26208
26209 .ilist
26210 If the string begins with a slash, Exim uses it as a file name, and reads its
26211 contents as an ACL. The lines are processed in the same way as lines in the
26212 Exim configuration file. In particular, continuation lines are supported, blank
26213 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
26214 If the file does not exist or cannot be read, an error occurs (typically
26215 causing a temporary failure of whatever caused the ACL to be run). For example:
26216 .code
26217 acl_smtp_data = /etc/acls/\
26218   ${lookup{$sender_host_address}lsearch\
26219   {/etc/acllist}{$value}{default}}
26220 .endd
26221 This looks up an ACL file to use on the basis of the host's IP address, falling
26222 back to a default if the lookup fails. If an ACL is successfully read from a
26223 file, it is retained in memory for the duration of the Exim process, so that it
26224 can be re-used without having to re-read the file.
26225 .next
26226 If the string does not start with a slash, and does not contain any spaces,
26227 Exim searches the ACL section of the configuration for an ACL whose name
26228 matches the string.
26229 .next
26230 If no named ACL is found, or if the string contains spaces, Exim parses
26231 the string as an inline ACL. This can save typing in cases where you just
26232 want to have something like
26233 .code
26234 acl_smtp_vrfy = accept
26235 .endd
26236 in order to allow free use of the VRFY command. Such a string may contain
26237 newlines; it is processed in the same way as an ACL that is read from a file.
26238 .endlist
26239
26240
26241
26242
26243 .section "ACL return codes" "SECID196"
26244 .cindex "&ACL;" "return codes"
26245 Except for the QUIT ACL, which does not affect the SMTP return code (see
26246 section &<<SECTQUITACL>>& above), the result of running an ACL is either
26247 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
26248 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
26249 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
26250 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
26251 This also causes a 4&'xx'& return code.
26252
26253 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
26254 &"deny"&, because there is no mechanism for passing temporary errors to the
26255 submitters of non-SMTP messages.
26256
26257
26258 ACLs that are relevant to message reception may also return &"discard"&. This
26259 has the effect of &"accept"&, but causes either the entire message or an
26260 individual recipient address to be discarded. In other words, it is a
26261 blackholing facility. Use it with care.
26262
26263 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
26264 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
26265 RCPT ACL is to discard just the one recipient address. If there are no
26266 recipients left when the message's data is received, the DATA ACL is not
26267 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
26268 remaining recipients. The &"discard"& return is not permitted for the
26269 &%acl_smtp_predata%& ACL.
26270
26271
26272 .cindex "&[local_scan()]& function" "when all recipients discarded"
26273 The &[local_scan()]& function is always run, even if there are no remaining
26274 recipients; it may create new recipients.
26275
26276
26277
26278 .section "Unset ACL options" "SECID197"
26279 .cindex "&ACL;" "unset options"
26280 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
26281 all the same. &*Note*&: These defaults apply only when the relevant ACL is
26282 not defined at all. For any defined ACL, the default action when control
26283 reaches the end of the ACL statements is &"deny"&.
26284
26285 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
26286 these two are ACLs that are used only for their side effects. They cannot be
26287 used to accept or reject anything.
26288
26289 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
26290 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
26291 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
26292 when the ACL is not defined is &"accept"&.
26293
26294 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
26295 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
26296 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
26297 messages over an SMTP connection. For an example, see the ACL in the default
26298 configuration file.
26299
26300
26301
26302
26303 .section "Data for message ACLs" "SECID198"
26304 .cindex "&ACL;" "data for message ACL"
26305 .vindex &$domain$&
26306 .vindex &$local_part$&
26307 .vindex &$sender_address$&
26308 .vindex &$sender_host_address$&
26309 .vindex &$smtp_command$&
26310 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
26311 that contain information about the host and the message's sender (for example,
26312 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
26313 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
26314 &$local_part$& are set from the argument address. The entire SMTP command
26315 is available in &$smtp_command$&.
26316
26317 When an ACL for the AUTH parameter of MAIL is running, the variables that
26318 contain information about the host are set, but &$sender_address$& is not yet
26319 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
26320 how it is used.
26321
26322 .vindex "&$message_size$&"
26323 The &$message_size$& variable is set to the value of the SIZE parameter on
26324 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
26325 that parameter is not given. The value is updated to the true message size by
26326 the time the final DATA ACL is run (after the message data has been
26327 received).
26328
26329 .vindex "&$rcpt_count$&"
26330 .vindex "&$recipients_count$&"
26331 The &$rcpt_count$& variable increases by one for each RCPT command received.
26332 The &$recipients_count$& variable increases by one each time a RCPT command is
26333 accepted, so while an ACL for RCPT is being processed, it contains the number
26334 of previously accepted recipients. At DATA time (for both the DATA ACLs),
26335 &$rcpt_count$& contains the total number of RCPT commands, and
26336 &$recipients_count$& contains the total number of accepted recipients.
26337
26338
26339
26340
26341
26342 .section "Data for non-message ACLs" "SECTdatfornon"
26343 .cindex "&ACL;" "data for non-message ACL"
26344 .vindex &$smtp_command_argument$&
26345 .vindex &$smtp_command$&
26346 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
26347 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
26348 and the entire SMTP command is available in &$smtp_command$&.
26349 These variables can be tested using a &%condition%& condition. For example,
26350 here is an ACL for use with AUTH, which insists that either the session is
26351 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
26352 does not permit authentication methods that use cleartext passwords on
26353 unencrypted connections.
26354 .code
26355 acl_check_auth:
26356   accept encrypted = *
26357   accept condition = ${if eq{${uc:$smtp_command_argument}}\
26358                      {CRAM-MD5}}
26359   deny   message   = TLS encryption or CRAM-MD5 required
26360 .endd
26361 (Another way of applying this restriction is to arrange for the authenticators
26362 that use cleartext passwords not to be advertised when the connection is not
26363 encrypted. You can use the generic &%server_advertise_condition%& authenticator
26364 option to do this.)
26365
26366
26367
26368 .section "Format of an ACL" "SECID199"
26369 .cindex "&ACL;" "format of"
26370 .cindex "&ACL;" "verbs, definition of"
26371 An individual ACL consists of a number of statements. Each statement starts
26372 with a verb, optionally followed by a number of conditions and &"modifiers"&.
26373 Modifiers can change the way the verb operates, define error and log messages,
26374 set variables, insert delays, and vary the processing of accepted messages.
26375
26376 If all the conditions are met, the verb is obeyed. The same condition may be
26377 used (with different arguments) more than once in the same statement. This
26378 provides a means of specifying an &"and"& conjunction between conditions. For
26379 example:
26380 .code
26381 deny  dnslists = list1.example
26382 dnslists = list2.example
26383 .endd
26384 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26385 the conditions and modifiers when it reaches a condition that fails. What
26386 happens then depends on the verb (and in one case, on a special modifier). Not
26387 all the conditions make sense at every testing point. For example, you cannot
26388 test a sender address in the ACL that is run for a VRFY command.
26389
26390
26391 .section "ACL verbs" "SECID200"
26392 The ACL verbs are as follows:
26393
26394 .ilist
26395 .cindex "&%accept%& ACL verb"
26396 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26397 of the conditions are not met, what happens depends on whether &%endpass%&
26398 appears among the conditions (for syntax see below). If the failing condition
26399 is before &%endpass%&, control is passed to the next ACL statement; if it is
26400 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26401 check a RCPT command:
26402 .code
26403 accept domains = +local_domains
26404 endpass
26405 verify = recipient
26406 .endd
26407 If the recipient domain does not match the &%domains%& condition, control
26408 passes to the next statement. If it does match, the recipient is verified, and
26409 the command is accepted if verification succeeds. However, if verification
26410 fails, the ACL yields &"deny"&, because the failing condition is after
26411 &%endpass%&.
26412
26413 The &%endpass%& feature has turned out to be confusing to many people, so its
26414 use is not recommended nowadays. It is always possible to rewrite an ACL so
26415 that &%endpass%& is not needed, and it is no longer used in the default
26416 configuration.
26417
26418 .cindex "&%message%& ACL modifier" "with &%accept%&"
26419 If a &%message%& modifier appears on an &%accept%& statement, its action
26420 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26421 (when an &%accept%& verb either accepts or passes control to the next
26422 statement), &%message%& can be used to vary the message that is sent when an
26423 SMTP command is accepted. For example, in a RCPT ACL you could have:
26424 .display
26425 &`accept  `&<&'some conditions'&>
26426 &`        message = OK, I will allow you through today`&
26427 .endd
26428 You can specify an SMTP response code, optionally followed by an &"extended
26429 response code"& at the start of the message, but the first digit must be the
26430 same as would be sent by default, which is 2 for an &%accept%& verb.
26431
26432 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26433 an error message that is used when access is denied. This behaviour is retained
26434 for backward compatibility, but current &"best practice"& is to avoid the use
26435 of &%endpass%&.
26436
26437
26438 .next
26439 .cindex "&%defer%& ACL verb"
26440 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26441 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26442 &%defer%& is the same as &%deny%&, because there is no way of sending a
26443 temporary error. For a RCPT command, &%defer%& is much the same as using a
26444 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26445 be used in any ACL, and even for a recipient it might be a simpler approach.
26446
26447
26448 .next
26449 .cindex "&%deny%& ACL verb"
26450 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26451 the conditions are not met, control is passed to the next ACL statement. For
26452 example,
26453 .code
26454 deny dnslists = blackholes.mail-abuse.org
26455 .endd
26456 rejects commands from hosts that are on a DNS black list.
26457
26458
26459 .next
26460 .cindex "&%discard%& ACL verb"
26461 &%discard%&: This verb behaves like &%accept%&, except that it returns
26462 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26463 that are concerned with receiving messages. When all the conditions are true,
26464 the sending entity receives a &"success"& response. However, &%discard%& causes
26465 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26466 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26467 message's recipients are discarded. Recipients that are discarded before DATA
26468 do not appear in the log line when the &%received_recipients%& log selector is set.
26469
26470 If the &%log_message%& modifier is set when &%discard%& operates,
26471 its contents are added to the line that is automatically written to the log.
26472 The &%message%& modifier operates exactly as it does for &%accept%&.
26473
26474
26475 .next
26476 .cindex "&%drop%& ACL verb"
26477 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26478 forcibly closed after the 5&'xx'& error message has been sent. For example:
26479 .code
26480 drop   message   = I don't take more than 20 RCPTs
26481        condition = ${if > {$rcpt_count}{20}}
26482 .endd
26483 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26484 The connection is always dropped after sending a 550 response.
26485
26486 .next
26487 .cindex "&%require%& ACL verb"
26488 &%require%&: If all the conditions are met, control is passed to the next ACL
26489 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26490 example, when checking a RCPT command,
26491 .code
26492 require message = Sender did not verify
26493         verify  = sender
26494 .endd
26495 passes control to subsequent statements only if the message's sender can be
26496 verified. Otherwise, it rejects the command. Note the positioning of the
26497 &%message%& modifier, before the &%verify%& condition. The reason for this is
26498 discussed in section &<<SECTcondmodproc>>&.
26499
26500 .next
26501 .cindex "&%warn%& ACL verb"
26502 &%warn%&: If all the conditions are true, a line specified by the
26503 &%log_message%& modifier is written to Exim's main log. Control always passes
26504 to the next ACL statement. If any condition is false, the log line is not
26505 written. If an identical log line is requested several times in the same
26506 message, only one copy is actually written to the log. If you want to force
26507 duplicates to be written, use the &%logwrite%& modifier instead.
26508
26509 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26510 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26511 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
26512 first failing condition. There is more about adding header lines in section
26513 &<<SECTaddheadacl>>&.
26514
26515 If any condition on a &%warn%& statement cannot be completed (that is, there is
26516 some sort of defer), the log line specified by &%log_message%& is not written.
26517 This does not include the case of a forced failure from a lookup, which
26518 is considered to be a successful completion. After a defer, no further
26519 conditions or modifiers in the &%warn%& statement are processed. The incident
26520 is logged, and the ACL continues to be processed, from the next statement
26521 onwards.
26522
26523
26524 .vindex "&$acl_verify_message$&"
26525 When one of the &%warn%& conditions is an address verification that fails, the
26526 text of the verification failure message is in &$acl_verify_message$&. If you
26527 want this logged, you must set it up explicitly. For example:
26528 .code
26529 warn   !verify = sender
26530        log_message = sender verify failed: $acl_verify_message
26531 .endd
26532 .endlist
26533
26534 At the end of each ACL there is an implicit unconditional &%deny%&.
26535
26536 As you can see from the examples above, the conditions and modifiers are
26537 written one to a line, with the first one on the same line as the verb, and
26538 subsequent ones on following lines. If you have a very long condition, you can
26539 continue it onto several physical lines by the usual backslash continuation
26540 mechanism. It is conventional to align the conditions vertically.
26541
26542
26543
26544 .section "ACL variables" "SECTaclvariables"
26545 .cindex "&ACL;" "variables"
26546 There are some special variables that can be set during ACL processing. They
26547 can be used to pass information between different ACLs, different invocations
26548 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26549 transports, and filters that are used to deliver a message. The names of these
26550 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26551 an underscore, but the remainder of the name can be any sequence of
26552 alphanumeric characters and underscores that you choose. There is no limit on
26553 the number of ACL variables. The two sets act as follows:
26554 .ilist
26555 The values of those variables whose names begin with &$acl_c$& persist
26556 throughout an SMTP connection. They are never reset. Thus, a value that is set
26557 while receiving one message is still available when receiving the next message
26558 on the same SMTP connection.
26559 .next
26560 The values of those variables whose names begin with &$acl_m$& persist only
26561 while a message is being received. They are reset afterwards. They are also
26562 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26563 .endlist
26564
26565 When a message is accepted, the current values of all the ACL variables are
26566 preserved with the message and are subsequently made available at delivery
26567 time. The ACL variables are set by a modifier called &%set%&. For example:
26568 .code
26569 accept hosts = whatever
26570        set acl_m4 = some value
26571 accept authenticated = *
26572        set acl_c_auth = yes
26573 .endd
26574 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26575 be set. If you want to set a variable without taking any action, you can use a
26576 &%warn%& verb without any other modifiers or conditions.
26577
26578 .oindex &%strict_acl_vars%&
26579 What happens if a syntactically valid but undefined ACL variable is
26580 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26581 false (the default), an empty string is substituted; if it is true, an
26582 error is generated.
26583
26584 Versions of Exim before 4.64 have a limited set of numbered variables, but
26585 their names are compatible, so there is no problem with upgrading.
26586
26587
26588 .section "Condition and modifier processing" "SECTcondmodproc"
26589 .cindex "&ACL;" "conditions; processing"
26590 .cindex "&ACL;" "modifiers; processing"
26591 An exclamation mark preceding a condition negates its result. For example:
26592 .code
26593 deny   domains = *.dom.example
26594       !verify  = recipient
26595 .endd
26596 causes the ACL to return &"deny"& if the recipient domain ends in
26597 &'dom.example'& and the recipient address cannot be verified. Sometimes
26598 negation can be used on the right-hand side of a condition. For example, these
26599 two statements are equivalent:
26600 .code
26601 deny  hosts = !192.168.3.4
26602 deny !hosts =  192.168.3.4
26603 .endd
26604 However, for many conditions (&%verify%& being a good example), only left-hand
26605 side negation of the whole condition is possible.
26606
26607 The arguments of conditions and modifiers are expanded. A forced failure
26608 of an expansion causes a condition to be ignored, that is, it behaves as if the
26609 condition is true. Consider these two statements:
26610 .code
26611 accept  senders = ${lookup{$host_name}lsearch\
26612                   {/some/file}{$value}fail}
26613 accept  senders = ${lookup{$host_name}lsearch\
26614                   {/some/file}{$value}{}}
26615 .endd
26616 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26617 the returned list is searched, but if the lookup fails the behaviour is
26618 different in the two cases. The &%fail%& in the first statement causes the
26619 condition to be ignored, leaving no further conditions. The &%accept%& verb
26620 therefore succeeds. The second statement, however, generates an empty list when
26621 the lookup fails. No sender can match an empty list, so the condition fails,
26622 and therefore the &%accept%& also fails.
26623
26624 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26625 specify actions that are taken as the conditions for a statement are checked;
26626 others specify text for messages that are used when access is denied or a
26627 warning is generated. The &%control%& modifier affects the way an incoming
26628 message is handled.
26629
26630 The positioning of the modifiers in an ACL statement is important, because the
26631 processing of a verb ceases as soon as its outcome is known. Only those
26632 modifiers that have already been encountered will take effect. For example,
26633 consider this use of the &%message%& modifier:
26634 .code
26635 require message = Can't verify sender
26636         verify  = sender
26637         message = Can't verify recipient
26638         verify  = recipient
26639         message = This message cannot be used
26640 .endd
26641 If sender verification fails, Exim knows that the result of the statement is
26642 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26643 so its text is used as the error message. If sender verification succeeds, but
26644 recipient verification fails, the second message is used. If recipient
26645 verification succeeds, the third message becomes &"current"&, but is never used
26646 because there are no more conditions to cause failure.
26647
26648 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26649 modifier that is used, because all the conditions must be true for rejection to
26650 happen. Specifying more than one &%message%& modifier does not make sense, and
26651 the message can even be specified after all the conditions. For example:
26652 .code
26653 deny   hosts = ...
26654       !senders = *@my.domain.example
26655        message = Invalid sender from client host
26656 .endd
26657 The &"deny"& result does not happen until the end of the statement is reached,
26658 by which time Exim has set up the message.
26659
26660
26661
26662 .section "ACL modifiers" "SECTACLmodi"
26663 .cindex "&ACL;" "modifiers; list of"
26664 The ACL modifiers are as follows:
26665
26666 .vlist
26667 .vitem &*add_header*&&~=&~<&'text'&>
26668 This modifier specifies one or more header lines that are to be added to an
26669 incoming message, assuming, of course, that the message is ultimately
26670 accepted. For details, see section &<<SECTaddheadacl>>&.
26671
26672 .vitem &*continue*&&~=&~<&'text'&>
26673 .cindex "&%continue%& ACL modifier"
26674 .cindex "database" "updating in ACL"
26675 This modifier does nothing of itself, and processing of the ACL always
26676 continues with the next condition or modifier. The value of &%continue%& is in
26677 the side effects of expanding its argument. Typically this could be used to
26678 update a database. It is really just a syntactic tidiness, to avoid having to
26679 write rather ugly lines like this:
26680 .display
26681 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26682 .endd
26683 Instead, all you need is
26684 .display
26685 &`continue = `&<&'some expansion'&>
26686 .endd
26687
26688 .vitem &*control*&&~=&~<&'text'&>
26689 .cindex "&%control%& ACL modifier"
26690 This modifier affects the subsequent processing of the SMTP connection or of an
26691 incoming message that is accepted. The effect of the first type of control
26692 lasts for the duration of the connection, whereas the effect of the second type
26693 lasts only until the current message has been received. The message-specific
26694 controls always apply to the whole message, not to individual recipients,
26695 even if the &%control%& modifier appears in a RCPT ACL.
26696
26697 As there are now quite a few controls that can be applied, they are described
26698 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26699 in several different ways. For example:
26700
26701 . ==== As this is a nested list, any displays it contains must be indented
26702 . ==== as otherwise they are too far to the left. That comment applies only
26703 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26704 . ==== way.
26705
26706 .ilist
26707 It can be at the end of an &%accept%& statement:
26708 .code
26709     accept  ...some conditions
26710             control = queue_only
26711 .endd
26712 In this case, the control is applied when this statement yields &"accept"&, in
26713 other words, when the conditions are all true.
26714
26715 .next
26716 It can be in the middle of an &%accept%& statement:
26717 .code
26718     accept  ...some conditions...
26719             control = queue_only
26720             ...some more conditions...
26721 .endd
26722 If the first set of conditions are true, the control is applied, even if the
26723 statement does not accept because one of the second set of conditions is false.
26724 In this case, some subsequent statement must yield &"accept"& for the control
26725 to be relevant.
26726
26727 .next
26728 It can be used with &%warn%& to apply the control, leaving the
26729 decision about accepting or denying to a subsequent verb. For
26730 example:
26731 .code
26732     warn    ...some conditions...
26733             control = freeze
26734     accept  ...
26735 .endd
26736 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
26737 &%logwrite%&, so it does not add anything to the message and does not write a
26738 log entry.
26739
26740 .next
26741 If you want to apply a control unconditionally, you can use it with a
26742 &%require%& verb. For example:
26743 .code
26744     require  control = no_multiline_responses
26745 .endd
26746 .endlist
26747
26748 .vitem &*delay*&&~=&~<&'time'&>
26749 .cindex "&%delay%& ACL modifier"
26750 .oindex "&%-bh%&"
26751 This modifier may appear in any ACL except notquit. It causes Exim to wait for
26752 the time interval before proceeding. However, when testing Exim using the
26753 &%-bh%& option, the delay is not actually imposed (an appropriate message is
26754 output instead). The time is given in the usual Exim notation, and the delay
26755 happens as soon as the modifier is processed. In an SMTP session, pending
26756 output is flushed before the delay is imposed.
26757
26758 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
26759 example:
26760 .code
26761 deny    ...some conditions...
26762         delay = 30s
26763 .endd
26764 The delay happens if all the conditions are true, before the statement returns
26765 &"deny"&. Compare this with:
26766 .code
26767 deny    delay = 30s
26768         ...some conditions...
26769 .endd
26770 which waits for 30s before processing the conditions. The &%delay%& modifier
26771 can also be used with &%warn%& and together with &%control%&:
26772 .code
26773 warn    ...some conditions...
26774         delay = 2m
26775         control = freeze
26776 accept  ...
26777 .endd
26778
26779 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
26780 responses to several commands are no longer buffered and sent in one packet (as
26781 they would normally be) because all output is flushed before imposing the
26782 delay. This optimization is disabled so that a number of small delays do not
26783 appear to the client as one large aggregated delay that might provoke an
26784 unwanted timeout. You can, however, disable output flushing for &%delay%& by
26785 using a &%control%& modifier to set &%no_delay_flush%&.
26786
26787
26788 .vitem &*endpass*&
26789 .cindex "&%endpass%& ACL modifier"
26790 This modifier, which has no argument, is recognized only in &%accept%& and
26791 &%discard%& statements. It marks the boundary between the conditions whose
26792 failure causes control to pass to the next statement, and the conditions whose
26793 failure causes the ACL to return &"deny"&. This concept has proved to be
26794 confusing to some people, so the use of &%endpass%& is no longer recommended as
26795 &"best practice"&. See the description of &%accept%& above for more details.
26796
26797
26798 .vitem &*log_message*&&~=&~<&'text'&>
26799 .cindex "&%log_message%& ACL modifier"
26800 This modifier sets up a message that is used as part of the log message if the
26801 ACL denies access or a &%warn%& statement's conditions are true. For example:
26802 .code
26803 require log_message = wrong cipher suite $tls_in_cipher
26804         encrypted   = DES-CBC3-SHA
26805 .endd
26806 &%log_message%& is also used when recipients are discarded by &%discard%&. For
26807 example:
26808 .display
26809 &`discard `&<&'some conditions'&>
26810 &`        log_message = Discarded $local_part@$domain because...`&
26811 .endd
26812 When access is denied, &%log_message%& adds to any underlying error message
26813 that may exist because of a condition failure. For example, while verifying a
26814 recipient address, a &':fail:'& redirection might have already set up a
26815 message.
26816
26817 The message may be defined before the conditions to which it applies, because
26818 the string expansion does not happen until Exim decides that access is to be
26819 denied. This means that any variables that are set by the condition are
26820 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
26821 variables are set after a DNS black list lookup succeeds. If the expansion of
26822 &%log_message%& fails, or if the result is an empty string, the modifier is
26823 ignored.
26824
26825 .vindex "&$acl_verify_message$&"
26826 If you want to use a &%warn%& statement to log the result of an address
26827 verification, you can use &$acl_verify_message$& to include the verification
26828 error message.
26829
26830 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
26831 the start of the logged message. If the same warning log message is requested
26832 more than once while receiving  a single email message, only one copy is
26833 actually logged. If you want to log multiple copies, use &%logwrite%& instead
26834 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
26835 is logged for a successful &%warn%& statement.
26836
26837 If &%log_message%& is not present and there is no underlying error message (for
26838 example, from the failure of address verification), but &%message%& is present,
26839 the &%message%& text is used for logging rejections. However, if any text for
26840 logging contains newlines, only the first line is logged. In the absence of
26841 both &%log_message%& and &%message%&, a default built-in message is used for
26842 logging rejections.
26843
26844
26845 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
26846 .cindex "&%log_reject_target%& ACL modifier"
26847 .cindex "logging in ACL" "specifying which log"
26848 This modifier makes it possible to specify which logs are used for messages
26849 about ACL rejections. Its argument is a colon-separated list of words that can
26850 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
26851 may be empty, in which case a rejection is not logged at all. For example, this
26852 ACL fragment writes no logging information when access is denied:
26853 .display
26854 &`deny `&<&'some conditions'&>
26855 &`     log_reject_target =`&
26856 .endd
26857 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
26858 permanent and temporary rejections. Its effect lasts for the rest of the
26859 current ACL.
26860
26861
26862 .vitem &*logwrite*&&~=&~<&'text'&>
26863 .cindex "&%logwrite%& ACL modifier"
26864 .cindex "logging in ACL" "immediate"
26865 This modifier writes a message to a log file as soon as it is encountered when
26866 processing an ACL. (Compare &%log_message%&, which, except in the case of
26867 &%warn%& and &%discard%&, is used only if the ACL statement denies
26868 access.) The &%logwrite%& modifier can be used to log special incidents in
26869 ACLs. For example:
26870 .display
26871 &`accept `&<&'some special conditions'&>
26872 &`       control  = freeze`&
26873 &`       logwrite = froze message because ...`&
26874 .endd
26875 By default, the message is written to the main log. However, it may begin
26876 with a colon, followed by a comma-separated list of log names, and then
26877 another colon, to specify exactly which logs are to be written. For
26878 example:
26879 .code
26880 logwrite = :main,reject: text for main and reject logs
26881 logwrite = :panic: text for panic log only
26882 .endd
26883
26884
26885 .vitem &*message*&&~=&~<&'text'&>
26886 .cindex "&%message%& ACL modifier"
26887 This modifier sets up a text string that is expanded and used as a response
26888 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
26889 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
26890 there is some complication if &%endpass%& is involved; see the description of
26891 &%accept%& for details.)
26892
26893 The expansion of the message happens at the time Exim decides that the ACL is
26894 to end, not at the time it processes &%message%&. If the expansion fails, or
26895 generates an empty string, the modifier is ignored. Here is an example where
26896 &%message%& must be specified first, because the ACL ends with a rejection if
26897 the &%hosts%& condition fails:
26898 .code
26899 require  message = Host not recognized
26900          hosts = 10.0.0.0/8
26901 .endd
26902 (Once a condition has failed, no further conditions or modifiers are
26903 processed.)
26904
26905 .cindex "SMTP" "error codes"
26906 .oindex "&%smtp_banner%&
26907 For ACLs that are triggered by SMTP commands, the message is returned as part
26908 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
26909 is meaningful only for SMTP, as no message is returned when a non-SMTP message
26910 is accepted. In the case of the connect ACL, accepting with a message modifier
26911 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
26912 accept message may not contain more than one line (otherwise it will be
26913 truncated at the first newline and a panic logged), and it cannot affect the
26914 EHLO options.
26915
26916 When SMTP is involved, the message may begin with an overriding response code,
26917 consisting of three digits optionally followed by an &"extended response code"&
26918 of the form &'n.n.n'&, each code being followed by a space. For example:
26919 .code
26920 deny  message = 599 1.2.3 Host not welcome
26921       hosts = 192.168.34.0/24
26922 .endd
26923 The first digit of the supplied response code must be the same as would be sent
26924 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
26925 access, but for the predata ACL, note that the default success code is 354, not
26926 2&'xx'&.
26927
26928 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
26929 the message modifier cannot override the 221 response code.
26930
26931 The text in a &%message%& modifier is literal; any quotes are taken as
26932 literals, but because the string is expanded, backslash escapes are processed
26933 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
26934 response.
26935
26936 .vindex "&$acl_verify_message$&"
26937 If &%message%& is used on a statement that verifies an address, the message
26938 specified overrides any message that is generated by the verification process.
26939 However, the original message is available in the variable
26940 &$acl_verify_message$&, so you can incorporate it into your message if you
26941 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
26942 routers to be passed back as part of the SMTP response, you should either not
26943 use a &%message%& modifier, or make use of &$acl_verify_message$&.
26944
26945 For compatibility with previous releases of Exim, a &%message%& modifier that
26946 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
26947 modifier, but this usage is now deprecated. However, &%message%& acts only when
26948 all the conditions are true, wherever it appears in an ACL command, whereas
26949 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
26950 &%warn%& in an ACL that is not concerned with receiving a message, it has no
26951 effect.
26952
26953
26954 .vitem &*remove_header*&&~=&~<&'text'&>
26955 This modifier specifies one or more header names in a colon-separated list
26956  that are to be removed from an incoming message, assuming, of course, that
26957 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
26958
26959
26960 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
26961 .cindex "&%set%& ACL modifier"
26962 This modifier puts a value into one of the ACL variables (see section
26963 &<<SECTaclvariables>>&).
26964 .endlist
26965
26966
26967
26968
26969
26970 .section "Use of the control modifier" "SECTcontrols"
26971 .cindex "&%control%& ACL modifier"
26972 The &%control%& modifier supports the following settings:
26973
26974 .vlist
26975 .vitem &*control&~=&~allow_auth_unadvertised*&
26976 This modifier allows a client host to use the SMTP AUTH command even when it
26977 has not been advertised in response to EHLO. Furthermore, because there are
26978 apparently some really broken clients that do this, Exim will accept AUTH after
26979 HELO (rather than EHLO) when this control is set. It should be used only if you
26980 really need it, and you should limit its use to those broken clients that do
26981 not work without it. For example:
26982 .code
26983 warn hosts   = 192.168.34.25
26984      control = allow_auth_unadvertised
26985 .endd
26986 Normally, when an Exim server receives an AUTH command, it checks the name of
26987 the authentication mechanism that is given in the command to ensure that it
26988 matches an advertised mechanism. When this control is set, the check that a
26989 mechanism has been advertised is bypassed. Any configured mechanism can be used
26990 by the client. This control is permitted only in the connection and HELO ACLs.
26991
26992
26993 .vitem &*control&~=&~caseful_local_part*& &&&
26994        &*control&~=&~caselower_local_part*&
26995 .cindex "&ACL;" "case of local part in"
26996 .cindex "case of local parts"
26997 .vindex "&$local_part$&"
26998 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
26999 (that is, during RCPT processing). By default, the contents of &$local_part$&
27000 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27001 any uppercase letters in the original local part are restored in &$local_part$&
27002 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27003 is encountered.
27004
27005 These controls affect only the current recipient. Moreover, they apply only to
27006 local part handling that takes place directly in the ACL (for example, as a key
27007 in lookups). If a test to verify the recipient is obeyed, the case-related
27008 handling of the local part during the verification is controlled by the router
27009 configuration (see the &%caseful_local_part%& generic router option).
27010
27011 This facility could be used, for example, to add a spam score to local parts
27012 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27013 spam score:
27014 .code
27015 warn  control = caseful_local_part
27016       set acl_m4 = ${eval:\
27017                      $acl_m4 + \
27018                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27019                     }
27020       control = caselower_local_part
27021 .endd
27022 Notice that we put back the lower cased version afterwards, assuming that
27023 is what is wanted for subsequent tests.
27024
27025
27026 .new
27027 .vitem &*control&~=&~cutthrough_delivery*&
27028 .cindex "&ACL;" "cutthrough routing"
27029 This option requests delivery be attempted while the item is being received.
27030 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27031 from one SMTP connection to another.  If a recipient-verify callout connection is
27032 requested in the same ACL it is held open and used for the data, otherwise one is made
27033 after the ACL completes.
27034
27035 Should the ultimate destination system positively accept or reject the mail,
27036 a corresponding indication is given to the source system and nothing is queued.
27037 If there is a temporary error the item is queued for later delivery in the
27038 usual fashion. If the item is successfully delivered in cutthrough mode the log line
27039 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
27040 line.
27041
27042 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
27043 sender when the destination system is doing content-scan based rejection.
27044 .wen
27045
27046
27047 .new
27048 .vitem &*control&~=&~dscp/*&<&'value'&>
27049 .cindex "&ACL;" "setting DSCP value"
27050 .cindex "DSCP" "inbound"
27051 This option causes the DSCP value associated with the socket for the inbound
27052 connection to be adjusted to a given value, given as one of a number of fixed
27053 strings or to numeric value.
27054 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
27055 Common values include &`throughput`&, &`mincost`&, and on newer systems
27056 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
27057
27058 The outbound packets from Exim will be marked with this value in the header
27059 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
27060 that these values will have any effect, not be stripped by networking
27061 equipment, or do much of anything without cooperation with your Network
27062 Engineer and those of all network operators between the source and destination.
27063 .wen
27064
27065
27066 .vitem &*control&~=&~debug/*&<&'options'&>
27067 .cindex "&ACL;" "enabling debug logging"
27068 .cindex "debugging" "enabling from an ACL"
27069 This control turns on debug logging, almost as though Exim had been invoked
27070 with &`-d`&, with the output going to a new logfile, by default called
27071 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27072 may access any variables already defined.  The logging may be adjusted with
27073 the &'opts'& option, which takes the same values as the &`-d`& command-line
27074 option.  Some examples (which depend on variables that don't exist in all
27075 contexts):
27076 .code
27077       control = debug
27078       control = debug/tag=.$sender_host_address
27079       control = debug/opts=+expand+acl
27080       control = debug/tag=.$message_exim_id/opts=+expand
27081 .endd
27082
27083
27084 .vitem &*control&~=&~enforce_sync*& &&&
27085        &*control&~=&~no_enforce_sync*&
27086 .cindex "SMTP" "synchronization checking"
27087 .cindex "synchronization checking in SMTP"
27088 These controls make it possible to be selective about when SMTP synchronization
27089 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27090 state of the switch (it is true by default). See the description of this option
27091 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27092
27093 The effect of these two controls lasts for the remainder of the SMTP
27094 connection. They can appear in any ACL except the one for the non-SMTP
27095 messages. The most straightforward place to put them is in the ACL defined by
27096 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27097 before the first synchronization check. The expected use is to turn off the
27098 synchronization checks for badly-behaved hosts that you nevertheless need to
27099 work with.
27100
27101
27102 .vitem &*control&~=&~fakedefer/*&<&'message'&>
27103 .cindex "fake defer"
27104 .cindex "defer, fake"
27105 This control works in exactly the same way as &%fakereject%& (described below)
27106 except that it causes an SMTP 450 response after the message data instead of a
27107 550 response. You must take care when using &%fakedefer%& because it causes the
27108 messages to be duplicated when the sender retries. Therefore, you should not
27109 use &%fakedefer%& if the message is to be delivered normally.
27110
27111 .vitem &*control&~=&~fakereject/*&<&'message'&>
27112 .cindex "fake rejection"
27113 .cindex "rejection, fake"
27114 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
27115 words, only when an SMTP message is being received. If Exim accepts the
27116 message, instead the final 250 response, a 550 rejection message is sent.
27117 However, Exim proceeds to deliver the message as normal. The control applies
27118 only to the current message, not to any subsequent ones that may be received in
27119 the same SMTP connection.
27120
27121 The text for the 550 response is taken from the &%control%& modifier. If no
27122 message is supplied, the following is used:
27123 .code
27124 550-Your message has been rejected but is being
27125 550-kept for evaluation.
27126 550-If it was a legitimate message, it may still be
27127 550 delivered to the target recipient(s).
27128 .endd
27129 This facility should be used with extreme caution.
27130
27131 .vitem &*control&~=&~freeze*&
27132 .cindex "frozen messages" "forcing in ACL"
27133 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27134 other words, only when a message is being received. If the message is accepted,
27135 it is placed on Exim's queue and frozen. The control applies only to the
27136 current message, not to any subsequent ones that may be received in the same
27137 SMTP connection.
27138
27139 This modifier can optionally be followed by &`/no_tell`&. If the global option
27140 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
27141 is told about the freezing), provided all the &*control=freeze*& modifiers that
27142 are obeyed for the current message have the &`/no_tell`& option.
27143
27144 .vitem &*control&~=&~no_delay_flush*&
27145 .cindex "SMTP" "output flushing, disabling for delay"
27146 Exim normally flushes SMTP output before implementing a delay in an ACL, to
27147 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27148 use. This control, as long as it is encountered before the &%delay%& modifier,
27149 disables such output flushing.
27150
27151 .vitem &*control&~=&~no_callout_flush*&
27152 .cindex "SMTP" "output flushing, disabling for callout"
27153 Exim normally flushes SMTP output before performing a callout in an ACL, to
27154 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27155 use. This control, as long as it is encountered before the &%verify%& condition
27156 that causes the callout, disables such output flushing.
27157
27158 .vitem &*control&~=&~no_mbox_unspool*&
27159 This control is available when Exim is compiled with the content scanning
27160 extension. Content scanning may require a copy of the current message, or parts
27161 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
27162 or spam scanner. Normally, such copies are deleted when they are no longer
27163 needed. If this control is set, the copies are not deleted. The control applies
27164 only to the current message, not to any subsequent ones that may be received in
27165 the same SMTP connection. It is provided for debugging purposes and is unlikely
27166 to be useful in production.
27167
27168 .vitem &*control&~=&~no_multiline_responses*&
27169 .cindex "multiline responses, suppressing"
27170 This control is permitted for any ACL except the one for non-SMTP messages.
27171 It seems that there are broken clients in use that cannot handle multiline
27172 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
27173
27174 If this control is set, multiline SMTP responses from ACL rejections are
27175 suppressed. One way of doing this would have been to put out these responses as
27176 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
27177 (&"use multiline responses for more"& it says &-- ha!), and some of the
27178 responses might get close to that. So this facility, which is after all only a
27179 sop to broken clients, is implemented by doing two very easy things:
27180
27181 .ilist
27182 Extra information that is normally output as part of a rejection caused by
27183 sender verification failure is omitted. Only the final line (typically &"sender
27184 verification failed"&) is sent.
27185 .next
27186 If a &%message%& modifier supplies a multiline response, only the first
27187 line is output.
27188 .endlist
27189
27190 The setting of the switch can, of course, be made conditional on the
27191 calling host. Its effect lasts until the end of the SMTP connection.
27192
27193 .vitem &*control&~=&~no_pipelining*&
27194 .cindex "PIPELINING" "suppressing advertising"
27195 This control turns off the advertising of the PIPELINING extension to SMTP in
27196 the current session. To be useful, it must be obeyed before Exim sends its
27197 response to an EHLO command. Therefore, it should normally appear in an ACL
27198 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
27199 &%pipelining_advertise_hosts%&.
27200
27201 .vitem &*control&~=&~queue_only*&
27202 .oindex "&%queue_only%&"
27203 .cindex "queueing incoming messages"
27204 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27205 other words, only when a message is being received. If the message is accepted,
27206 it is placed on Exim's queue and left there for delivery by a subsequent queue
27207 runner. No immediate delivery process is started. In other words, it has the
27208 effect as the &%queue_only%& global option. However, the control applies only
27209 to the current message, not to any subsequent ones that may be received in the
27210 same SMTP connection.
27211
27212 .vitem &*control&~=&~submission/*&<&'options'&>
27213 .cindex "message" "submission"
27214 .cindex "submission mode"
27215 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
27216 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
27217 the current message is a submission from a local MUA. In this case, Exim
27218 operates in &"submission mode"&, and applies certain fixups to the message if
27219 necessary. For example, it adds a &'Date:'& header line if one is not present.
27220 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
27221 late (the message has already been created).
27222
27223 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
27224 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
27225 submission mode; the available options for this control are described there.
27226 The control applies only to the current message, not to any subsequent ones
27227 that may be received in the same SMTP connection.
27228
27229 .vitem &*control&~=&~suppress_local_fixups*&
27230 .cindex "submission fixups, suppressing"
27231 This control applies to locally submitted (non TCP/IP) messages, and is the
27232 complement of &`control = submission`&. It disables the fixups that are
27233 normally applied to locally-submitted messages. Specifically:
27234
27235 .ilist
27236 Any &'Sender:'& header line is left alone (in this respect, it is a
27237 dynamic version of &%local_sender_retain%&).
27238 .next
27239 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
27240 .next
27241 There is no check that &'From:'& corresponds to the actual sender.
27242 .endlist ilist
27243
27244 This control may be useful when a remotely-originated message is accepted,
27245 passed to some scanning program, and then re-submitted for delivery. It can be
27246 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27247 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
27248 data is read.
27249
27250 &*Note:*& This control applies only to the current message, not to any others
27251 that are being submitted at the same time using &%-bs%& or &%-bS%&.
27252 .endlist vlist
27253
27254
27255 .section "Summary of message fixup control" "SECTsummesfix"
27256 All four possibilities for message fixups can be specified:
27257
27258 .ilist
27259 Locally submitted, fixups applied: the default.
27260 .next
27261 Locally submitted, no fixups applied: use
27262 &`control = suppress_local_fixups`&.
27263 .next
27264 Remotely submitted, no fixups applied: the default.
27265 .next
27266 Remotely submitted, fixups applied: use &`control = submission`&.
27267 .endlist
27268
27269
27270
27271 .section "Adding header lines in ACLs" "SECTaddheadacl"
27272 .cindex "header lines" "adding in an ACL"
27273 .cindex "header lines" "position of added lines"
27274 .cindex "&%add_header%& ACL modifier"
27275 The &%add_header%& modifier can be used to add one or more extra header lines
27276 to an incoming message, as in this example:
27277 .code
27278 warn dnslists = sbl.spamhaus.org : \
27279                 dialup.mail-abuse.org
27280      add_header = X-blacklisted-at: $dnslist_domain
27281 .endd
27282 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27283 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27284 receiving a message). The message must ultimately be accepted for
27285 &%add_header%& to have any significant effect. You can use &%add_header%& with
27286 any ACL verb, including &%deny%& (though this is potentially useful only in a
27287 RCPT ACL).
27288
27289 If the data for the &%add_header%& modifier contains one or more newlines that
27290 are not followed by a space or a tab, it is assumed to contain multiple header
27291 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
27292 front of any line that is not a valid header line.
27293
27294 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27295 They are added to the message before processing the DATA and MIME ACLs.
27296 However, if an identical header line is requested more than once, only one copy
27297 is actually added to the message. Further header lines may be accumulated
27298 during the DATA and MIME ACLs, after which they are added to the message, again
27299 with duplicates suppressed. Thus, it is possible to add two identical header
27300 lines to an SMTP message, but only if one is added before DATA and one after.
27301 In the case of non-SMTP messages, new headers are accumulated during the
27302 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
27303 message is rejected after DATA or by the non-SMTP ACL, all added header lines
27304 are included in the entry that is written to the reject log.
27305
27306 .cindex "header lines" "added; visibility of"
27307 Header lines are not visible in string expansions until they are added to the
27308 message. It follows that header lines defined in the MAIL, RCPT, and predata
27309 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
27310 header lines that are added by the DATA or MIME ACLs are not visible in those
27311 ACLs. Because of this restriction, you cannot use header lines as a way of
27312 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
27313 this, you can use ACL variables, as described in section
27314 &<<SECTaclvariables>>&.
27315
27316 The &%add_header%& modifier acts immediately as it is encountered during the
27317 processing of an ACL. Notice the difference between these two cases:
27318 .display
27319 &`accept add_header = ADDED: some text`&
27320 &`       `&<&'some condition'&>
27321
27322 &`accept `&<&'some condition'&>
27323 &`       add_header = ADDED: some text`&
27324 .endd
27325 In the first case, the header line is always added, whether or not the
27326 condition is true. In the second case, the header line is added only if the
27327 condition is true. Multiple occurrences of &%add_header%& may occur in the same
27328 ACL statement. All those that are encountered before a condition fails are
27329 honoured.
27330
27331 .cindex "&%warn%& ACL verb"
27332 For compatibility with previous versions of Exim, a &%message%& modifier for a
27333 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
27334 effect only if all the conditions are true, even if it appears before some of
27335 them. Furthermore, only the last occurrence of &%message%& is honoured. This
27336 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
27337 are present on a &%warn%& verb, both are processed according to their
27338 specifications.
27339
27340 By default, new header lines are added to a message at the end of the existing
27341 header lines. However, you can specify that any particular header line should
27342 be added right at the start (before all the &'Received:'& lines), immediately
27343 after the first block of &'Received:'& lines, or immediately before any line
27344 that is not a &'Received:'& or &'Resent-something:'& header.
27345
27346 This is done by specifying &":at_start:"&, &":after_received:"&, or
27347 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
27348 header line, respectively. (Header text cannot start with a colon, as there has
27349 to be a header name first.) For example:
27350 .code
27351 warn add_header = \
27352        :after_received:X-My-Header: something or other...
27353 .endd
27354 If more than one header line is supplied in a single &%add_header%& modifier,
27355 each one is treated independently and can therefore be placed differently. If
27356 you add more than one line at the start, or after the Received: block, they end
27357 up in reverse order.
27358
27359 &*Warning*&: This facility currently applies only to header lines that are
27360 added in an ACL. It does NOT work for header lines that are added in a
27361 system filter or in a router or transport.
27362
27363
27364
27365 .section "Removing header lines in ACLs" "SECTremoveheadacl"
27366 .cindex "header lines" "removing in an ACL"
27367 .cindex "header lines" "position of removed lines"
27368 .cindex "&%remove_header%& ACL modifier"
27369 The &%remove_header%& modifier can be used to remove one or more header lines
27370 from an incoming message, as in this example:
27371 .code
27372 warn   message        = Remove internal headers
27373        remove_header  = x-route-mail1 : x-route-mail2
27374 .endd
27375 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27376 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27377 receiving a message). The message must ultimately be accepted for
27378 &%remove_header%& to have any significant effect. You can use &%remove_header%&
27379 with any ACL verb, including &%deny%&, though this is really not useful for
27380 any verb that doesn't result in a delivered message.
27381
27382 More than one header can be removed at the same time by using a colon separated
27383 list of header names. The header matching is case insensitive. Wildcards are
27384 not permitted, nor is list expansion performed, so you cannot use hostlists to
27385 create a list of headers, however both connection and message variable expansion
27386 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
27387 .code
27388 warn   hosts           = +internal_hosts
27389        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
27390 warn   message         = Remove internal headers
27391        remove_header   = $acl_c_ihdrs
27392 .endd
27393 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27394 They are removed from the message before processing the DATA and MIME ACLs.
27395 There is no harm in attempting to remove the same header twice nor is removing
27396 a non-existent header. Further header lines to be removed may be accumulated
27397 during the DATA and MIME ACLs, after which they are removed from the message,
27398 if present. In the case of non-SMTP messages, headers to be removed are
27399 accumulated during the non-SMTP ACLs, and are removed from the message after
27400 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
27401 ACL, there really is no effect because there is no logging of what headers
27402 would have been removed.
27403
27404 .cindex "header lines" "removed; visibility of"
27405 Header lines are not visible in string expansions until the DATA phase when it
27406 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
27407 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
27408 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
27409 this restriction, you cannot use header lines as a way of controlling data
27410 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
27411 you should instead use ACL variables, as described in section
27412 &<<SECTaclvariables>>&.
27413
27414 The &%remove_header%& modifier acts immediately as it is encountered during the
27415 processing of an ACL. Notice the difference between these two cases:
27416 .display
27417 &`accept remove_header = X-Internal`&
27418 &`       `&<&'some condition'&>
27419
27420 &`accept `&<&'some condition'&>
27421 &`       remove_header = X-Internal`&
27422 .endd
27423 In the first case, the header line is always removed, whether or not the
27424 condition is true. In the second case, the header line is removed only if the
27425 condition is true. Multiple occurrences of &%remove_header%& may occur in the
27426 same ACL statement. All those that are encountered before a condition fails
27427 are honoured.
27428
27429 &*Warning*&: This facility currently applies only to header lines that are
27430 present during ACL processing. It does NOT remove header lines that are added
27431 in a system filter or in a router or transport.
27432
27433
27434
27435
27436
27437 .section "ACL conditions" "SECTaclconditions"
27438 .cindex "&ACL;" "conditions; list of"
27439 Some of the conditions listed in this section are available only when Exim is
27440 compiled with the content-scanning extension. They are included here briefly
27441 for completeness. More detailed descriptions can be found in the discussion on
27442 content scanning in chapter &<<CHAPexiscan>>&.
27443
27444 Not all conditions are relevant in all circumstances. For example, testing
27445 senders and recipients does not make sense in an ACL that is being run as the
27446 result of the arrival of an ETRN command, and checks on message headers can be
27447 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
27448 can use the same condition (with different parameters) more than once in the
27449 same ACL statement. This provides a way of specifying an &"and"& conjunction.
27450 The conditions are as follows:
27451
27452
27453 .vlist
27454 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
27455 .cindex "&ACL;" "nested"
27456 .cindex "&ACL;" "indirect"
27457 .cindex "&ACL;" "arguments"
27458 .cindex "&%acl%& ACL condition"
27459 The possible values of the argument are the same as for the
27460 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
27461 &"accept"& the condition is true; if it returns &"deny"& the condition is
27462 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
27463 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
27464 condition false. This means that further processing of the &%warn%& verb
27465 ceases, but processing of the ACL continues.
27466
27467 If the argument is a named ACL, up to nine space-separated optional values
27468 can be appended; they appear in $acl_arg1 to $acl_arg9, and $acl_narg is set
27469 to the count of values.  The name and values are expanded separately.
27470
27471 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
27472 the connection is dropped. If it returns &"discard"&, the verb must be
27473 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
27474 conditions are tested.
27475
27476 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
27477 loops. This condition allows you to use different ACLs in different
27478 circumstances. For example, different ACLs can be used to handle RCPT commands
27479 for different local users or different local domains.
27480
27481 .vitem &*authenticated&~=&~*&<&'string&~list'&>
27482 .cindex "&%authenticated%& ACL condition"
27483 .cindex "authentication" "ACL checking"
27484 .cindex "&ACL;" "testing for authentication"
27485 If the SMTP connection is not authenticated, the condition is false. Otherwise,
27486 the name of the authenticator is tested against the list. To test for
27487 authentication by any authenticator, you can set
27488 .code
27489 authenticated = *
27490 .endd
27491
27492 .vitem &*condition&~=&~*&<&'string'&>
27493 .cindex "&%condition%& ACL condition"
27494 .cindex "customizing" "ACL condition"
27495 .cindex "&ACL;" "customized test"
27496 .cindex "&ACL;" "testing, customized"
27497 This feature allows you to make up custom conditions. If the result of
27498 expanding the string is an empty string, the number zero, or one of the strings
27499 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27500 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27501 any other value, some error is assumed to have occurred, and the ACL returns
27502 &"defer"&. However, if the expansion is forced to fail, the condition is
27503 ignored. The effect is to treat it as true, whether it is positive or
27504 negative.
27505
27506 .vitem &*decode&~=&~*&<&'location'&>
27507 .cindex "&%decode%& ACL condition"
27508 This condition is available only when Exim is compiled with the
27509 content-scanning extension, and it is allowed only in the ACL defined by
27510 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
27511 If all goes well, the condition is true. It is false only if there are
27512 problems such as a syntax error or a memory shortage. For more details, see
27513 chapter &<<CHAPexiscan>>&.
27514
27515 .vitem &*demime&~=&~*&<&'extension&~list'&>
27516 .cindex "&%demime%& ACL condition"
27517 This condition is available only when Exim is compiled with the
27518 content-scanning extension. Its use is described in section
27519 &<<SECTdemimecond>>&.
27520
27521 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27522 .cindex "&%dnslists%& ACL condition"
27523 .cindex "DNS list" "in ACL"
27524 .cindex "black list (DNS)"
27525 .cindex "&ACL;" "testing a DNS list"
27526 This condition checks for entries in DNS black lists. These are also known as
27527 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27528 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27529 different variants of this condition to describe briefly here. See sections
27530 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27531
27532 .vitem &*domains&~=&~*&<&'domain&~list'&>
27533 .cindex "&%domains%& ACL condition"
27534 .cindex "domain" "ACL checking"
27535 .cindex "&ACL;" "testing a recipient domain"
27536 .vindex "&$domain_data$&"
27537 This condition is relevant only after a RCPT command. It checks that the domain
27538 of the recipient address is in the domain list. If percent-hack processing is
27539 enabled, it is done before this test is done. If the check succeeds with a
27540 lookup, the result of the lookup is placed in &$domain_data$& until the next
27541 &%domains%& test.
27542
27543 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27544 use &%domains%& in a DATA ACL.
27545
27546
27547 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27548 .cindex "&%encrypted%& ACL condition"
27549 .cindex "encryption" "checking in an ACL"
27550 .cindex "&ACL;" "testing for encryption"
27551 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27552 name of the cipher suite in use is tested against the list. To test for
27553 encryption without testing for any specific cipher suite(s), set
27554 .code
27555 encrypted = *
27556 .endd
27557
27558
27559 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
27560 .cindex "&%hosts%& ACL condition"
27561 .cindex "host" "ACL checking"
27562 .cindex "&ACL;" "testing the client host"
27563 This condition tests that the calling host matches the host list. If you have
27564 name lookups or wildcarded host names and IP addresses in the same host list,
27565 you should normally put the IP addresses first. For example, you could have:
27566 .code
27567 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27568 .endd
27569 The lookup in this example uses the host name for its key. This is implied by
27570 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27571 and it wouldn't matter which way round you had these two items.)
27572
27573 The reason for the problem with host names lies in the left-to-right way that
27574 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27575 but when it reaches an item that requires a host name, it fails if it cannot
27576 find a host name to compare with the pattern. If the above list is given in the
27577 opposite order, the &%accept%& statement fails for a host whose name cannot be
27578 found, even if its IP address is 10.9.8.7.
27579
27580 If you really do want to do the name check first, and still recognize the IP
27581 address even if the name lookup fails, you can rewrite the ACL like this:
27582 .code
27583 accept hosts = dbm;/etc/friendly/hosts
27584 accept hosts = 10.9.8.7
27585 .endd
27586 The default action on failing to find the host name is to assume that the host
27587 is not in the list, so the first &%accept%& statement fails. The second
27588 statement can then check the IP address.
27589
27590 .vindex "&$host_data$&"
27591 If a &%hosts%& condition is satisfied by means of a lookup, the result
27592 of the lookup is made available in the &$host_data$& variable. This
27593 allows you, for example, to set up a statement like this:
27594 .code
27595 deny  hosts = net-lsearch;/some/file
27596 message = $host_data
27597 .endd
27598 which gives a custom error message for each denied host.
27599
27600 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27601 .cindex "&%local_parts%& ACL condition"
27602 .cindex "local part" "ACL checking"
27603 .cindex "&ACL;" "testing a local part"
27604 .vindex "&$local_part_data$&"
27605 This condition is relevant only after a RCPT command. It checks that the local
27606 part of the recipient address is in the list. If percent-hack processing is
27607 enabled, it is done before this test. If the check succeeds with a lookup, the
27608 result of the lookup is placed in &$local_part_data$&, which remains set until
27609 the next &%local_parts%& test.
27610
27611 .vitem &*malware&~=&~*&<&'option'&>
27612 .cindex "&%malware%& ACL condition"
27613 .cindex "&ACL;" "virus scanning"
27614 .cindex "&ACL;" "scanning for viruses"
27615 This condition is available only when Exim is compiled with the
27616 content-scanning extension. It causes the incoming message to be scanned for
27617 viruses. For details, see chapter &<<CHAPexiscan>>&.
27618
27619 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27620 .cindex "&%mime_regex%& ACL condition"
27621 .cindex "&ACL;" "testing by regex matching"
27622 This condition is available only when Exim is compiled with the
27623 content-scanning extension, and it is allowed only in the ACL defined by
27624 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27625 with any of the regular expressions. For details, see chapter
27626 &<<CHAPexiscan>>&.
27627
27628 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27629 .cindex "rate limiting"
27630 This condition can be used to limit the rate at which a user or host submits
27631 messages. Details are given in section &<<SECTratelimiting>>&.
27632
27633 .vitem &*recipients&~=&~*&<&'address&~list'&>
27634 .cindex "&%recipients%& ACL condition"
27635 .cindex "recipient" "ACL checking"
27636 .cindex "&ACL;" "testing a recipient"
27637 This condition is relevant only after a RCPT command. It checks the entire
27638 recipient address against a list of recipients.
27639
27640 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27641 .cindex "&%regex%& ACL condition"
27642 .cindex "&ACL;" "testing by regex matching"
27643 This condition is available only when Exim is compiled with the
27644 content-scanning extension, and is available only in the DATA, MIME, and
27645 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27646 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27647
27648 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27649 .cindex "&%sender_domains%& ACL condition"
27650 .cindex "sender" "ACL checking"
27651 .cindex "&ACL;" "testing a sender domain"
27652 .vindex "&$domain$&"
27653 .vindex "&$sender_address_domain$&"
27654 This condition tests the domain of the sender of the message against the given
27655 domain list. &*Note*&: The domain of the sender address is in
27656 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27657 of this condition. This is an exception to the general rule for testing domain
27658 lists. It is done this way so that, if this condition is used in an ACL for a
27659 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27660 influence the sender checking.
27661
27662 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27663 relaying, because sender addresses are easily, and commonly, forged.
27664
27665 .vitem &*senders&~=&~*&<&'address&~list'&>
27666 .cindex "&%senders%& ACL condition"
27667 .cindex "sender" "ACL checking"
27668 .cindex "&ACL;" "testing a sender"
27669 This condition tests the sender of the message against the given list. To test
27670 for a bounce message, which has an empty sender, set
27671 .code
27672 senders = :
27673 .endd
27674 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27675 relaying, because sender addresses are easily, and commonly, forged.
27676
27677 .vitem &*spam&~=&~*&<&'username'&>
27678 .cindex "&%spam%& ACL condition"
27679 .cindex "&ACL;" "scanning for spam"
27680 This condition is available only when Exim is compiled with the
27681 content-scanning extension. It causes the incoming message to be scanned by
27682 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
27683
27684 .vitem &*verify&~=&~certificate*&
27685 .cindex "&%verify%& ACL condition"
27686 .cindex "TLS" "client certificate verification"
27687 .cindex "certificate" "verification of client"
27688 .cindex "&ACL;" "certificate verification"
27689 .cindex "&ACL;" "testing a TLS certificate"
27690 This condition is true in an SMTP session if the session is encrypted, and a
27691 certificate was received from the client, and the certificate was verified. The
27692 server requests a certificate only if the client matches &%tls_verify_hosts%&
27693 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
27694
27695 .vitem &*verify&~=&~csa*&
27696 .cindex "CSA verification"
27697 This condition checks whether the sending host (the client) is authorized to
27698 send email. Details of how this works are given in section
27699 &<<SECTverifyCSA>>&.
27700
27701 .vitem &*verify&~=&~header_sender/*&<&'options'&>
27702 .cindex "&%verify%& ACL condition"
27703 .cindex "&ACL;" "verifying sender in the header"
27704 .cindex "header lines" "verifying the sender in"
27705 .cindex "sender" "verifying in header"
27706 .cindex "verifying" "sender in header"
27707 This condition is relevant only in an ACL that is run after a message has been
27708 received, that is, in an ACL specified by &%acl_smtp_data%& or
27709 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
27710 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
27711 is loosely thought of as a &"sender"& address (hence the name of the test).
27712 However, an address that appears in one of these headers need not be an address
27713 that accepts bounce messages; only sender addresses in envelopes are required
27714 to accept bounces. Therefore, if you use the callout option on this check, you
27715 might want to arrange for a non-empty address in the MAIL command.
27716
27717 Details of address verification and the options are given later, starting at
27718 section &<<SECTaddressverification>>& (callouts are described in section
27719 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
27720 condition to restrict it to bounce messages only:
27721 .code
27722 deny    senders = :
27723         message = A valid sender header is required for bounces
27724        !verify  = header_sender
27725 .endd
27726
27727 .vitem &*verify&~=&~header_syntax*&
27728 .cindex "&%verify%& ACL condition"
27729 .cindex "&ACL;" "verifying header syntax"
27730 .cindex "header lines" "verifying syntax"
27731 .cindex "verifying" "header syntax"
27732 This condition is relevant only in an ACL that is run after a message has been
27733 received, that is, in an ACL specified by &%acl_smtp_data%& or
27734 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
27735 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
27736 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
27737 permitted only in locally generated messages and from hosts that match
27738 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
27739 appropriate.
27740
27741 Note that this condition is a syntax check only. However, a common spamming
27742 ploy used to be to send syntactically invalid headers such as
27743 .code
27744 To: @
27745 .endd
27746 and this condition can be used to reject such messages, though they are not as
27747 common as they used to be.
27748
27749 .vitem &*verify&~=&~helo*&
27750 .cindex "&%verify%& ACL condition"
27751 .cindex "&ACL;" "verifying HELO/EHLO"
27752 .cindex "HELO" "verifying"
27753 .cindex "EHLO" "verifying"
27754 .cindex "verifying" "EHLO"
27755 .cindex "verifying" "HELO"
27756 This condition is true if a HELO or EHLO command has been received from the
27757 client host, and its contents have been verified. If there has been no previous
27758 attempt to verify the HELO/EHLO contents, it is carried out when this
27759 condition is encountered. See the description of the &%helo_verify_hosts%& and
27760 &%helo_try_verify_hosts%& options for details of how to request verification
27761 independently of this condition.
27762
27763 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
27764 option), this condition is always true.
27765
27766
27767 .vitem &*verify&~=&~not_blind*&
27768 .cindex "verifying" "not blind"
27769 .cindex "bcc recipients, verifying none"
27770 This condition checks that there are no blind (bcc) recipients in the message.
27771 Every envelope recipient must appear either in a &'To:'& header line or in a
27772 &'Cc:'& header line for this condition to be true. Local parts are checked
27773 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
27774 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
27775 used only in a DATA or non-SMTP ACL.
27776
27777 There are, of course, many legitimate messages that make use of blind (bcc)
27778 recipients. This check should not be used on its own for blocking messages.
27779
27780
27781 .vitem &*verify&~=&~recipient/*&<&'options'&>
27782 .cindex "&%verify%& ACL condition"
27783 .cindex "&ACL;" "verifying recipient"
27784 .cindex "recipient" "verifying"
27785 .cindex "verifying" "recipient"
27786 .vindex "&$address_data$&"
27787 This condition is relevant only after a RCPT command. It verifies the current
27788 recipient. Details of address verification are given later, starting at section
27789 &<<SECTaddressverification>>&. After a recipient has been verified, the value
27790 of &$address_data$& is the last value that was set while routing the address.
27791 This applies even if the verification fails. When an address that is being
27792 verified is redirected to a single address, verification continues with the new
27793 address, and in that case, the subsequent value of &$address_data$& is the
27794 value for the child address.
27795
27796 .vitem &*verify&~=&~reverse_host_lookup*&
27797 .cindex "&%verify%& ACL condition"
27798 .cindex "&ACL;" "verifying host reverse lookup"
27799 .cindex "host" "verifying reverse lookup"
27800 This condition ensures that a verified host name has been looked up from the IP
27801 address of the client host. (This may have happened already if the host name
27802 was needed for checking a host list, or if the host matched &%host_lookup%&.)
27803 Verification ensures that the host name obtained from a reverse DNS lookup, or
27804 one of its aliases, does, when it is itself looked up in the DNS, yield the
27805 original IP address.
27806
27807 If this condition is used for a locally generated message (that is, when there
27808 is no client host involved), it always succeeds.
27809
27810 .vitem &*verify&~=&~sender/*&<&'options'&>
27811 .cindex "&%verify%& ACL condition"
27812 .cindex "&ACL;" "verifying sender"
27813 .cindex "sender" "verifying"
27814 .cindex "verifying" "sender"
27815 This condition is relevant only after a MAIL or RCPT command, or after a
27816 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
27817 the message's sender is empty (that is, this is a bounce message), the
27818 condition is true. Otherwise, the sender address is verified.
27819
27820 .vindex "&$address_data$&"
27821 .vindex "&$sender_address_data$&"
27822 If there is data in the &$address_data$& variable at the end of routing, its
27823 value is placed in &$sender_address_data$& at the end of verification. This
27824 value can be used in subsequent conditions and modifiers in the same ACL
27825 statement. It does not persist after the end of the current statement. If you
27826 want to preserve the value for longer, you can save it in an ACL variable.
27827
27828 Details of verification are given later, starting at section
27829 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
27830 to avoid doing it more than once per message.
27831
27832 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
27833 .cindex "&%verify%& ACL condition"
27834 This is a variation of the previous option, in which a modified address is
27835 verified as a sender.
27836 .endlist
27837
27838
27839
27840 .section "Using DNS lists" "SECTmorednslists"
27841 .cindex "DNS list" "in ACL"
27842 .cindex "black list (DNS)"
27843 .cindex "&ACL;" "testing a DNS list"
27844 In its simplest form, the &%dnslists%& condition tests whether the calling host
27845 is on at least one of a number of DNS lists by looking up the inverted IP
27846 address in one or more DNS domains. (Note that DNS list domains are not mail
27847 domains, so the &`+`& syntax for named lists doesn't work - it is used for
27848 special options instead.) For example, if the calling host's IP
27849 address is 192.168.62.43, and the ACL statement is
27850 .code
27851 deny dnslists = blackholes.mail-abuse.org : \
27852                 dialups.mail-abuse.org
27853 .endd
27854 the following records are looked up:
27855 .code
27856 43.62.168.192.blackholes.mail-abuse.org
27857 43.62.168.192.dialups.mail-abuse.org
27858 .endd
27859 As soon as Exim finds an existing DNS record, processing of the list stops.
27860 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
27861 to test that a host is on more than one list (an &"and"& conjunction), you can
27862 use two separate conditions:
27863 .code
27864 deny dnslists = blackholes.mail-abuse.org
27865      dnslists = dialups.mail-abuse.org
27866 .endd
27867 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
27868 behaves as if the host does not match the list item, that is, as if the DNS
27869 record does not exist. If there are further items in the DNS list, they are
27870 processed.
27871
27872 This is usually the required action when &%dnslists%& is used with &%deny%&
27873 (which is the most common usage), because it prevents a DNS failure from
27874 blocking mail. However, you can change this behaviour by putting one of the
27875 following special items in the list:
27876 .display
27877 &`+include_unknown `&   behave as if the item is on the list
27878 &`+exclude_unknown `&   behave as if the item is not on the list (default)
27879 &`+defer_unknown   `&   give a temporary error
27880 .endd
27881 .cindex "&`+include_unknown`&"
27882 .cindex "&`+exclude_unknown`&"
27883 .cindex "&`+defer_unknown`&"
27884 Each of these applies to any subsequent items on the list. For example:
27885 .code
27886 deny dnslists = +defer_unknown : foo.bar.example
27887 .endd
27888 Testing the list of domains stops as soon as a match is found. If you want to
27889 warn for one list and block for another, you can use two different statements:
27890 .code
27891 deny  dnslists = blackholes.mail-abuse.org
27892 warn  message  = X-Warn: sending host is on dialups list
27893       dnslists = dialups.mail-abuse.org
27894 .endd
27895 DNS list lookups are cached by Exim for the duration of the SMTP session,
27896 so a lookup based on the IP address is done at most once for any incoming
27897 connection. Exim does not share information between multiple incoming
27898 connections (but your local name server cache should be active).
27899
27900
27901
27902 .section "Specifying the IP address for a DNS list lookup" "SECID201"
27903 .cindex "DNS list" "keyed by explicit IP address"
27904 By default, the IP address that is used in a DNS list lookup is the IP address
27905 of the calling host. However, you can specify another IP address by listing it
27906 after the domain name, introduced by a slash. For example:
27907 .code
27908 deny dnslists = black.list.tld/192.168.1.2
27909 .endd
27910 This feature is not very helpful with explicit IP addresses; it is intended for
27911 use with IP addresses that are looked up, for example, the IP addresses of the
27912 MX hosts or nameservers of an email sender address. For an example, see section
27913 &<<SECTmulkeyfor>>& below.
27914
27915
27916
27917
27918 .section "DNS lists keyed on domain names" "SECID202"
27919 .cindex "DNS list" "keyed by domain name"
27920 There are some lists that are keyed on domain names rather than inverted IP
27921 addresses (see for example the &'domain based zones'& link at
27922 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
27923 with these lists. You can change the name that is looked up in a DNS list by
27924 listing it after the domain name, introduced by a slash. For example,
27925 .code
27926 deny  message  = Sender's domain is listed at $dnslist_domain
27927       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
27928 .endd
27929 This particular example is useful only in ACLs that are obeyed after the
27930 RCPT or DATA commands, when a sender address is available. If (for
27931 example) the message's sender is &'user@tld.example'& the name that is looked
27932 up by this example is
27933 .code
27934 tld.example.dsn.rfc-ignorant.org
27935 .endd
27936 A single &%dnslists%& condition can contain entries for both names and IP
27937 addresses. For example:
27938 .code
27939 deny dnslists = sbl.spamhaus.org : \
27940                 dsn.rfc-ignorant.org/$sender_address_domain
27941 .endd
27942 The first item checks the sending host's IP address; the second checks a domain
27943 name. The whole condition is true if either of the DNS lookups succeeds.
27944
27945
27946
27947
27948 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
27949 .cindex "DNS list" "multiple keys for"
27950 The syntax described above for looking up explicitly-defined values (either
27951 names or IP addresses) in a DNS blacklist is a simplification. After the domain
27952 name for the DNS list, what follows the slash can in fact be a list of items.
27953 As with all lists in Exim, the default separator is a colon. However, because
27954 this is a sublist within the list of DNS blacklist domains, it is necessary
27955 either to double the separators like this:
27956 .code
27957 dnslists = black.list.tld/name.1::name.2
27958 .endd
27959 or to change the separator character, like this:
27960 .code
27961 dnslists = black.list.tld/<;name.1;name.2
27962 .endd
27963 If an item in the list is an IP address, it is inverted before the DNS
27964 blacklist domain is appended. If it is not an IP address, no inversion
27965 occurs. Consider this condition:
27966 .code
27967 dnslists = black.list.tld/<;192.168.1.2;a.domain
27968 .endd
27969 The DNS lookups that occur are:
27970 .code
27971 2.1.168.192.black.list.tld
27972 a.domain.black.list.tld
27973 .endd
27974 Once a DNS record has been found (that matches a specific IP return
27975 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
27976 are done. If there is a temporary DNS error, the rest of the sublist of domains
27977 or IP addresses is tried. A temporary error for the whole dnslists item occurs
27978 only if no other DNS lookup in this sublist succeeds. In other words, a
27979 successful lookup for any of the items in the sublist overrides a temporary
27980 error for a previous item.
27981
27982 The ability to supply a list of items after the slash is in some sense just a
27983 syntactic convenience. These two examples have the same effect:
27984 .code
27985 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
27986 dnslists = black.list.tld/a.domain::b.domain
27987 .endd
27988 However, when the data for the list is obtained from a lookup, the second form
27989 is usually much more convenient. Consider this example:
27990 .code
27991 deny message  = The mail servers for the domain \
27992                 $sender_address_domain \
27993                 are listed at $dnslist_domain ($dnslist_value); \
27994                 see $dnslist_text.
27995      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
27996                                    ${lookup dnsdb {>|mxh=\
27997                                    $sender_address_domain} }} }
27998 .endd
27999 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28000 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28001 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28002 of expanding the condition might be something like this:
28003 .code
28004 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28005 .endd
28006 Thus, this example checks whether or not the IP addresses of the sender
28007 domain's mail servers are on the Spamhaus black list.
28008
28009 The key that was used for a successful DNS list lookup is put into the variable
28010 &$dnslist_matched$& (see section &<<SECID204>>&).
28011
28012
28013
28014
28015 .section "Data returned by DNS lists" "SECID203"
28016 .cindex "DNS list" "data returned from"
28017 DNS lists are constructed using address records in the DNS. The original RBL
28018 just used the address 127.0.0.1 on the right hand side of each record, but the
28019 RBL+ list and some other lists use a number of values with different meanings.
28020 The values used on the RBL+ list are:
28021 .display
28022 127.1.0.1  RBL
28023 127.1.0.2  DUL
28024 127.1.0.3  DUL and RBL
28025 127.1.0.4  RSS
28026 127.1.0.5  RSS and RBL
28027 127.1.0.6  RSS and DUL
28028 127.1.0.7  RSS and DUL and RBL
28029 .endd
28030 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
28031 different values. Some DNS lists may return more than one address record;
28032 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
28033
28034
28035 .section "Variables set from DNS lists" "SECID204"
28036 .cindex "expansion" "variables, set from DNS list"
28037 .cindex "DNS list" "variables set from"
28038 .vindex "&$dnslist_domain$&"
28039 .vindex "&$dnslist_matched$&"
28040 .vindex "&$dnslist_text$&"
28041 .vindex "&$dnslist_value$&"
28042 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
28043 the name of the overall domain that matched (for example,
28044 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
28045 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
28046 the DNS record. When the key is an IP address, it is not reversed in
28047 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
28048 cases, for example:
28049 .code
28050 deny dnslists = spamhaus.example
28051 .endd
28052 the key is also available in another variable (in this case,
28053 &$sender_host_address$&). In more complicated cases, however, this is not true.
28054 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
28055 might generate a dnslists lookup like this:
28056 .code
28057 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
28058 .endd
28059 If this condition succeeds, the value in &$dnslist_matched$& might be
28060 &`192.168.6.7`& (for example).
28061
28062 If more than one address record is returned by the DNS lookup, all the IP
28063 addresses are included in &$dnslist_value$&, separated by commas and spaces.
28064 The variable &$dnslist_text$& contains the contents of any associated TXT
28065 record. For lists such as RBL+ the TXT record for a merged entry is often not
28066 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
28067 information.
28068
28069 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
28070 &-- although these appear before the condition in the ACL, they are not
28071 expanded until after it has failed. For example:
28072 .code
28073 deny    hosts = !+local_networks
28074         message = $sender_host_address is listed \
28075                   at $dnslist_domain
28076         dnslists = rbl-plus.mail-abuse.example
28077 .endd
28078
28079
28080
28081 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
28082 .cindex "DNS list" "matching specific returned data"
28083 You can add an equals sign and an IP address after a &%dnslists%& domain name
28084 in order to restrict its action to DNS records with a matching right hand side.
28085 For example,
28086 .code
28087 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
28088 .endd
28089 rejects only those hosts that yield 127.0.0.2. Without this additional data,
28090 any address record is considered to be a match. For the moment, we assume
28091 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
28092 describes how multiple records are handled.
28093
28094 More than one IP address may be given for checking, using a comma as a
28095 separator. These are alternatives &-- if any one of them matches, the
28096 &%dnslists%& condition is true. For example:
28097 .code
28098 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28099 .endd
28100 If you want to specify a constraining address list and also specify names or IP
28101 addresses to be looked up, the constraining address list must be specified
28102 first. For example:
28103 .code
28104 deny dnslists = dsn.rfc-ignorant.org\
28105                 =127.0.0.2/$sender_address_domain
28106 .endd
28107
28108 If the character &`&&`& is used instead of &`=`&, the comparison for each
28109 listed IP address is done by a bitwise &"and"& instead of by an equality test.
28110 In other words, the listed addresses are used as bit masks. The comparison is
28111 true if all the bits in the mask are present in the address that is being
28112 tested. For example:
28113 .code
28114 dnslists = a.b.c&0.0.0.3
28115 .endd
28116 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
28117 want to test whether one bit or another bit is present (as opposed to both
28118 being present), you must use multiple values. For example:
28119 .code
28120 dnslists = a.b.c&0.0.0.1,0.0.0.2
28121 .endd
28122 matches if the final component of the address is an odd number or two times
28123 an odd number.
28124
28125
28126
28127 .section "Negated DNS matching conditions" "SECID205"
28128 You can supply a negative list of IP addresses as part of a &%dnslists%&
28129 condition. Whereas
28130 .code
28131 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28132 .endd
28133 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28134 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
28135 .code
28136 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
28137 .endd
28138 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28139 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
28140 words, the result of the test is inverted if an exclamation mark appears before
28141 the &`=`& (or the &`&&`&) sign.
28142
28143 &*Note*&: This kind of negation is not the same as negation in a domain,
28144 host, or address list (which is why the syntax is different).
28145
28146 If you are using just one list, the negation syntax does not gain you much. The
28147 previous example is precisely equivalent to
28148 .code
28149 deny  dnslists = a.b.c
28150      !dnslists = a.b.c=127.0.0.2,127.0.0.3
28151 .endd
28152 However, if you are using multiple lists, the negation syntax is clearer.
28153 Consider this example:
28154 .code
28155 deny  dnslists = sbl.spamhaus.org : \
28156                  list.dsbl.org : \
28157                  dnsbl.njabl.org!=127.0.0.3 : \
28158                  relays.ordb.org
28159 .endd
28160 Using only positive lists, this would have to be:
28161 .code
28162 deny  dnslists = sbl.spamhaus.org : \
28163                  list.dsbl.org
28164 deny  dnslists = dnsbl.njabl.org
28165      !dnslists = dnsbl.njabl.org=127.0.0.3
28166 deny  dnslists = relays.ordb.org
28167 .endd
28168 which is less clear, and harder to maintain.
28169
28170
28171
28172
28173 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
28174 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
28175 thereby providing more than one IP address. When an item in a &%dnslists%& list
28176 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
28177 the match to specific results from the DNS lookup, there are two ways in which
28178 the checking can be handled. For example, consider the condition:
28179 .code
28180 dnslists = a.b.c=127.0.0.1
28181 .endd
28182 What happens if the DNS lookup for the incoming IP address yields both
28183 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
28184 condition true because at least one given value was found, or is it false
28185 because at least one of the found values was not listed? And how does this
28186 affect negated conditions? Both possibilities are provided for with the help of
28187 additional separators &`==`& and &`=&&`&.
28188
28189 .ilist
28190 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
28191 IP addresses matches one of the listed addresses. For the example above, the
28192 condition is true because 127.0.0.1 matches.
28193 .next
28194 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
28195 looked up IP addresses matches one of the listed addresses. If the condition is
28196 changed to:
28197 .code
28198 dnslists = a.b.c==127.0.0.1
28199 .endd
28200 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28201 false because 127.0.0.2 is not listed. You would need to have:
28202 .code
28203 dnslists = a.b.c==127.0.0.1,127.0.0.2
28204 .endd
28205 for the condition to be true.
28206 .endlist
28207
28208 When &`!`& is used to negate IP address matching, it inverts the result, giving
28209 the precise opposite of the behaviour above. Thus:
28210 .ilist
28211 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
28212 addresses matches one of the listed addresses. Consider:
28213 .code
28214 dnslists = a.b.c!&0.0.0.1
28215 .endd
28216 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28217 false because 127.0.0.1 matches.
28218 .next
28219 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
28220 looked up IP address that does not match. Consider:
28221 .code
28222 dnslists = a.b.c!=&0.0.0.1
28223 .endd
28224 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28225 true, because 127.0.0.2 does not match. You would need to have:
28226 .code
28227 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
28228 .endd
28229 for the condition to be false.
28230 .endlist
28231 When the DNS lookup yields only a single IP address, there is no difference
28232 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
28233
28234
28235
28236
28237 .section "Detailed information from merged DNS lists" "SECTmordetinf"
28238 .cindex "DNS list" "information from merged"
28239 When the facility for restricting the matching IP values in a DNS list is used,
28240 the text from the TXT record that is set in &$dnslist_text$& may not reflect
28241 the true reason for rejection. This happens when lists are merged and the IP
28242 address in the A record is used to distinguish them; unfortunately there is
28243 only one TXT record. One way round this is not to use merged lists, but that
28244 can be inefficient because it requires multiple DNS lookups where one would do
28245 in the vast majority of cases when the host of interest is not on any of the
28246 lists.
28247
28248 A less inefficient way of solving this problem is available. If
28249 two domain names, comma-separated, are given, the second is used first to
28250 do an initial check, making use of any IP value restrictions that are set.
28251 If there is a match, the first domain is used, without any IP value
28252 restrictions, to get the TXT record. As a byproduct of this, there is also
28253 a check that the IP being tested is indeed on the first list. The first
28254 domain is the one that is put in &$dnslist_domain$&. For example:
28255 .code
28256 reject message  = \
28257          rejected because $sender_host_address is blacklisted \
28258          at $dnslist_domain\n$dnslist_text
28259        dnslists = \
28260          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
28261          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28262 .endd
28263 For the first blacklist item, this starts by doing a lookup in
28264 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
28265 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
28266 value, and as long as something is found, it looks for the corresponding TXT
28267 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
28268 The second blacklist item is processed similarly.
28269
28270 If you are interested in more than one merged list, the same list must be
28271 given several times, but because the results of the DNS lookups are cached,
28272 the DNS calls themselves are not repeated. For example:
28273 .code
28274 reject dnslists = \
28275          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
28276          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
28277          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
28278          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28279 .endd
28280 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
28281 values matches (or if no record is found), this is the only lookup that is
28282 done. Only if there is a match is one of the more specific lists consulted.
28283
28284
28285
28286 .section "DNS lists and IPv6" "SECTmorednslistslast"
28287 .cindex "IPv6" "DNS black lists"
28288 .cindex "DNS list" "IPv6 usage"
28289 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
28290 nibble by nibble. For example, if the calling host's IP address is
28291 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
28292 .code
28293 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
28294   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
28295 .endd
28296 (split over two lines here to fit on the page). Unfortunately, some of the DNS
28297 lists contain wildcard records, intended for IPv4, that interact badly with
28298 IPv6. For example, the DNS entry
28299 .code
28300 *.3.some.list.example.    A    127.0.0.1
28301 .endd
28302 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
28303 Unfortunately, it also matches the entire 3::/4 IPv6 network.
28304
28305 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
28306 &%condition%& condition, as in this example:
28307 .code
28308 deny   condition = ${if isip4{$sender_host_address}}
28309        dnslists  = some.list.example
28310 .endd
28311
28312 .section "Rate limiting incoming messages" "SECTratelimiting"
28313 .cindex "rate limiting" "client sending"
28314 .cindex "limiting client sending rates"
28315 .oindex "&%smtp_ratelimit_*%&"
28316 The &%ratelimit%& ACL condition can be used to measure and control the rate at
28317 which clients can send email. This is more powerful than the
28318 &%smtp_ratelimit_*%& options, because those options control the rate of
28319 commands in a single SMTP session only, whereas the &%ratelimit%& condition
28320 works across all connections (concurrent and sequential) from the same client
28321 host. The syntax of the &%ratelimit%& condition is:
28322 .display
28323 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
28324 .endd
28325 If the average client sending rate is less than &'m'& messages per time
28326 period &'p'& then the condition is false; otherwise it is true.
28327
28328 As a side-effect, the &%ratelimit%& condition sets the expansion variable
28329 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
28330 configured value of &'m'&, and &$sender_rate_period$& to the configured value
28331 of &'p'&.
28332
28333 The parameter &'p'& is the smoothing time constant, in the form of an Exim
28334 time interval, for example, &`8h`& for eight hours. A larger time constant
28335 means that it takes Exim longer to forget a client's past behaviour. The
28336 parameter &'m'& is the maximum number of messages that a client is permitted to
28337 send in each time interval. It also specifies the number of messages permitted
28338 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
28339 constant, you can allow a client to send more messages in a burst without
28340 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
28341 both small, messages must be sent at an even rate.
28342
28343 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
28344 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
28345 when deploying the &%ratelimit%& ACL condition. The script prints usage
28346 instructions when it is run with no arguments.
28347
28348 The key is used to look up the data for calculating the client's average
28349 sending rate. This data is stored in Exim's spool directory, alongside the
28350 retry and other hints databases. The default key is &$sender_host_address$&,
28351 which means Exim computes the sending rate of each client host IP address.
28352 By changing the key you can change how Exim identifies clients for the purpose
28353 of ratelimiting. For example, to limit the sending rate of each authenticated
28354 user, independent of the computer they are sending from, set the key to
28355 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
28356 example, &$authenticated_id$& is only meaningful if the client has
28357 authenticated (which you can check with the &%authenticated%& ACL condition).
28358
28359 The lookup key does not have to identify clients: If you want to limit the
28360 rate at which a recipient receives messages, you can use the key
28361 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
28362 ACL.
28363
28364 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
28365 specifies what Exim measures the rate of, for example messages or recipients
28366 or bytes. You can adjust the measurement using the &%unique=%& and/or
28367 &%count=%& options. You can also control when Exim updates the recorded rate
28368 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
28369 separated by a slash, like the other parameters. They may appear in any order.
28370
28371 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
28372 any options that alter the meaning of the stored data. The limit &'m'& is not
28373 stored, so you can alter the configured maximum rate and Exim will still
28374 remember clients' past behaviour. If you change the &%per_*%& mode or add or
28375 remove the &%unique=%& option, the lookup key changes so Exim will forget past
28376 behaviour. The lookup key is not affected by changes to the update mode and
28377 the &%count=%& option.
28378
28379
28380 .section "Ratelimit options for what is being measured" "ratoptmea"
28381 .cindex "rate limiting" "per_* options"
28382 The &%per_conn%& option limits the client's connection rate. It is not
28383 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
28384 &%acl_not_smtp_start%& ACLs.
28385
28386 The &%per_mail%& option limits the client's rate of sending messages. This is
28387 the default if none of the &%per_*%& options is specified. It can be used in
28388 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
28389 &%acl_smtp_data%&, or &%acl_not_smtp%&.
28390
28391 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
28392 the same ACLs as the &%per_mail%& option, though it is best to use this option
28393 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
28394 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
28395 in its MAIL command, which may be inaccurate or completely missing. You can
28396 follow the limit &'m'& in the configuration with K, M, or G to specify limits
28397 in kilobytes, megabytes, or gigabytes, respectively.
28398
28399 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
28400 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28401 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
28402 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
28403 ACLs the rate is updated with the total recipient count in one go. Note that
28404 in either case the rate limiting engine will see a message with many
28405 recipients as a large high-speed burst.
28406
28407 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
28408 number of different recipients that the client has sent messages to in the
28409 last time period. That is, if the client repeatedly sends messages to the same
28410 recipient, its measured rate is not increased. This option can only be used in
28411 &%acl_smtp_rcpt%&.
28412
28413 The &%per_cmd%& option causes Exim to recompute the rate every time the
28414 condition is processed. This can be used to limit the rate of any SMTP
28415 command. If it is used in multiple ACLs it can limit the aggregate rate of
28416 multiple different commands.
28417
28418 The &%count=%& option can be used to alter how much Exim adds to the client's
28419 measured rate. For example, the &%per_byte%& option is equivalent to
28420 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
28421 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
28422 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
28423
28424 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
28425
28426
28427 .section "Ratelimit update modes" "ratoptupd"
28428 .cindex "rate limiting" "reading data without updating"
28429 You can specify one of three options with the &%ratelimit%& condition to
28430 control when its database is updated. This section describes the &%readonly%&
28431 mode, and the next section describes the &%strict%& and &%leaky%& modes.
28432
28433 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
28434 previously-computed rate to check against the limit.
28435
28436 For example, you can test the client's sending rate and deny it access (when
28437 it is too fast) in the connect ACL. If the client passes this check then it
28438 can go on to send a message, in which case its recorded rate will be updated
28439 in the MAIL ACL. Subsequent connections from the same client will check this
28440 new rate.
28441 .code
28442 acl_check_connect:
28443  deny ratelimit = 100 / 5m / readonly
28444     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
28445                   (max $sender_rate_limit)
28446 # ...
28447 acl_check_mail:
28448  warn ratelimit = 100 / 5m / strict
28449     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
28450                   (max $sender_rate_limit)
28451 .endd
28452
28453 If Exim encounters multiple &%ratelimit%& conditions with the same key when
28454 processing a message then it may increase the client's measured rate more than
28455 it should. For example, this will happen if you check the &%per_rcpt%& option
28456 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
28457 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
28458 multiple update problems by using the &%readonly%& option on later ratelimit
28459 checks.
28460
28461 The &%per_*%& options described above do not make sense in some ACLs. If you
28462 use a &%per_*%& option in an ACL where it is not normally permitted then the
28463 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
28464 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
28465 next section) so you must specify the &%readonly%& option explicitly.
28466
28467
28468 .section "Ratelimit options for handling fast clients" "ratoptfast"
28469 .cindex "rate limiting" "strict and leaky modes"
28470 If a client's average rate is greater than the maximum, the rate limiting
28471 engine can react in two possible ways, depending on the presence of the
28472 &%strict%& or &%leaky%& update modes. This is independent of the other
28473 counter-measures (such as rejecting the message) that may be specified by the
28474 rest of the ACL.
28475
28476 The &%leaky%& (default) option means that the client's recorded rate is not
28477 updated if it is above the limit. The effect of this is that Exim measures the
28478 client's average rate of successfully sent email, which cannot be greater than
28479 the maximum allowed. If the client is over the limit it may suffer some
28480 counter-measures (as specified in the ACL), but it will still be able to send
28481 email at the configured maximum rate, whatever the rate of its attempts. This
28482 is generally the better choice if you have clients that retry automatically.
28483 For example, it does not prevent a sender with an over-aggressive retry rate
28484 from getting any email through.
28485
28486 The &%strict%& option means that the client's recorded rate is always
28487 updated. The effect of this is that Exim measures the client's average rate
28488 of attempts to send email, which can be much higher than the maximum it is
28489 actually allowed. If the client is over the limit it may be subjected to
28490 counter-measures by the ACL. It must slow down and allow sufficient time to
28491 pass that its computed rate falls below the maximum before it can send email
28492 again. The time (the number of smoothing periods) it must wait and not
28493 attempt to send mail can be calculated with this formula:
28494 .code
28495         ln(peakrate/maxrate)
28496 .endd
28497
28498
28499 .section "Limiting the rate of different events" "ratoptuniq"
28500 .cindex "rate limiting" "counting unique events"
28501 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
28502 rate of different events. For example, the &%per_addr%& option uses this
28503 mechanism to count the number of different recipients that the client has
28504 sent messages to in the last time period; it is equivalent to
28505 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
28506 measure the rate that a client uses different sender addresses with the
28507 options &`per_mail/unique=$sender_address`&.
28508
28509 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
28510 has seen for that key. The whole set is thrown away when it is older than the
28511 rate smoothing period &'p'&, so each different event is counted at most once
28512 per period. In the &%leaky%& update mode, an event that causes the client to
28513 go over the limit is not added to the set, in the same way that the client's
28514 recorded rate is not updated in the same situation.
28515
28516 When you combine the &%unique=%& and &%readonly%& options, the specific
28517 &%unique=%& value is ignored, and Exim just retrieves the client's stored
28518 rate.
28519
28520 The &%unique=%& mechanism needs more space in the ratelimit database than the
28521 other &%ratelimit%& options in order to store the event set. The number of
28522 unique values is potentially as large as the rate limit, so the extra space
28523 required increases with larger limits.
28524
28525 The uniqueification is not perfect: there is a small probability that Exim
28526 will think a new event has happened before. If the sender's rate is less than
28527 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28528 the measured rate can go above the limit, in which case Exim may under-count
28529 events by a significant margin. Fortunately, if the rate is high enough (2.7
28530 times the limit) that the false positive rate goes above 9%, then Exim will
28531 throw away the over-full event set before the measured rate falls below the
28532 limit. Therefore the only harm should be that exceptionally high sending rates
28533 are logged incorrectly; any countermeasures you configure will be as effective
28534 as intended.
28535
28536
28537 .section "Using rate limiting" "useratlim"
28538 Exim's other ACL facilities are used to define what counter-measures are taken
28539 when the rate limit is exceeded. This might be anything from logging a warning
28540 (for example, while measuring existing sending rates in order to define
28541 policy), through time delays to slow down fast senders, up to rejecting the
28542 message. For example:
28543 .code
28544 # Log all senders' rates
28545 warn ratelimit = 0 / 1h / strict
28546      log_message = Sender rate $sender_rate / $sender_rate_period
28547
28548 # Slow down fast senders; note the need to truncate $sender_rate
28549 # at the decimal point.
28550 warn ratelimit = 100 / 1h / per_rcpt / strict
28551      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28552                    $sender_rate_limit }s
28553
28554 # Keep authenticated users under control
28555 deny authenticated = *
28556      ratelimit = 100 / 1d / strict / $authenticated_id
28557
28558 # System-wide rate limit
28559 defer message = Sorry, too busy. Try again later.
28560      ratelimit = 10 / 1s / $primary_hostname
28561
28562 # Restrict incoming rate from each host, with a default
28563 # set using a macro and special cases looked up in a table.
28564 defer message = Sender rate exceeds $sender_rate_limit \
28565                messages per $sender_rate_period
28566      ratelimit = ${lookup {$sender_host_address} \
28567                    cdb {DB/ratelimits.cdb} \
28568                    {$value} {RATELIMIT} }
28569 .endd
28570 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28571 especially with the &%per_rcpt%& option, you may suffer from a performance
28572 bottleneck caused by locking on the ratelimit hints database. Apart from
28573 making your ACLs less complicated, you can reduce the problem by using a
28574 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28575 this means that Exim will lose its hints data after a reboot (including retry
28576 hints, the callout cache, and ratelimit data).
28577
28578
28579
28580 .section "Address verification" "SECTaddressverification"
28581 .cindex "verifying address" "options for"
28582 .cindex "policy control" "address verification"
28583 Several of the &%verify%& conditions described in section
28584 &<<SECTaclconditions>>& cause addresses to be verified. Section
28585 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28586 The verification conditions can be followed by options that modify the
28587 verification process. The options are separated from the keyword and from each
28588 other by slashes, and some of them contain parameters. For example:
28589 .code
28590 verify = sender/callout
28591 verify = recipient/defer_ok/callout=10s,defer_ok
28592 .endd
28593 The first stage of address verification, which always happens, is to run the
28594 address through the routers, in &"verify mode"&. Routers can detect the
28595 difference between verification and routing for delivery, and their actions can
28596 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28597 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28598 The available options are as follows:
28599
28600 .ilist
28601 If the &%callout%& option is specified, successful routing to one or more
28602 remote hosts is followed by a &"callout"& to those hosts as an additional
28603 check. Callouts and their sub-options are discussed in the next section.
28604 .next
28605 If there is a defer error while doing verification routing, the ACL
28606 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28607 options, the condition is forced to be true instead. Note that this is a main
28608 verification option as well as a suboption for callouts.
28609 .next
28610 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28611 discusses the reporting of sender address verification failures.
28612 .next
28613 The &%success_on_redirect%& option causes verification always to succeed
28614 immediately after a successful redirection. By default, if a redirection
28615 generates just one address, that address is also verified. See further
28616 discussion in section &<<SECTredirwhilveri>>&.
28617 .endlist
28618
28619 .cindex "verifying address" "differentiating failures"
28620 .vindex "&$recipient_verify_failure$&"
28621 .vindex "&$sender_verify_failure$&"
28622 .vindex "&$acl_verify_message$&"
28623 After an address verification failure, &$acl_verify_message$& contains the
28624 error message that is associated with the failure. It can be preserved by
28625 coding like this:
28626 .code
28627 warn  !verify = sender
28628        set acl_m0 = $acl_verify_message
28629 .endd
28630 If you are writing your own custom rejection message or log message when
28631 denying access, you can use this variable to include information about the
28632 verification failure.
28633
28634 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28635 appropriate) contains one of the following words:
28636
28637 .ilist
28638 &%qualify%&: The address was unqualified (no domain), and the message
28639 was neither local nor came from an exempted host.
28640 .next
28641 &%route%&: Routing failed.
28642 .next
28643 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28644 occurred at or before the MAIL command (that is, on initial
28645 connection, HELO, or MAIL).
28646 .next
28647 &%recipient%&: The RCPT command in a callout was rejected.
28648 .next
28649 &%postmaster%&: The postmaster check in a callout was rejected.
28650 .endlist
28651
28652 The main use of these variables is expected to be to distinguish between
28653 rejections of MAIL and rejections of RCPT in callouts.
28654
28655
28656
28657
28658 .section "Callout verification" "SECTcallver"
28659 .cindex "verifying address" "by callout"
28660 .cindex "callout" "verification"
28661 .cindex "SMTP" "callout verification"
28662 For non-local addresses, routing verifies the domain, but is unable to do any
28663 checking of the local part. There are situations where some means of verifying
28664 the local part is desirable. One way this can be done is to make an SMTP
28665 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28666 a subsequent host for a recipient address, to see if the host accepts the
28667 address. We use the term &'callout'& to cover both cases. Note that for a
28668 sender address, the callback is not to the client host that is trying to
28669 deliver the message, but to one of the hosts that accepts incoming mail for the
28670 sender's domain.
28671
28672 Exim does not do callouts by default. If you want them to happen, you must
28673 request them by setting appropriate options on the &%verify%& condition, as
28674 described below. This facility should be used with care, because it can add a
28675 lot of resource usage to the cost of verifying an address. However, Exim does
28676 cache the results of callouts, which helps to reduce the cost. Details of
28677 caching are in section &<<SECTcallvercache>>&.
28678
28679 Recipient callouts are usually used only between hosts that are controlled by
28680 the same administration. For example, a corporate gateway host could use
28681 callouts to check for valid recipients on an internal mailserver. A successful
28682 callout does not guarantee that a real delivery to the address would succeed;
28683 on the other hand, a failing callout does guarantee that a delivery would fail.
28684
28685 If the &%callout%& option is present on a condition that verifies an address, a
28686 second stage of verification occurs if the address is successfully routed to
28687 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
28688 &(manualroute)& router, where the router specifies the hosts. However, if a
28689 router that does not set up hosts routes to an &(smtp)& transport with a
28690 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
28691 &%hosts_override%& set, its hosts are always used, whether or not the router
28692 supplies a host list.
28693
28694 The port that is used is taken from the transport, if it is specified and is a
28695 remote transport. (For routers that do verification only, no transport need be
28696 specified.) Otherwise, the default SMTP port is used. If a remote transport
28697 specifies an outgoing interface, this is used; otherwise the interface is not
28698 specified. Likewise, the text that is used for the HELO command is taken from
28699 the transport's &%helo_data%& option; if there is no transport, the value of
28700 &$smtp_active_hostname$& is used.
28701
28702 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
28703 test whether a bounce message could be delivered to the sender address. The
28704 following SMTP commands are sent:
28705 .display
28706 &`HELO `&<&'local host name'&>
28707 &`MAIL FROM:<>`&
28708 &`RCPT TO:`&<&'the address to be tested'&>
28709 &`QUIT`&
28710 .endd
28711 LHLO is used instead of HELO if the transport's &%protocol%& option is
28712 set to &"lmtp"&.
28713
28714 A recipient callout check is similar. By default, it also uses an empty address
28715 for the sender. This default is chosen because most hosts do not make use of
28716 the sender address when verifying a recipient. Using the same address means
28717 that a single cache entry can be used for each recipient. Some sites, however,
28718 do make use of the sender address when verifying. These are catered for by the
28719 &%use_sender%& and &%use_postmaster%& options, described in the next section.
28720
28721 If the response to the RCPT command is a 2&'xx'& code, the verification
28722 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
28723 Exim tries the next host, if any. If there is a problem with all the remote
28724 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
28725 &%callout%& option is given, in which case the condition is forced to succeed.
28726
28727 .cindex "SMTP" "output flushing, disabling for callout"
28728 A callout may take a little time. For this reason, Exim normally flushes SMTP
28729 output before performing a callout in an ACL, to avoid unexpected timeouts in
28730 clients when the SMTP PIPELINING extension is in use. The flushing can be
28731 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
28732
28733
28734
28735
28736 .section "Additional parameters for callouts" "CALLaddparcall"
28737 .cindex "callout" "additional parameters for"
28738 The &%callout%& option can be followed by an equals sign and a number of
28739 optional parameters, separated by commas. For example:
28740 .code
28741 verify = recipient/callout=10s,defer_ok
28742 .endd
28743 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
28744 separate verify options, is retained for backwards compatibility, but is now
28745 deprecated. The additional parameters for &%callout%& are as follows:
28746
28747
28748 .vlist
28749 .vitem <&'a&~time&~interval'&>
28750 .cindex "callout" "timeout, specifying"
28751 This specifies the timeout that applies for the callout attempt to each host.
28752 For example:
28753 .code
28754 verify = sender/callout=5s
28755 .endd
28756 The default is 30 seconds. The timeout is used for each response from the
28757 remote host. It is also used for the initial connection, unless overridden by
28758 the &%connect%& parameter.
28759
28760
28761 .vitem &*connect&~=&~*&<&'time&~interval'&>
28762 .cindex "callout" "connection timeout, specifying"
28763 This parameter makes it possible to set a different (usually smaller) timeout
28764 for making the SMTP connection. For example:
28765 .code
28766 verify = sender/callout=5s,connect=1s
28767 .endd
28768 If not specified, this timeout defaults to the general timeout value.
28769
28770 .vitem &*defer_ok*&
28771 .cindex "callout" "defer, action on"
28772 When this parameter is present, failure to contact any host, or any other kind
28773 of temporary error, is treated as success by the ACL. However, the cache is not
28774 updated in this circumstance.
28775
28776 .vitem &*fullpostmaster*&
28777 .cindex "callout" "full postmaster check"
28778 This operates like the &%postmaster%& option (see below), but if the check for
28779 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
28780 accordance with the specification in RFC 2821. The RFC states that the
28781 unqualified address &'postmaster'& should be accepted.
28782
28783
28784 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
28785 .cindex "callout" "sender when verifying header"
28786 When verifying addresses in header lines using the &%header_sender%&
28787 verification option, Exim behaves by default as if the addresses are envelope
28788 sender addresses from a message. Callout verification therefore tests to see
28789 whether a bounce message could be delivered, by using an empty address in the
28790 MAIL command. However, it is arguable that these addresses might never be used
28791 as envelope senders, and could therefore justifiably reject bounce messages
28792 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
28793 address to use in the MAIL command. For example:
28794 .code
28795 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
28796 .endd
28797 This parameter is available only for the &%header_sender%& verification option.
28798
28799
28800 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
28801 .cindex "callout" "overall timeout, specifying"
28802 This parameter sets an overall timeout for performing a callout verification.
28803 For example:
28804 .code
28805 verify = sender/callout=5s,maxwait=30s
28806 .endd
28807 This timeout defaults to four times the callout timeout for individual SMTP
28808 commands. The overall timeout applies when there is more than one host that can
28809 be tried. The timeout is checked before trying the next host. This prevents
28810 very long delays if there are a large number of hosts and all are timing out
28811 (for example, when network connections are timing out).
28812
28813
28814 .vitem &*no_cache*&
28815 .cindex "callout" "cache, suppressing"
28816 .cindex "caching callout, suppressing"
28817 When this parameter is given, the callout cache is neither read nor updated.
28818
28819 .vitem &*postmaster*&
28820 .cindex "callout" "postmaster; checking"
28821 When this parameter is set, a successful callout check is followed by a similar
28822 check for the local part &'postmaster'& at the same domain. If this address is
28823 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
28824 the postmaster check is recorded in a cache record; if it is a failure, this is
28825 used to fail subsequent callouts for the domain without a connection being
28826 made, until the cache record expires.
28827
28828 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
28829 The postmaster check uses an empty sender in the MAIL command by default.
28830 You can use this parameter to do a postmaster check using a different address.
28831 For example:
28832 .code
28833 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
28834 .endd
28835 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
28836 one overrides. The &%postmaster%& parameter is equivalent to this example:
28837 .code
28838 require  verify = sender/callout=postmaster_mailfrom=
28839 .endd
28840 &*Warning*&: The caching arrangements for postmaster checking do not take
28841 account of the sender address. It is assumed that either the empty address or
28842 a fixed non-empty address will be used. All that Exim remembers is that the
28843 postmaster check for the domain succeeded or failed.
28844
28845
28846 .vitem &*random*&
28847 .cindex "callout" "&""random""& check"
28848 When this parameter is set, before doing the normal callout check, Exim does a
28849 check for a &"random"& local part at the same domain. The local part is not
28850 really random &-- it is defined by the expansion of the option
28851 &%callout_random_local_part%&, which defaults to
28852 .code
28853 $primary_hostname-$tod_epoch-testing
28854 .endd
28855 The idea here is to try to determine whether the remote host accepts all local
28856 parts without checking. If it does, there is no point in doing callouts for
28857 specific local parts. If the &"random"& check succeeds, the result is saved in
28858 a cache record, and used to force the current and subsequent callout checks to
28859 succeed without a connection being made, until the cache record expires.
28860
28861 .vitem &*use_postmaster*&
28862 .cindex "callout" "sender for recipient check"
28863 This parameter applies to recipient callouts only. For example:
28864 .code
28865 deny  !verify = recipient/callout=use_postmaster
28866 .endd
28867 .vindex "&$qualify_domain$&"
28868 It causes a non-empty postmaster address to be used in the MAIL command when
28869 performing the callout for the recipient, and also for a &"random"& check if
28870 that is configured. The local part of the address is &`postmaster`& and the
28871 domain is the contents of &$qualify_domain$&.
28872
28873 .vitem &*use_sender*&
28874 This option applies to recipient callouts only. For example:
28875 .code
28876 require  verify = recipient/callout=use_sender
28877 .endd
28878 It causes the message's actual sender address to be used in the MAIL
28879 command when performing the callout, instead of an empty address. There is no
28880 need to use this option unless you know that the called hosts make use of the
28881 sender when checking recipients. If used indiscriminately, it reduces the
28882 usefulness of callout caching.
28883 .endlist
28884
28885 If you use any of the parameters that set a non-empty sender for the MAIL
28886 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
28887 &%use_sender%&), you should think about possible loops. Recipient checking is
28888 usually done between two hosts that are under the same management, and the host
28889 that receives the callouts is not normally configured to do callouts itself.
28890 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
28891 these circumstances.
28892
28893 However, if you use a non-empty sender address for a callout to an arbitrary
28894 host, there is the likelihood that the remote host will itself initiate a
28895 callout check back to your host. As it is checking what appears to be a message
28896 sender, it is likely to use an empty address in MAIL, thus avoiding a
28897 callout loop. However, to be on the safe side it would be best to set up your
28898 own ACLs so that they do not do sender verification checks when the recipient
28899 is the address you use for header sender or postmaster callout checking.
28900
28901 Another issue to think about when using non-empty senders for callouts is
28902 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
28903 by the sender/recipient combination; thus, for any given recipient, many more
28904 actual callouts are performed than when an empty sender or postmaster is used.
28905
28906
28907
28908
28909 .section "Callout caching" "SECTcallvercache"
28910 .cindex "hints database" "callout cache"
28911 .cindex "callout" "cache, description of"
28912 .cindex "caching" "callout"
28913 Exim caches the results of callouts in order to reduce the amount of resources
28914 used, unless you specify the &%no_cache%& parameter with the &%callout%&
28915 option. A hints database called &"callout"& is used for the cache. Two
28916 different record types are used: one records the result of a callout check for
28917 a specific address, and the other records information that applies to the
28918 entire domain (for example, that it accepts the local part &'postmaster'&).
28919
28920 When an original callout fails, a detailed SMTP error message is given about
28921 the failure. However, for subsequent failures use the cache data, this message
28922 is not available.
28923
28924 The expiry times for negative and positive address cache records are
28925 independent, and can be set by the global options &%callout_negative_expire%&
28926 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
28927
28928 If a host gives a negative response to an SMTP connection, or rejects any
28929 commands up to and including
28930 .code
28931 MAIL FROM:<>
28932 .endd
28933 (but not including the MAIL command with a non-empty address),
28934 any callout attempt is bound to fail. Exim remembers such failures in a
28935 domain cache record, which it uses to fail callouts for the domain without
28936 making new connections, until the domain record times out. There are two
28937 separate expiry times for domain cache records:
28938 &%callout_domain_negative_expire%& (default 3h) and
28939 &%callout_domain_positive_expire%& (default 7d).
28940
28941 Domain records expire when the negative expiry time is reached if callouts
28942 cannot be made for the domain, or if the postmaster check failed.
28943 Otherwise, they expire when the positive expiry time is reached. This
28944 ensures that, for example, a host that stops accepting &"random"& local parts
28945 will eventually be noticed.
28946
28947 The callout caching mechanism is based on the domain of the address that is
28948 being tested. If the domain routes to several hosts, it is assumed that their
28949 behaviour will be the same.
28950
28951
28952
28953 .section "Sender address verification reporting" "SECTsenaddver"
28954 .cindex "verifying" "suppressing error details"
28955 See section &<<SECTaddressverification>>& for a general discussion of
28956 verification. When sender verification fails in an ACL, the details of the
28957 failure are given as additional output lines before the 550 response to the
28958 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
28959 you might see:
28960 .code
28961 MAIL FROM:<xyz@abc.example>
28962 250 OK
28963 RCPT TO:<pqr@def.example>
28964 550-Verification failed for <xyz@abc.example>
28965 550-Called:   192.168.34.43
28966 550-Sent:     RCPT TO:<xyz@abc.example>
28967 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
28968 550 Sender verification failed
28969 .endd
28970 If more than one RCPT command fails in the same way, the details are given
28971 only for the first of them. However, some administrators do not want to send
28972 out this much information. You can suppress the details by adding
28973 &`/no_details`& to the ACL statement that requests sender verification. For
28974 example:
28975 .code
28976 verify = sender/no_details
28977 .endd
28978
28979 .section "Redirection while verifying" "SECTredirwhilveri"
28980 .cindex "verifying" "redirection while"
28981 .cindex "address redirection" "while verifying"
28982 A dilemma arises when a local address is redirected by aliasing or forwarding
28983 during verification: should the generated addresses themselves be verified,
28984 or should the successful expansion of the original address be enough to verify
28985 it? By default, Exim takes the following pragmatic approach:
28986
28987 .ilist
28988 When an incoming address is redirected to just one child address, verification
28989 continues with the child address, and if that fails to verify, the original
28990 verification also fails.
28991 .next
28992 When an incoming address is redirected to more than one child address,
28993 verification does not continue. A success result is returned.
28994 .endlist
28995
28996 This seems the most reasonable behaviour for the common use of aliasing as a
28997 way of redirecting different local parts to the same mailbox. It means, for
28998 example, that a pair of alias entries of the form
28999 .code
29000 A.Wol:   aw123
29001 aw123:   :fail: Gone away, no forwarding address
29002 .endd
29003 work as expected, with both local parts causing verification failure. When a
29004 redirection generates more than one address, the behaviour is more like a
29005 mailing list, where the existence of the alias itself is sufficient for
29006 verification to succeed.
29007
29008 It is possible, however, to change the default behaviour so that all successful
29009 redirections count as successful verifications, however many new addresses are
29010 generated. This is specified by the &%success_on_redirect%& verification
29011 option. For example:
29012 .code
29013 require verify = recipient/success_on_redirect/callout=10s
29014 .endd
29015 In this example, verification succeeds if a router generates a new address, and
29016 the callout does not occur, because no address was routed to a remote host.
29017
29018 When verification is being tested via the &%-bv%& option, the treatment of
29019 redirections is as just described, unless the &%-v%& or any debugging option is
29020 also specified. In that case, full verification is done for every generated
29021 address and a report is output for each of them.
29022
29023
29024
29025 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
29026 .cindex "CSA" "verifying"
29027 Client SMTP Authorization is a system that allows a site to advertise
29028 which machines are and are not permitted to send email. This is done by placing
29029 special SRV records in the DNS; these are looked up using the client's HELO
29030 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
29031 Authorization checks in Exim are performed by the ACL condition:
29032 .code
29033 verify = csa
29034 .endd
29035 This fails if the client is not authorized. If there is a DNS problem, or if no
29036 valid CSA SRV record is found, or if the client is authorized, the condition
29037 succeeds. These three cases can be distinguished using the expansion variable
29038 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
29039 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
29040 be likely to cause problems for legitimate email.
29041
29042 The error messages produced by the CSA code include slightly more
29043 detail. If &$csa_status$& is &"defer"&, this may be because of problems
29044 looking up the CSA SRV record, or problems looking up the CSA target
29045 address record. There are four reasons for &$csa_status$& being &"fail"&:
29046
29047 .ilist
29048 The client's host name is explicitly not authorized.
29049 .next
29050 The client's IP address does not match any of the CSA target IP addresses.
29051 .next
29052 The client's host name is authorized but it has no valid target IP addresses
29053 (for example, the target's addresses are IPv6 and the client is using IPv4).
29054 .next
29055 The client's host name has no CSA SRV record but a parent domain has asserted
29056 that all subdomains must be explicitly authorized.
29057 .endlist
29058
29059 The &%csa%& verification condition can take an argument which is the domain to
29060 use for the DNS query. The default is:
29061 .code
29062 verify = csa/$sender_helo_name
29063 .endd
29064 This implementation includes an extension to CSA. If the query domain
29065 is an address literal such as [192.0.2.95], or if it is a bare IP
29066 address, Exim searches for CSA SRV records in the reverse DNS as if
29067 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
29068 meaningful to say:
29069 .code
29070 verify = csa/$sender_host_address
29071 .endd
29072 In fact, this is the check that Exim performs if the client does not say HELO.
29073 This extension can be turned off by setting the main configuration option
29074 &%dns_csa_use_reverse%& to be false.
29075
29076 If a CSA SRV record is not found for the domain itself, a search
29077 is performed through its parent domains for a record which might be
29078 making assertions about subdomains. The maximum depth of this search is limited
29079 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
29080 default. Exim does not look for CSA SRV records in a top level domain, so the
29081 default settings handle HELO domains as long as seven
29082 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
29083 of legitimate HELO domains.
29084
29085 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
29086 direct SRV lookups, this is not sufficient because of the extra parent domain
29087 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
29088 addresses into lookups in the reverse DNS space. The result of a successful
29089 lookup such as:
29090 .code
29091 ${lookup dnsdb {csa=$sender_helo_name}}
29092 .endd
29093 has two space-separated fields: an authorization code and a target host name.
29094 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
29095 authorization required but absent, or &"?"& for unknown.
29096
29097
29098
29099
29100 .section "Bounce address tag validation" "SECTverifyPRVS"
29101 .cindex "BATV, verifying"
29102 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
29103 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
29104 Genuine incoming bounce messages should therefore always be addressed to
29105 recipients that have a valid tag. This scheme is a way of detecting unwanted
29106 bounce messages caused by sender address forgeries (often called &"collateral
29107 spam"&), because the recipients of such messages do not include valid tags.
29108
29109 There are two expansion items to help with the implementation of the BATV
29110 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
29111 the original envelope sender address by using a simple key to add a hash of the
29112 address and some time-based randomizing information. The &%prvs%& expansion
29113 item creates a signed address, and the &%prvscheck%& expansion item checks one.
29114 The syntax of these expansion items is described in section
29115 &<<SECTexpansionitems>>&.
29116
29117 As an example, suppose the secret per-address keys are stored in an MySQL
29118 database. A query to look up the key for an address could be defined as a macro
29119 like this:
29120 .code
29121 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
29122                 WHERE sender='${quote_mysql:$prvscheck_address}'\
29123                 }{$value}}
29124 .endd
29125 Suppose also that the senders who make use of BATV are defined by an address
29126 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
29127 use this:
29128 .code
29129 # Bounces: drop unsigned addresses for BATV senders
29130 deny message = This address does not send an unsigned reverse path
29131      senders = :
29132      recipients = +batv_senders
29133
29134 # Bounces: In case of prvs-signed address, check signature.
29135 deny message = Invalid reverse path signature.
29136      senders = :
29137      condition  = ${prvscheck {$local_part@$domain}\
29138                   {PRVSCHECK_SQL}{1}}
29139      !condition = $prvscheck_result
29140 .endd
29141 The first statement rejects recipients for bounce messages that are addressed
29142 to plain BATV sender addresses, because it is known that BATV senders do not
29143 send out messages with plain sender addresses. The second statement rejects
29144 recipients that are prvs-signed, but with invalid signatures (either because
29145 the key is wrong, or the signature has timed out).
29146
29147 A non-prvs-signed address is not rejected by the second statement, because the
29148 &%prvscheck%& expansion yields an empty string if its first argument is not a
29149 prvs-signed address, thus causing the &%condition%& condition to be false. If
29150 the first argument is a syntactically valid prvs-signed address, the yield is
29151 the third string (in this case &"1"&), whether or not the cryptographic and
29152 timeout checks succeed. The &$prvscheck_result$& variable contains the result
29153 of the checks (empty for failure, &"1"& for success).
29154
29155 There is one more issue you must consider when implementing prvs-signing:
29156 you have to ensure that the routers accept prvs-signed addresses and
29157 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
29158 router to remove the signature with a configuration along these lines:
29159 .code
29160 batv_redirect:
29161   driver = redirect
29162   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
29163 .endd
29164 This works because, if the third argument of &%prvscheck%& is empty, the result
29165 of the expansion of a prvs-signed address is the decoded value of the original
29166 address. This router should probably be the first of your routers that handles
29167 local addresses.
29168
29169 To create BATV-signed addresses in the first place, a transport of this form
29170 can be used:
29171 .code
29172 external_smtp_batv:
29173   driver = smtp
29174   return_path = ${prvs {$return_path} \
29175                        {${lookup mysql{SELECT \
29176                        secret FROM batv_prvs WHERE \
29177                        sender='${quote_mysql:$sender_address}'} \
29178                        {$value}fail}}}
29179 .endd
29180 If no key can be found for the existing return path, no signing takes place.
29181
29182
29183
29184 .section "Using an ACL to control relaying" "SECTrelaycontrol"
29185 .cindex "&ACL;" "relay control"
29186 .cindex "relaying" "control by ACL"
29187 .cindex "policy control" "relay control"
29188 An MTA is said to &'relay'& a message if it receives it from some host and
29189 delivers it directly to another host as a result of a remote address contained
29190 within it. Redirecting a local address via an alias or forward file and then
29191 passing the message on to another host is not relaying,
29192 .cindex "&""percent hack""&"
29193 but a redirection as a result of the &"percent hack"& is.
29194
29195 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
29196 A host which is acting as a gateway or an MX backup is concerned with incoming
29197 relaying from arbitrary hosts to a specific set of domains. On the other hand,
29198 a host which is acting as a smart host for a number of clients is concerned
29199 with outgoing relaying from those clients to the Internet at large. Often the
29200 same host is fulfilling both functions,
29201 . ///
29202 . as illustrated in the diagram below,
29203 . ///
29204 but in principle these two kinds of relaying are entirely independent. What is
29205 not wanted is the transmission of mail from arbitrary remote hosts through your
29206 system to arbitrary domains.
29207
29208
29209 You can implement relay control by means of suitable statements in the ACL that
29210 runs for each RCPT command. For convenience, it is often easiest to use
29211 Exim's named list facility to define the domains and hosts involved. For
29212 example, suppose you want to do the following:
29213
29214 .ilist
29215 Deliver a number of domains to mailboxes on the local host (or process them
29216 locally in some other way). Let's say these are &'my.dom1.example'& and
29217 &'my.dom2.example'&.
29218 .next
29219 Relay mail for a number of other domains for which you are the secondary MX.
29220 These might be &'friend1.example'& and &'friend2.example'&.
29221 .next
29222 Relay mail from the hosts on your local LAN, to whatever domains are involved.
29223 Suppose your LAN is 192.168.45.0/24.
29224 .endlist
29225
29226
29227 In the main part of the configuration, you put the following definitions:
29228 .code
29229 domainlist local_domains    = my.dom1.example : my.dom2.example
29230 domainlist relay_to_domains = friend1.example : friend2.example
29231 hostlist   relay_from_hosts = 192.168.45.0/24
29232 .endd
29233 Now you can use these definitions in the ACL that is run for every RCPT
29234 command:
29235 .code
29236 acl_check_rcpt:
29237   accept domains = +local_domains : +relay_to_domains
29238   accept hosts   = +relay_from_hosts
29239 .endd
29240 The first statement accepts any RCPT command that contains an address in
29241 the local or relay domains. For any other domain, control passes to the second
29242 statement, which accepts the command only if it comes from one of the relay
29243 hosts. In practice, you will probably want to make your ACL more sophisticated
29244 than this, for example, by including sender and recipient verification. The
29245 default configuration includes a more comprehensive example, which is described
29246 in chapter &<<CHAPdefconfil>>&.
29247
29248
29249
29250 .section "Checking a relay configuration" "SECTcheralcon"
29251 .cindex "relaying" "checking control of"
29252 You can check the relay characteristics of your configuration in the same way
29253 that you can test any ACL behaviour for an incoming SMTP connection, by using
29254 the &%-bh%& option to run a fake SMTP session with which you interact.
29255
29256 For specifically testing for unwanted relaying, the host
29257 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
29258 host from the host on which Exim is running, using the normal telnet port, you
29259 will see a normal telnet connection message and then quite a long delay. Be
29260 patient. The remote host is making an SMTP connection back to your host, and
29261 trying a number of common probes to test for open relay vulnerability. The
29262 results of the tests will eventually appear on your terminal.
29263 .ecindex IIDacl
29264
29265
29266
29267 . ////////////////////////////////////////////////////////////////////////////
29268 . ////////////////////////////////////////////////////////////////////////////
29269
29270 .chapter "Content scanning at ACL time" "CHAPexiscan"
29271 .scindex IIDcosca "content scanning" "at ACL time"
29272 The extension of Exim to include content scanning at ACL time, formerly known
29273 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
29274 was integrated into the main source for Exim release 4.50, and Tom continues to
29275 maintain it. Most of the wording of this chapter is taken from Tom's
29276 specification.
29277
29278 It is also possible to scan the content of messages at other times. The
29279 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
29280 scanning after all the ACLs have run. A transport filter can be used to scan
29281 messages at delivery time (see the &%transport_filter%& option, described in
29282 chapter &<<CHAPtransportgeneric>>&).
29283
29284 If you want to include the ACL-time content-scanning features when you compile
29285 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
29286 &_Local/Makefile_&. When you do that, the Exim binary is built with:
29287
29288 .ilist
29289 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
29290 for all MIME parts for SMTP and non-SMTP messages, respectively.
29291 .next
29292 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
29293 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
29294 run at the end of message reception (the &%acl_smtp_data%& ACL).
29295 .next
29296 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
29297 of messages, or parts of messages, for debugging purposes.
29298 .next
29299 Additional expansion variables that are set in the new ACL and by the new
29300 conditions.
29301 .next
29302 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
29303 .endlist
29304
29305 There is another content-scanning configuration option for &_Local/Makefile_&,
29306 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
29307 condition is compiled, in addition to all the other content-scanning features.
29308
29309 Content-scanning is continually evolving, and new features are still being
29310 added. While such features are still unstable and liable to incompatible
29311 changes, they are made available in Exim by setting options whose names begin
29312 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
29313 this manual. You can find out about them by reading the file called
29314 &_doc/experimental.txt_&.
29315
29316 All the content-scanning facilities work on a MBOX copy of the message that is
29317 temporarily created in a file called:
29318 .display
29319 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
29320 .endd
29321 The &_.eml_& extension is a friendly hint to virus scanners that they can
29322 expect an MBOX-like structure inside that file. The file is created when the
29323 first content scanning facility is called. Subsequent calls to content
29324 scanning conditions open the same file again. The directory is recursively
29325 removed when the &%acl_smtp_data%& ACL has finished running, unless
29326 .code
29327 control = no_mbox_unspool
29328 .endd
29329 has been encountered. When the MIME ACL decodes files, they are put into the
29330 same directory by default.
29331
29332
29333
29334 .section "Scanning for viruses" "SECTscanvirus"
29335 .cindex "virus scanning"
29336 .cindex "content scanning" "for viruses"
29337 .cindex "content scanning" "the &%malware%& condition"
29338 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
29339 It supports a &"generic"& interface to scanners called via the shell, and
29340 specialized interfaces for &"daemon"& type virus scanners, which are resident
29341 in memory and thus are much faster.
29342
29343
29344 .oindex "&%av_scanner%&"
29345 You can set the &%av_scanner%& option in first part of the Exim configuration
29346 file to specify which scanner to use, together with any additional options that
29347 are needed. The basic syntax is as follows:
29348 .display
29349 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
29350 .endd
29351 If you do not set &%av_scanner%&, it defaults to
29352 .code
29353 av_scanner = sophie:/var/run/sophie
29354 .endd
29355 If the value of &%av_scanner%& starts with a dollar character, it is expanded
29356 before use. The following scanner types are supported in this release:
29357
29358 .vlist
29359 .vitem &%aveserver%&
29360 .cindex "virus scanners" "Kaspersky"
29361 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
29362 at &url(http://www.kaspersky.com). This scanner type takes one option,
29363 which is the path to the daemon's UNIX socket. The default is shown in this
29364 example:
29365 .code
29366 av_scanner = aveserver:/var/run/aveserver
29367 .endd
29368
29369
29370 .vitem &%clamd%&
29371 .cindex "virus scanners" "clamd"
29372 This daemon-type scanner is GPL and free. You can get it at
29373 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
29374 unpack MIME containers, so it used to be recommended to unpack MIME attachments
29375 in the MIME ACL. This no longer believed to be necessary. One option is
29376 required: either the path and name of a UNIX socket file, or a hostname or IP
29377 number, and a port, separated by space, as in the second of these examples:
29378 .code
29379 av_scanner = clamd:/opt/clamd/socket
29380 av_scanner = clamd:192.0.2.3 1234
29381 av_scanner = clamd:192.0.2.3 1234:local
29382 .endd
29383 If the value of av_scanner points to a UNIX socket file or contains the local
29384 keyword, then the ClamAV interface will pass a filename containing the data
29385 to be scanned, which will should normally result in less I/O happening and be
29386 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
29387 Exim does not assume that there is a common filesystem with the remote host.
29388 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
29389 you be running a version of ClamAV prior to 0.95.
29390 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
29391 contributing the code for this scanner.
29392
29393 .vitem &%cmdline%&
29394 .cindex "virus scanners" "command line interface"
29395 This is the keyword for the generic command line scanner interface. It can be
29396 used to attach virus scanners that are invoked from the shell. This scanner
29397 type takes 3 mandatory options:
29398
29399 .olist
29400 The full path and name of the scanner binary, with all command line options,
29401 and a placeholder (&`%s`&) for the directory to scan.
29402
29403 .next
29404 A regular expression to match against the STDOUT and STDERR output of the
29405 virus scanner. If the expression matches, a virus was found. You must make
29406 absolutely sure that this expression matches on &"virus found"&. This is called
29407 the &"trigger"& expression.
29408
29409 .next
29410 Another regular expression, containing exactly one pair of parentheses, to
29411 match the name of the virus found in the scanners output. This is called the
29412 &"name"& expression.
29413 .endlist olist
29414
29415 For example, Sophos Sweep reports a virus on a line like this:
29416 .code
29417 Virus 'W32/Magistr-B' found in file ./those.bat
29418 .endd
29419 For the trigger expression, we can match the phrase &"found in file"&. For the
29420 name expression, we want to extract the W32/Magistr-B string, so we can match
29421 for the single quotes left and right of it. Altogether, this makes the
29422 configuration setting:
29423 .code
29424 av_scanner = cmdline:\
29425              /path/to/sweep -ss -all -rec -archive %s:\
29426              found in file:'(.+)'
29427 .endd
29428 .vitem &%drweb%&
29429 .cindex "virus scanners" "DrWeb"
29430 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
29431 argument, either a full path to a UNIX socket, or an IP address and port
29432 separated by white space, as in these examples:
29433 .code
29434 av_scanner = drweb:/var/run/drwebd.sock
29435 av_scanner = drweb:192.168.2.20 31337
29436 .endd
29437 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
29438 is used. Thanks to Alex Miller for contributing the code for this scanner.
29439
29440 .vitem &%fsecure%&
29441 .cindex "virus scanners" "F-Secure"
29442 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
29443 argument which is the path to a UNIX socket. For example:
29444 .code
29445 av_scanner = fsecure:/path/to/.fsav
29446 .endd
29447 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
29448 Thelmen for contributing the code for this scanner.
29449
29450 .vitem &%kavdaemon%&
29451 .cindex "virus scanners" "Kaspersky"
29452 This is the scanner daemon of Kaspersky Version 4. This version of the
29453 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
29454 scanner type takes one option, which is the path to the daemon's UNIX socket.
29455 For example:
29456 .code
29457 av_scanner = kavdaemon:/opt/AVP/AvpCtl
29458 .endd
29459 The default path is &_/var/run/AvpCtl_&.
29460
29461 .vitem &%mksd%&
29462 .cindex "virus scanners" "mksd"
29463 This is a daemon type scanner that is aimed mainly at Polish users, though some
29464 parts of documentation are now available in English. You can get it at
29465 &url(http://linux.mks.com.pl/). The only option for this scanner type is
29466 the maximum number of processes used simultaneously to scan the attachments,
29467 provided that the demime facility is employed and also provided that mksd has
29468 been run with at least the same number of child processes. For example:
29469 .code
29470 av_scanner = mksd:2
29471 .endd
29472 You can safely omit this option (the default value is 1).
29473
29474 .vitem &%sophie%&
29475 .cindex "virus scanners" "Sophos and Sophie"
29476 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
29477 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
29478 for this scanner type is the path to the UNIX socket that Sophie uses for
29479 client communication. For example:
29480 .code
29481 av_scanner = sophie:/tmp/sophie
29482 .endd
29483 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
29484 the option.
29485 .endlist
29486
29487 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
29488 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
29489 ACL.
29490
29491 The &%av_scanner%& option is expanded each time &%malware%& is called. This
29492 makes it possible to use different scanners. See further below for an example.
29493 The &%malware%& condition caches its results, so when you use it multiple times
29494 for the same message, the actual scanning process is only carried out once.
29495 However, using expandable items in &%av_scanner%& disables this caching, in
29496 which case each use of the &%malware%& condition causes a new scan of the
29497 message.
29498
29499 The &%malware%& condition takes a right-hand argument that is expanded before
29500 use. It can then be one of
29501
29502 .ilist
29503 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
29504 The condition succeeds if a virus was found, and fail otherwise. This is the
29505 recommended usage.
29506 .next
29507 &"false"& or &"0"& or an empty string, in which case no scanning is done and
29508 the condition fails immediately.
29509 .next
29510 A regular expression, in which case the message is scanned for viruses. The
29511 condition succeeds if a virus is found and its name matches the regular
29512 expression. This allows you to take special actions on certain types of virus.
29513 .endlist
29514
29515 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
29516 even if there is a problem with the virus scanner. Otherwise, such a problem
29517 causes the ACL to defer.
29518
29519 .vindex "&$malware_name$&"
29520 When a virus is found, the condition sets up an expansion variable called
29521 &$malware_name$& that contains the name of the virus. You can use it in a
29522 &%message%& modifier that specifies the error returned to the sender, and/or in
29523 logging data.
29524
29525 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29526 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29527 &%malware%& condition.
29528
29529 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29530 imposed by your anti-virus scanner.
29531
29532 Here is a very simple scanning example:
29533 .code
29534 deny message = This message contains malware ($malware_name)
29535      demime = *
29536      malware = *
29537 .endd
29538 The next example accepts messages when there is a problem with the scanner:
29539 .code
29540 deny message = This message contains malware ($malware_name)
29541      demime = *
29542      malware = */defer_ok
29543 .endd
29544 The next example shows how to use an ACL variable to scan with both sophie and
29545 aveserver. It assumes you have set:
29546 .code
29547 av_scanner = $acl_m0
29548 .endd
29549 in the main Exim configuration.
29550 .code
29551 deny message = This message contains malware ($malware_name)
29552      set acl_m0 = sophie
29553      malware = *
29554
29555 deny message = This message contains malware ($malware_name)
29556      set acl_m0 = aveserver
29557      malware = *
29558 .endd
29559
29560
29561 .section "Scanning with SpamAssassin" "SECTscanspamass"
29562 .cindex "content scanning" "for spam"
29563 .cindex "spam scanning"
29564 .cindex "SpamAssassin"
29565 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29566 score and a report for the message. You can get SpamAssassin at
29567 &url(http://www.spamassassin.org), or, if you have a working Perl
29568 installation, you can use CPAN by running:
29569 .code
29570 perl -MCPAN -e 'install Mail::SpamAssassin'
29571 .endd
29572 SpamAssassin has its own set of configuration files. Please review its
29573 documentation to see how you can tweak it. The default installation should work
29574 nicely, however.
29575
29576 .oindex "&%spamd_address%&"
29577 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29578 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29579 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29580 part of the Exim configuration as follows (example):
29581 .code
29582 spamd_address = 192.168.99.45 387
29583 .endd
29584 You do not need to set this option if you use the default. As of version 2.60,
29585 &%spamd%& also supports communication over UNIX sockets. If you want to use
29586 these, supply &%spamd_address%& with an absolute file name instead of a
29587 address/port pair:
29588 .code
29589 spamd_address = /var/run/spamd_socket
29590 .endd
29591 You can have multiple &%spamd%& servers to improve scalability. These can
29592 reside on other hardware reachable over the network. To specify multiple
29593 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29594 option, separated with colons:
29595 .code
29596 spamd_address = 192.168.2.10 783 : \
29597                 192.168.2.11 783 : \
29598                 192.168.2.12 783
29599 .endd
29600 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29601 fashion. When a server fails to respond to the connection attempt, all other
29602 servers are tried until one succeeds. If no server responds, the &%spam%&
29603 condition defers.
29604
29605 &*Warning*&: It is not possible to use the UNIX socket connection method with
29606 multiple &%spamd%& servers.
29607
29608 The &%spamd_address%& variable is expanded before use if it starts with
29609 a dollar sign. In this case, the expansion may return a string that is
29610 used as the list so that multiple spamd servers can be the result of an
29611 expansion.
29612
29613 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29614 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29615 .code
29616 deny message = This message was classified as SPAM
29617      spam = joe
29618 .endd
29619 The right-hand side of the &%spam%& condition specifies a name. This is
29620 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29621 to scan using a specific profile, but rather use the SpamAssassin system-wide
29622 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29623 However, you must put something on the right-hand side.
29624
29625 The name allows you to use per-domain or per-user antispam profiles in
29626 principle, but this is not straightforward in practice, because a message may
29627 have multiple recipients, not necessarily all in the same domain. Because the
29628 &%spam%& condition has to be called from a DATA ACL in order to be able to
29629 read the contents of the message, the variables &$local_part$& and &$domain$&
29630 are not set.
29631
29632 The right-hand side of the &%spam%& condition is expanded before being used, so
29633 you can put lookups or conditions there. When the right-hand side evaluates to
29634 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
29635
29636
29637 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
29638 large ones may cause significant performance degradation. As most spam messages
29639 are quite small, it is recommended that you do not scan the big ones. For
29640 example:
29641 .code
29642 deny message = This message was classified as SPAM
29643      condition = ${if < {$message_size}{10K}}
29644      spam = nobody
29645 .endd
29646
29647 The &%spam%& condition returns true if the threshold specified in the user's
29648 SpamAssassin profile has been matched or exceeded. If you want to use the
29649 &%spam%& condition for its side effects (see the variables below), you can make
29650 it always return &"true"& by appending &`:true`& to the username.
29651
29652 .cindex "spam scanning" "returned variables"
29653 When the &%spam%& condition is run, it sets up a number of expansion
29654 variables. These variables are saved with the received message, thus they are
29655 available for use at delivery time.
29656
29657 .vlist
29658 .vitem &$spam_score$&
29659 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
29660 for inclusion in log or reject messages.
29661
29662 .vitem &$spam_score_int$&
29663 The spam score of the message, multiplied by ten, as an integer value. For
29664 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
29665 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
29666 The integer value is useful for numeric comparisons in conditions.
29667
29668 .vitem &$spam_bar$&
29669 A string consisting of a number of &"+"& or &"-"& characters, representing the
29670 integer part of the spam score value. A spam score of 4.4 would have a
29671 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
29672 headers, since MUAs can match on such strings.
29673
29674 .vitem &$spam_report$&
29675 A multiline text table, containing the full SpamAssassin report for the
29676 message. Useful for inclusion in headers or reject messages.
29677 .endlist
29678
29679 The &%spam%& condition caches its results unless expansion in
29680 spamd_address was used. If you call it again with the same user name, it
29681 does not scan again, but rather returns the same values as before.
29682
29683 The &%spam%& condition returns DEFER if there is any error while running
29684 the message through SpamAssassin or if the expansion of spamd_address
29685 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
29686 statement block), append &`/defer_ok`& to the right-hand side of the
29687 spam condition, like this:
29688 .code
29689 deny message = This message was classified as SPAM
29690      spam    = joe/defer_ok
29691 .endd
29692 This causes messages to be accepted even if there is a problem with &%spamd%&.
29693
29694 Here is a longer, commented example of the use of the &%spam%&
29695 condition:
29696 .code
29697 # put headers in all messages (no matter if spam or not)
29698 warn  spam = nobody:true
29699       add_header = X-Spam-Score: $spam_score ($spam_bar)
29700       add_header = X-Spam-Report: $spam_report
29701
29702 # add second subject line with *SPAM* marker when message
29703 # is over threshold
29704 warn  spam = nobody
29705       add_header = Subject: *SPAM* $h_Subject:
29706
29707 # reject spam at high scores (> 12)
29708 deny  message = This message scored $spam_score spam points.
29709       spam = nobody:true
29710       condition = ${if >{$spam_score_int}{120}{1}{0}}
29711 .endd
29712
29713
29714
29715 .section "Scanning MIME parts" "SECTscanmimepart"
29716 .cindex "content scanning" "MIME parts"
29717 .cindex "MIME content scanning"
29718 .oindex "&%acl_smtp_mime%&"
29719 .oindex "&%acl_not_smtp_mime%&"
29720 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
29721 each MIME part of an SMTP message, including multipart types, in the sequence
29722 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
29723 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
29724 options may both refer to the same ACL if you want the same processing in both
29725 cases.
29726
29727 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
29728 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
29729 the case of a non-SMTP message. However, a MIME ACL is called only if the
29730 message contains a &'Content-Type:'& header line. When a call to a MIME
29731 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
29732 result code is sent to the client. In the case of an SMTP message, the
29733 &%acl_smtp_data%& ACL is not called when this happens.
29734
29735 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
29736 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
29737 condition to match against the raw MIME part. You can also use the
29738 &%mime_regex%& condition to match against the decoded MIME part (see section
29739 &<<SECTscanregex>>&).
29740
29741 At the start of a MIME ACL, a number of variables are set from the header
29742 information for the relevant MIME part. These are described below. The contents
29743 of the MIME part are not by default decoded into a disk file except for MIME
29744 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
29745 part into a disk file, you can use the &%decode%& condition. The general
29746 syntax is:
29747 .display
29748 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
29749 .endd
29750 The right hand side is expanded before use. After expansion,
29751 the value can be:
29752
29753 .olist
29754 &"0"& or &"false"&, in which case no decoding is done.
29755 .next
29756 The string &"default"&. In that case, the file is put in the temporary
29757 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
29758 a sequential file name consisting of the message id and a sequence number. The
29759 full path and name is available in &$mime_decoded_filename$& after decoding.
29760 .next
29761 A full path name starting with a slash. If the full name is an existing
29762 directory, it is used as a replacement for the default directory. The filename
29763 is then sequentially assigned. If the path does not exist, it is used as
29764 the full path and file name.
29765 .next
29766 If the string does not start with a slash, it is used as the
29767 filename, and the default path is then used.
29768 .endlist
29769 The &%decode%& condition normally succeeds. It is only false for syntax
29770 errors or unusual circumstances such as memory shortages. You can easily decode
29771 a file with its original, proposed filename using
29772 .code
29773 decode = $mime_filename
29774 .endd
29775 However, you should keep in mind that &$mime_filename$& might contain
29776 anything. If you place files outside of the default path, they are not
29777 automatically unlinked.
29778
29779 For RFC822 attachments (these are messages attached to messages, with a
29780 content-type of &"message/rfc822"&), the ACL is called again in the same manner
29781 as for the primary message, only that the &$mime_is_rfc822$& expansion
29782 variable is set (see below). Attached messages are always decoded to disk
29783 before being checked, and the files are unlinked once the check is done.
29784
29785 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
29786 used to match regular expressions against raw and decoded MIME parts,
29787 respectively. They are described in section &<<SECTscanregex>>&.
29788
29789 .cindex "MIME content scanning" "returned variables"
29790 The following list describes all expansion variables that are
29791 available in the MIME ACL:
29792
29793 .vlist
29794 .vitem &$mime_boundary$&
29795 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
29796 have a boundary string, which is stored in this variable. If the current part
29797 has no boundary parameter in the &'Content-Type:'& header, this variable
29798 contains the empty string.
29799
29800 .vitem &$mime_charset$&
29801 This variable contains the character set identifier, if one was found in the
29802 &'Content-Type:'& header. Examples for charset identifiers are:
29803 .code
29804 us-ascii
29805 gb2312 (Chinese)
29806 iso-8859-1
29807 .endd
29808 Please note that this value is not normalized, so you should do matches
29809 case-insensitively.
29810
29811 .vitem &$mime_content_description$&
29812 This variable contains the normalized content of the &'Content-Description:'&
29813 header. It can contain a human-readable description of the parts content. Some
29814 implementations repeat the filename for attachments here, but they are usually
29815 only used for display purposes.
29816
29817 .vitem &$mime_content_disposition$&
29818 This variable contains the normalized content of the &'Content-Disposition:'&
29819 header. You can expect strings like &"attachment"& or &"inline"& here.
29820
29821 .vitem &$mime_content_id$&
29822 This variable contains the normalized content of the &'Content-ID:'& header.
29823 This is a unique ID that can be used to reference a part from another part.
29824
29825 .vitem &$mime_content_size$&
29826 This variable is set only after the &%decode%& modifier (see above) has been
29827 successfully run. It contains the size of the decoded part in kilobytes. The
29828 size is always rounded up to full kilobytes, so only a completely empty part
29829 has a &$mime_content_size$& of zero.
29830
29831 .vitem &$mime_content_transfer_encoding$&
29832 This variable contains the normalized content of the
29833 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
29834 type. Typical values are &"base64"& and &"quoted-printable"&.
29835
29836 .vitem &$mime_content_type$&
29837 If the MIME part has a &'Content-Type:'& header, this variable contains its
29838 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
29839 are some examples of popular MIME types, as they may appear in this variable:
29840 .code
29841 text/plain
29842 text/html
29843 application/octet-stream
29844 image/jpeg
29845 audio/midi
29846 .endd
29847 If the MIME part has no &'Content-Type:'& header, this variable contains the
29848 empty string.
29849
29850 .vitem &$mime_decoded_filename$&
29851 This variable is set only after the &%decode%& modifier (see above) has been
29852 successfully run. It contains the full path and file name of the file
29853 containing the decoded data.
29854 .endlist
29855
29856 .cindex "RFC 2047"
29857 .vlist
29858 .vitem &$mime_filename$&
29859 This is perhaps the most important of the MIME variables. It contains a
29860 proposed filename for an attachment, if one was found in either the
29861 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
29862 RFC2047 decoded, but no additional sanity checks are done. If no filename was
29863 found, this variable contains the empty string.
29864
29865 .vitem &$mime_is_coverletter$&
29866 This variable attempts to differentiate the &"cover letter"& of an e-mail from
29867 attached data. It can be used to clamp down on flashy or unnecessarily encoded
29868 content in the cover letter, while not restricting attachments at all.
29869
29870 The variable contains 1 (true) for a MIME part believed to be part of the
29871 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
29872 follows:
29873
29874 .olist
29875 The outermost MIME part of a message is always a cover letter.
29876
29877 .next
29878 If a multipart/alternative or multipart/related MIME part is a cover letter,
29879 so are all MIME subparts within that multipart.
29880
29881 .next
29882 If any other multipart is a cover letter, the first subpart is a cover letter,
29883 and the rest are attachments.
29884
29885 .next
29886 All parts contained within an attachment multipart are attachments.
29887 .endlist olist
29888
29889 As an example, the following will ban &"HTML mail"& (including that sent with
29890 alternative plain text), while allowing HTML files to be attached. HTML
29891 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
29892 .code
29893 deny message = HTML mail is not accepted here
29894 !condition = $mime_is_rfc822
29895 condition = $mime_is_coverletter
29896 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
29897 .endd
29898 .vitem &$mime_is_multipart$&
29899 This variable has the value 1 (true) when the current part has the main type
29900 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
29901 Since multipart entities only serve as containers for other parts, you may not
29902 want to carry out specific actions on them.
29903
29904 .vitem &$mime_is_rfc822$&
29905 This variable has the value 1 (true) if the current part is not a part of the
29906 checked message itself, but part of an attached message. Attached message
29907 decoding is fully recursive.
29908
29909 .vitem &$mime_part_count$&
29910 This variable is a counter that is raised for each processed MIME part. It
29911 starts at zero for the very first part (which is usually a multipart). The
29912 counter is per-message, so it is reset when processing RFC822 attachments (see
29913 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
29914 complete, so you can use it in the DATA ACL to determine the number of MIME
29915 parts of a message. For non-MIME messages, this variable contains the value -1.
29916 .endlist
29917
29918
29919
29920 .section "Scanning with regular expressions" "SECTscanregex"
29921 .cindex "content scanning" "with regular expressions"
29922 .cindex "regular expressions" "content scanning with"
29923 You can specify your own custom regular expression matches on the full body of
29924 the message, or on individual MIME parts.
29925
29926 The &%regex%& condition takes one or more regular expressions as arguments and
29927 matches them against the full message (when called in the DATA ACL) or a raw
29928 MIME part (when called in the MIME ACL). The &%regex%& condition matches
29929 linewise, with a maximum line length of 32K characters. That means you cannot
29930 have multiline matches with the &%regex%& condition.
29931
29932 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
29933 to 32K of decoded content (the whole content at once, not linewise). If the
29934 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
29935 is decoded automatically when &%mime_regex%& is executed (using default path
29936 and filename values). If the decoded data is larger than  32K, only the first
29937 32K characters are checked.
29938
29939 The regular expressions are passed as a colon-separated list. To include a
29940 literal colon, you must double it. Since the whole right-hand side string is
29941 expanded before being used, you must also escape dollar signs and backslashes
29942 with more backslashes, or use the &`\N`& facility to disable expansion.
29943 Here is a simple example that contains two regular expressions:
29944 .code
29945 deny message = contains blacklisted regex ($regex_match_string)
29946      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
29947 .endd
29948 The conditions returns true if any one of the regular expressions matches. The
29949 &$regex_match_string$& expansion variable is then set up and contains the
29950 matching regular expression.
29951
29952 &*Warning*&: With large messages, these conditions can be fairly
29953 CPU-intensive.
29954
29955
29956
29957
29958 .section "The demime condition" "SECTdemimecond"
29959 .cindex "content scanning" "MIME checking"
29960 .cindex "MIME content scanning"
29961 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
29962 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
29963 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
29964 ACL functionality, but provides no additional facilities. Please note that this
29965 condition is deprecated and kept only for backward compatibility. You must set
29966 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
29967 use the &%demime%& condition.
29968
29969 The &%demime%& condition unpacks MIME containers in the message. It detects
29970 errors in MIME containers and can match file extensions found in the message
29971 against a list. Using this facility produces files containing the unpacked MIME
29972 parts of the message in the temporary scan directory. If you do antivirus
29973 scanning, it is recommended that you use the &%demime%& condition before the
29974 antivirus (&%malware%&) condition.
29975
29976 On the right-hand side of the &%demime%& condition you can pass a
29977 colon-separated list of file extensions that it should match against. For
29978 example:
29979 .code
29980 deny message = Found blacklisted file attachment
29981      demime  = vbs:com:bat:pif:prf:lnk
29982 .endd
29983 If one of the file extensions is found, the condition is true, otherwise it is
29984 false. If there is a temporary error while demimeing (for example, &"disk
29985 full"&), the condition defers, and the message is temporarily rejected (unless
29986 the condition is on a &%warn%& verb).
29987
29988 The right-hand side is expanded before being treated as a list, so you can have
29989 conditions and lookups there. If it expands to an empty string, &"false"&, or
29990 zero (&"0"&), no demimeing is done and the condition is false.
29991
29992 The &%demime%& condition set the following variables:
29993
29994 .vlist
29995 .vitem &$demime_errorlevel$&
29996 .vindex "&$demime_errorlevel$&"
29997 When an error is detected in a MIME container, this variable contains the
29998 severity of the error, as an integer number. The higher the value, the more
29999 severe the error (the current maximum value is 3). If this variable is unset or
30000 zero, no error occurred.
30001
30002 .vitem &$demime_reason$&
30003 .vindex "&$demime_reason$&"
30004 When &$demime_errorlevel$& is greater than zero, this variable contains a
30005 human-readable text string describing the MIME error that occurred.
30006 .endlist
30007
30008 .vlist
30009 .vitem &$found_extension$&
30010 .vindex "&$found_extension$&"
30011 When the &%demime%& condition is true, this variable contains the file
30012 extension it found.
30013 .endlist
30014
30015 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
30016 the &%demime%& condition, and are not changed on subsequent calls.
30017
30018 If you do not want to check for file extensions, but rather use the &%demime%&
30019 condition for unpacking or error checking purposes, pass &"*"& as the
30020 right-hand side value. Here is a more elaborate example of how to use this
30021 facility:
30022 .code
30023 # Reject messages with serious MIME container errors
30024 deny  message = Found MIME error ($demime_reason).
30025       demime = *
30026       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
30027
30028 # Reject known virus spreading file extensions.
30029 # Accepting these is pretty much braindead.
30030 deny  message = contains $found_extension file (blacklisted).
30031       demime  = com:vbs:bat:pif:scr
30032
30033 # Freeze .exe and .doc files. Postmaster can
30034 # examine them and eventually thaw them.
30035 deny  log_message = Another $found_extension file.
30036       demime = exe:doc
30037       control = freeze
30038 .endd
30039 .ecindex IIDcosca
30040
30041
30042
30043
30044 . ////////////////////////////////////////////////////////////////////////////
30045 . ////////////////////////////////////////////////////////////////////////////
30046
30047 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
30048          "Local scan function"
30049 .scindex IIDlosca "&[local_scan()]& function" "description of"
30050 .cindex "customizing" "input scan using C function"
30051 .cindex "policy control" "by local scan function"
30052 In these days of email worms, viruses, and ever-increasing spam, some sites
30053 want to apply a lot of checking to messages before accepting them.
30054
30055 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
30056 passing messages to external virus and spam scanning software. You can also do
30057 a certain amount in Exim itself through string expansions and the &%condition%&
30058 condition in the ACL that runs after the SMTP DATA command or the ACL for
30059 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
30060
30061 To allow for further customization to a site's own requirements, there is the
30062 possibility of linking Exim with a private message scanning function, written
30063 in C. If you want to run code that is written in something other than C, you
30064 can of course use a little C stub to call it.
30065
30066 The local scan function is run once for every incoming message, at the point
30067 when Exim is just about to accept the message.
30068 It can therefore be used to control non-SMTP messages from local processes as
30069 well as messages arriving via SMTP.
30070
30071 Exim applies a timeout to calls of the local scan function, and there is an
30072 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
30073 Zero means &"no timeout"&.
30074 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
30075 before calling the local scan function, so that the most common types of crash
30076 are caught. If the timeout is exceeded or one of those signals is caught, the
30077 incoming message is rejected with a temporary error if it is an SMTP message.
30078 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
30079 code. The incident is logged on the main and reject logs.
30080
30081
30082
30083 .section "Building Exim to use a local scan function" "SECID207"
30084 .cindex "&[local_scan()]& function" "building Exim to use"
30085 To make use of the local scan function feature, you must tell Exim where your
30086 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
30087 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
30088 directory, so you might set
30089 .code
30090 LOCAL_SCAN_SOURCE=Local/local_scan.c
30091 .endd
30092 for example. The function must be called &[local_scan()]&. It is called by
30093 Exim after it has received a message, when the success return code is about to
30094 be sent. This is after all the ACLs have been run. The return code from your
30095 function controls whether the message is actually accepted or not. There is a
30096 commented template function (that just accepts the message) in the file
30097 _src/local_scan.c_.
30098
30099 If you want to make use of Exim's run time configuration file to set options
30100 for your &[local_scan()]& function, you must also set
30101 .code
30102 LOCAL_SCAN_HAS_OPTIONS=yes
30103 .endd
30104 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
30105
30106
30107
30108
30109 .section "API for local_scan()" "SECTapiforloc"
30110 .cindex "&[local_scan()]& function" "API description"
30111 You must include this line near the start of your code:
30112 .code
30113 #include "local_scan.h"
30114 .endd
30115 This header file defines a number of variables and other values, and the
30116 prototype for the function itself. Exim is coded to use unsigned char values
30117 almost exclusively, and one of the things this header defines is a shorthand
30118 for &`unsigned char`& called &`uschar`&.
30119 It also contains the following macro definitions, to simplify casting character
30120 strings and pointers to character strings:
30121 .code
30122 #define CS   (char *)
30123 #define CCS  (const char *)
30124 #define CSS  (char **)
30125 #define US   (unsigned char *)
30126 #define CUS  (const unsigned char *)
30127 #define USS  (unsigned char **)
30128 .endd
30129 The function prototype for &[local_scan()]& is:
30130 .code
30131 extern int local_scan(int fd, uschar **return_text);
30132 .endd
30133 The arguments are as follows:
30134
30135 .ilist
30136 &%fd%& is a file descriptor for the file that contains the body of the message
30137 (the -D file). The file is open for reading and writing, but updating it is not
30138 recommended. &*Warning*&: You must &'not'& close this file descriptor.
30139
30140 The descriptor is positioned at character 19 of the file, which is the first
30141 character of the body itself, because the first 19 characters are the message
30142 id followed by &`-D`& and a newline. If you rewind the file, you should use the
30143 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
30144 case this changes in some future version.
30145 .next
30146 &%return_text%& is an address which you can use to return a pointer to a text
30147 string at the end of the function. The value it points to on entry is NULL.
30148 .endlist
30149
30150 The function must return an &%int%& value which is one of the following macros:
30151
30152 .vlist
30153 .vitem &`LOCAL_SCAN_ACCEPT`&
30154 .vindex "&$local_scan_data$&"
30155 The message is accepted. If you pass back a string of text, it is saved with
30156 the message, and made available in the variable &$local_scan_data$&. No
30157 newlines are permitted (if there are any, they are turned into spaces) and the
30158 maximum length of text is 1000 characters.
30159
30160 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
30161 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30162 queued without immediate delivery, and is frozen.
30163
30164 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
30165 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30166 queued without immediate delivery.
30167
30168 .vitem &`LOCAL_SCAN_REJECT`&
30169 The message is rejected; the returned text is used as an error message which is
30170 passed back to the sender and which is also logged. Newlines are permitted &--
30171 they cause a multiline response for SMTP rejections, but are converted to
30172 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
30173 used.
30174
30175 .vitem &`LOCAL_SCAN_TEMPREJECT`&
30176 The message is temporarily rejected; the returned text is used as an error
30177 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
30178 problem"& is used.
30179
30180 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
30181 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
30182 message is not written to the reject log. It has the effect of unsetting the
30183 &%rejected_header%& log selector for just this rejection. If
30184 &%rejected_header%& is already unset (see the discussion of the
30185 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
30186 same as LOCAL_SCAN_REJECT.
30187
30188 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
30189 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
30190 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
30191 .endlist
30192
30193 If the message is not being received by interactive SMTP, rejections are
30194 reported by writing to &%stderr%& or by sending an email, as configured by the
30195 &%-oe%& command line options.
30196
30197
30198
30199 .section "Configuration options for local_scan()" "SECTconoptloc"
30200 .cindex "&[local_scan()]& function" "configuration options"
30201 It is possible to have option settings in the main configuration file
30202 that set values in static variables in the &[local_scan()]& module. If you
30203 want to do this, you must have the line
30204 .code
30205 LOCAL_SCAN_HAS_OPTIONS=yes
30206 .endd
30207 in your &_Local/Makefile_& when you build Exim. (This line is in
30208 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
30209 file, you must define static variables to hold the option values, and a table
30210 to define them.
30211
30212 The table must be a vector called &%local_scan_options%&, of type
30213 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
30214 and a pointer to the variable that holds the value. The entries must appear in
30215 alphabetical order. Following &%local_scan_options%& you must also define a
30216 variable called &%local_scan_options_count%& that contains the number of
30217 entries in the table. Here is a short example, showing two kinds of option:
30218 .code
30219 static int my_integer_option = 42;
30220 static uschar *my_string_option = US"a default string";
30221
30222 optionlist local_scan_options[] = {
30223   { "my_integer", opt_int,       &my_integer_option },
30224   { "my_string",  opt_stringptr, &my_string_option }
30225 };
30226
30227 int local_scan_options_count =
30228   sizeof(local_scan_options)/sizeof(optionlist);
30229 .endd
30230 The values of the variables can now be changed from Exim's runtime
30231 configuration file by including a local scan section as in this example:
30232 .code
30233 begin local_scan
30234 my_integer = 99
30235 my_string = some string of text...
30236 .endd
30237 The available types of option data are as follows:
30238
30239 .vlist
30240 .vitem &*opt_bool*&
30241 This specifies a boolean (true/false) option. The address should point to a
30242 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
30243 that are defined as &"1"& and &"0"&, respectively. If you want to detect
30244 whether such a variable has been set at all, you can initialize it to
30245 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
30246 values.)
30247
30248 .vitem &*opt_fixed*&
30249 This specifies a fixed point number, such as is used for load averages.
30250 The address should point to a variable of type &`int`&. The value is stored
30251 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
30252
30253 .vitem &*opt_int*&
30254 This specifies an integer; the address should point to a variable of type
30255 &`int`&. The value may be specified in any of the integer formats accepted by
30256 Exim.
30257
30258 .vitem &*opt_mkint*&
30259 This is the same as &%opt_int%&, except that when such a value is output in a
30260 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
30261 printed with the suffix K or M.
30262
30263 .vitem &*opt_octint*&
30264 This also specifies an integer, but the value is always interpreted as an
30265 octal integer, whether or not it starts with the digit zero, and it is
30266 always output in octal.
30267
30268 .vitem &*opt_stringptr*&
30269 This specifies a string value; the address must be a pointer to a
30270 variable that points to a string (for example, of type &`uschar *`&).
30271
30272 .vitem &*opt_time*&
30273 This specifies a time interval value. The address must point to a variable of
30274 type &`int`&. The value that is placed there is a number of seconds.
30275 .endlist
30276
30277 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
30278 out the values of all the &[local_scan()]& options.
30279
30280
30281
30282 .section "Available Exim variables" "SECID208"
30283 .cindex "&[local_scan()]& function" "available Exim variables"
30284 The header &_local_scan.h_& gives you access to a number of C variables. These
30285 are the only ones that are guaranteed to be maintained from release to release.
30286 Note, however, that you can obtain the value of any Exim expansion variable,
30287 including &$recipients$&, by calling &'expand_string()'&. The exported
30288 C variables are as follows:
30289
30290 .vlist
30291 .vitem &*int&~body_linecount*&
30292 This variable contains the number of lines in the message's body.
30293
30294 .vitem &*int&~body_zerocount*&
30295 This variable contains the number of binary zero bytes in the message's body.
30296
30297 .vitem &*unsigned&~int&~debug_selector*&
30298 This variable is set to zero when no debugging is taking place. Otherwise, it
30299 is a bitmap of debugging selectors. Two bits are identified for use in
30300 &[local_scan()]&; they are defined as macros:
30301
30302 .ilist
30303 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
30304 testing option that is not privileged &-- any caller may set it. All the
30305 other selector bits can be set only by admin users.
30306
30307 .next
30308 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
30309 by the &`+local_scan`& debug selector. It is not included in the default set
30310 of debugging bits.
30311 .endlist ilist
30312
30313 Thus, to write to the debugging output only when &`+local_scan`& has been
30314 selected, you should use code like this:
30315 .code
30316 if ((debug_selector & D_local_scan) != 0)
30317   debug_printf("xxx", ...);
30318 .endd
30319 .vitem &*uschar&~*expand_string_message*&
30320 After a failing call to &'expand_string()'& (returned value NULL), the
30321 variable &%expand_string_message%& contains the error message, zero-terminated.
30322
30323 .vitem &*header_line&~*header_list*&
30324 A pointer to a chain of header lines. The &%header_line%& structure is
30325 discussed below.
30326
30327 .vitem &*header_line&~*header_last*&
30328 A pointer to the last of the header lines.
30329
30330 .vitem &*uschar&~*headers_charset*&
30331 The value of the &%headers_charset%& configuration option.
30332
30333 .vitem &*BOOL&~host_checking*&
30334 This variable is TRUE during a host checking session that is initiated by the
30335 &%-bh%& command line option.
30336
30337 .vitem &*uschar&~*interface_address*&
30338 The IP address of the interface that received the message, as a string. This
30339 is NULL for locally submitted messages.
30340
30341 .vitem &*int&~interface_port*&
30342 The port on which this message was received. When testing with the &%-bh%&
30343 command line option, the value of this variable is -1 unless a port has been
30344 specified via the &%-oMi%& option.
30345
30346 .vitem &*uschar&~*message_id*&
30347 This variable contains Exim's message id for the incoming message (the value of
30348 &$message_exim_id$&) as a zero-terminated string.
30349
30350 .vitem &*uschar&~*received_protocol*&
30351 The name of the protocol by which the message was received.
30352
30353 .vitem &*int&~recipients_count*&
30354 The number of accepted recipients.
30355
30356 .vitem &*recipient_item&~*recipients_list*&
30357 .cindex "recipient" "adding in local scan"
30358 .cindex "recipient" "removing in local scan"
30359 The list of accepted recipients, held in a vector of length
30360 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
30361 can add additional recipients by calling &'receive_add_recipient()'& (see
30362 below). You can delete recipients by removing them from the vector and
30363 adjusting the value in &%recipients_count%&. In particular, by setting
30364 &%recipients_count%& to zero you remove all recipients. If you then return the
30365 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
30366 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
30367 and then call &'receive_add_recipient()'& as often as needed.
30368
30369 .vitem &*uschar&~*sender_address*&
30370 The envelope sender address. For bounce messages this is the empty string.
30371
30372 .vitem &*uschar&~*sender_host_address*&
30373 The IP address of the sending host, as a string. This is NULL for
30374 locally-submitted messages.
30375
30376 .vitem &*uschar&~*sender_host_authenticated*&
30377 The name of the authentication mechanism that was used, or NULL if the message
30378 was not received over an authenticated SMTP connection.
30379
30380 .vitem &*uschar&~*sender_host_name*&
30381 The name of the sending host, if known.
30382
30383 .vitem &*int&~sender_host_port*&
30384 The port on the sending host.
30385
30386 .vitem &*BOOL&~smtp_input*&
30387 This variable is TRUE for all SMTP input, including BSMTP.
30388
30389 .vitem &*BOOL&~smtp_batched_input*&
30390 This variable is TRUE for BSMTP input.
30391
30392 .vitem &*int&~store_pool*&
30393 The contents of this variable control which pool of memory is used for new
30394 requests. See section &<<SECTmemhanloc>>& for details.
30395 .endlist
30396
30397
30398 .section "Structure of header lines" "SECID209"
30399 The &%header_line%& structure contains the members listed below.
30400 You can add additional header lines by calling the &'header_add()'& function
30401 (see below). You can cause header lines to be ignored (deleted) by setting
30402 their type to *.
30403
30404
30405 .vlist
30406 .vitem &*struct&~header_line&~*next*&
30407 A pointer to the next header line, or NULL for the last line.
30408
30409 .vitem &*int&~type*&
30410 A code identifying certain headers that Exim recognizes. The codes are printing
30411 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
30412 Notice in particular that any header line whose type is * is not transmitted
30413 with the message. This flagging is used for header lines that have been
30414 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
30415 lines.) Effectively, * means &"deleted"&.
30416
30417 .vitem &*int&~slen*&
30418 The number of characters in the header line, including the terminating and any
30419 internal newlines.
30420
30421 .vitem &*uschar&~*text*&
30422 A pointer to the text of the header. It always ends with a newline, followed by
30423 a zero byte. Internal newlines are preserved.
30424 .endlist
30425
30426
30427
30428 .section "Structure of recipient items" "SECID210"
30429 The &%recipient_item%& structure contains these members:
30430
30431 .vlist
30432 .vitem &*uschar&~*address*&
30433 This is a pointer to the recipient address as it was received.
30434
30435 .vitem &*int&~pno*&
30436 This is used in later Exim processing when top level addresses are created by
30437 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
30438 and must always contain -1 at this stage.
30439
30440 .vitem &*uschar&~*errors_to*&
30441 If this value is not NULL, bounce messages caused by failing to deliver to the
30442 recipient are sent to the address it contains. In other words, it overrides the
30443 envelope sender for this one recipient. (Compare the &%errors_to%& generic
30444 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
30445 an unqualified address, Exim qualifies it using the domain from
30446 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
30447 is NULL for all recipients.
30448 .endlist
30449
30450
30451
30452 .section "Available Exim functions" "SECID211"
30453 .cindex "&[local_scan()]& function" "available Exim functions"
30454 The header &_local_scan.h_& gives you access to a number of Exim functions.
30455 These are the only ones that are guaranteed to be maintained from release to
30456 release:
30457
30458 .vlist
30459 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
30460        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
30461
30462 This function creates a child process that runs the command specified by
30463 &%argv%&. The environment for the process is specified by &%envp%&, which can
30464 be NULL if no environment variables are to be passed. A new umask is supplied
30465 for the process in &%newumask%&.
30466
30467 Pipes to the standard input and output of the new process are set up
30468 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
30469 standard error is cloned to the standard output. If there are any file
30470 descriptors &"in the way"& in the new process, they are closed. If the final
30471 argument is TRUE, the new process is made into a process group leader.
30472
30473 The function returns the pid of the new process, or -1 if things go wrong.
30474
30475 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
30476 This function waits for a child process to terminate, or for a timeout (in
30477 seconds) to expire. A timeout value of zero means wait as long as it takes. The
30478 return value is as follows:
30479
30480 .ilist
30481 >= 0
30482
30483 The process terminated by a normal exit and the value is the process
30484 ending status.
30485
30486 .next
30487 < 0 and > &--256
30488
30489 The process was terminated by a signal and the value is the negation of the
30490 signal number.
30491
30492 .next
30493 &--256
30494
30495 The process timed out.
30496 .next
30497 &--257
30498
30499 The was some other error in wait(); &%errno%& is still set.
30500 .endlist
30501
30502 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
30503 This function provide you with a means of submitting a new message to
30504 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
30505 want, but this packages it all up for you.) The function creates a pipe,
30506 forks a subprocess that is running
30507 .code
30508 exim -t -oem -oi -f <>
30509 .endd
30510 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
30511 that is connected to the standard input. The yield of the function is the PID
30512 of the subprocess. You can then write a message to the file descriptor, with
30513 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
30514
30515 When you have finished, call &'child_close()'& to wait for the process to
30516 finish and to collect its ending status. A timeout value of zero is usually
30517 fine in this circumstance. Unless you have made a mistake with the recipient
30518 addresses, you should get a return code of zero.
30519
30520
30521 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30522        *sender_authentication)*&
30523 This function is a more sophisticated version of &'child_open()'&. The command
30524 that it runs is:
30525 .display
30526 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30527 .endd
30528 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30529
30530
30531 .vitem &*void&~debug_printf(char&~*,&~...)*&
30532 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30533 output is written to the standard error stream. If no debugging is selected,
30534 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30535 conditional on the &`local_scan`& debug selector by coding like this:
30536 .code
30537 if ((debug_selector & D_local_scan) != 0)
30538   debug_printf("xxx", ...);
30539 .endd
30540
30541 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30542 This is an interface to Exim's string expansion code. The return value is the
30543 expanded string, or NULL if there was an expansion failure.
30544 The C variable &%expand_string_message%& contains an error message after an
30545 expansion failure. If expansion does not change the string, the return value is
30546 the pointer to the input string. Otherwise, the return value points to a new
30547 block of memory that was obtained by a call to &'store_get()'&. See section
30548 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30549
30550 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30551 This function allows you to an add additional header line at the end of the
30552 existing ones. The first argument is the type, and should normally be a space
30553 character. The second argument is a format string and any number of
30554 substitution arguments as for &[sprintf()]&. You may include internal newlines
30555 if you want, and you must ensure that the string ends with a newline.
30556
30557 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30558         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30559 This function adds a new header line at a specified point in the header
30560 chain. The header itself is specified as for &'header_add()'&.
30561
30562 If &%name%& is NULL, the new header is added at the end of the chain if
30563 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30564 NULL, the header lines are searched for the first non-deleted header that
30565 matches the name. If one is found, the new header is added before it if
30566 &%after%& is false. If &%after%& is true, the new header is added after the
30567 found header and any adjacent subsequent ones with the same name (even if
30568 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30569 option controls where the header is added. If it is true, addition is at the
30570 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30571 headers, or at the top if there are no &'Received:'& headers, you could use
30572 .code
30573 header_add_at_position(TRUE, US"Received", TRUE,
30574   ' ', "X-xxx: ...");
30575 .endd
30576 Normally, there is always at least one non-deleted &'Received:'& header, but
30577 there may not be if &%received_header_text%& expands to an empty string.
30578
30579
30580 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30581 This function removes header lines. If &%occurrence%& is zero or negative, all
30582 occurrences of the header are removed. If occurrence is greater than zero, that
30583 particular instance of the header is removed. If no header(s) can be found that
30584 match the specification, the function does nothing.
30585
30586
30587 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30588         int&~length,&~BOOL&~notdel)*&"
30589 This function tests whether the given header has the given name. It is not just
30590 a string comparison, because white space is permitted between the name and the
30591 colon. If the &%notdel%& argument is true, a false return is forced for all
30592 &"deleted"& headers; otherwise they are not treated specially. For example:
30593 .code
30594 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30595 .endd
30596 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30597 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30598 This function base64-encodes a string, which is passed by address and length.
30599 The text may contain bytes of any value, including zero. The result is passed
30600 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30601 zero-terminated.
30602
30603 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30604 This function decodes a base64-encoded string. Its arguments are a
30605 zero-terminated base64-encoded string and the address of a variable that is set
30606 to point to the result, which is in dynamic memory. The length of the decoded
30607 string is the yield of the function. If the input is invalid base64 data, the
30608 yield is -1. A zero byte is added to the end of the output string to make it
30609 easy to interpret as a C string (assuming it contains no zeros of its own). The
30610 added zero byte is not included in the returned count.
30611
30612 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30613 This function checks for a match in a domain list. Domains are always
30614 matched caselessly. The return value is one of the following:
30615 .display
30616 &`OK     `& match succeeded
30617 &`FAIL   `& match failed
30618 &`DEFER  `& match deferred
30619 .endd
30620 DEFER is usually caused by some kind of lookup defer, such as the
30621 inability to contact a database.
30622
30623 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30624         BOOL&~caseless)*&"
30625 This function checks for a match in a local part list. The third argument
30626 controls case-sensitivity. The return values are as for
30627 &'lss_match_domain()'&.
30628
30629 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
30630         BOOL&~caseless)*&"
30631 This function checks for a match in an address list. The third argument
30632 controls the case-sensitivity of the local part match. The domain is always
30633 matched caselessly. The return values are as for &'lss_match_domain()'&.
30634
30635 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
30636         uschar&~*list)*&"
30637 This function checks for a match in a host list. The most common usage is
30638 expected to be
30639 .code
30640 lss_match_host(sender_host_name, sender_host_address, ...)
30641 .endd
30642 .vindex "&$sender_host_address$&"
30643 An empty address field matches an empty item in the host list. If the host name
30644 is NULL, the name corresponding to &$sender_host_address$& is automatically
30645 looked up if a host name is required to match an item in the list. The return
30646 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
30647 returns ERROR in the case when it had to look up a host name, but the lookup
30648 failed.
30649
30650 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
30651         *format,&~...)*&"
30652 This function writes to Exim's log files. The first argument should be zero (it
30653 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
30654 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
30655 them. It specifies to which log or logs the message is written. The remaining
30656 arguments are a format and relevant insertion arguments. The string should not
30657 contain any newlines, not even at the end.
30658
30659
30660 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
30661 This function adds an additional recipient to the message. The first argument
30662 is the recipient address. If it is unqualified (has no domain), it is qualified
30663 with the &%qualify_recipient%& domain. The second argument must always be -1.
30664
30665 This function does not allow you to specify a private &%errors_to%& address (as
30666 described with the structure of &%recipient_item%& above), because it pre-dates
30667 the addition of that field to the structure. However, it is easy to add such a
30668 value afterwards. For example:
30669 .code
30670  receive_add_recipient(US"monitor@mydom.example", -1);
30671  recipients_list[recipients_count-1].errors_to =
30672    US"postmaster@mydom.example";
30673 .endd
30674
30675 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
30676 This is a convenience function to remove a named recipient from the list of
30677 recipients. It returns true if a recipient was removed, and false if no
30678 matching recipient could be found. The argument must be a complete email
30679 address.
30680 .endlist
30681
30682
30683 .cindex "RFC 2047"
30684 .vlist
30685 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
30686   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
30687 This function decodes strings that are encoded according to RFC 2047. Typically
30688 these are the contents of header lines. First, each &"encoded word"& is decoded
30689 from the Q or B encoding into a byte-string. Then, if provided with the name of
30690 a charset encoding, and if the &[iconv()]& function is available, an attempt is
30691 made  to translate the result to the named character set. If this fails, the
30692 binary string is returned with an error message.
30693
30694 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
30695 maximum MIME word length is enforced. The third argument is the target
30696 encoding, or NULL if no translation is wanted.
30697
30698 .cindex "binary zero" "in RFC 2047 decoding"
30699 .cindex "RFC 2047" "binary zero in"
30700 If a binary zero is encountered in the decoded string, it is replaced by the
30701 contents of the &%zeroval%& argument. For use with Exim headers, the value must
30702 not be 0 because header lines are handled as zero-terminated strings.
30703
30704 The function returns the result of processing the string, zero-terminated; if
30705 &%lenptr%& is not NULL, the length of the result is set in the variable to
30706 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
30707
30708 If an error is encountered, the function returns NULL and uses the &%error%&
30709 argument to return an error message. The variable pointed to by &%error%& is
30710 set to NULL if there is no error; it may be set non-NULL even when the function
30711 returns a non-NULL value if decoding was successful, but there was a problem
30712 with translation.
30713
30714
30715 .vitem &*int&~smtp_fflush(void)*&
30716 This function is used in conjunction with &'smtp_printf()'&, as described
30717 below.
30718
30719 .vitem &*void&~smtp_printf(char&~*,&~...)*&
30720 The arguments of this function are like &[printf()]&; it writes to the SMTP
30721 output stream. You should use this function only when there is an SMTP output
30722 stream, that is, when the incoming message is being received via interactive
30723 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
30724 is FALSE. If you want to test for an incoming message from another host (as
30725 opposed to a local process that used the &%-bs%& command line option), you can
30726 test the value of &%sender_host_address%&, which is non-NULL when a remote host
30727 is involved.
30728
30729 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
30730 output function, so it can be used for all forms of SMTP connection.
30731
30732 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
30733 must start with an appropriate response code: 550 if you are going to return
30734 LOCAL_SCAN_REJECT, 451 if you are going to return
30735 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
30736 initial lines of a multi-line response, the code must be followed by a hyphen
30737 to indicate that the line is not the final response line. You must also ensure
30738 that the lines you write terminate with CRLF. For example:
30739 .code
30740 smtp_printf("550-this is some extra info\r\n");
30741 return LOCAL_SCAN_REJECT;
30742 .endd
30743 Note that you can also create multi-line responses by including newlines in
30744 the data returned via the &%return_text%& argument. The added value of using
30745 &'smtp_printf()'& is that, for instance, you could introduce delays between
30746 multiple output lines.
30747
30748 The &'smtp_printf()'& function does not return any error indication, because it
30749 does not automatically flush pending output, and therefore does not test
30750 the state of the stream. (In the main code of Exim, flushing and error
30751 detection is done when Exim is ready for the next SMTP input command.) If
30752 you want to flush the output and check for an error (for example, the
30753 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
30754 arguments. It flushes the output stream, and returns a non-zero value if there
30755 is an error.
30756
30757 .vitem &*void&~*store_get(int)*&
30758 This function accesses Exim's internal store (memory) manager. It gets a new
30759 chunk of memory whose size is given by the argument. Exim bombs out if it ever
30760 runs out of memory. See the next section for a discussion of memory handling.
30761
30762 .vitem &*void&~*store_get_perm(int)*&
30763 This function is like &'store_get()'&, but it always gets memory from the
30764 permanent pool. See the next section for a discussion of memory handling.
30765
30766 .vitem &*uschar&~*string_copy(uschar&~*string)*&
30767 See below.
30768
30769 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
30770 See below.
30771
30772 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
30773 These three functions create strings using Exim's dynamic memory facilities.
30774 The first makes a copy of an entire string. The second copies up to a maximum
30775 number of characters, indicated by the second argument. The third uses a format
30776 and insertion arguments to create a new string. In each case, the result is a
30777 pointer to a new string in the current memory pool. See the next section for
30778 more discussion.
30779 .endlist
30780
30781
30782
30783 .section "More about Exim's memory handling" "SECTmemhanloc"
30784 .cindex "&[local_scan()]& function" "memory handling"
30785 No function is provided for freeing memory, because that is never needed.
30786 The dynamic memory that Exim uses when receiving a message is automatically
30787 recycled if another message is received by the same process (this applies only
30788 to incoming SMTP connections &-- other input methods can supply only one
30789 message at a time). After receiving the last message, a reception process
30790 terminates.
30791
30792 Because it is recycled, the normal dynamic memory cannot be used for holding
30793 data that must be preserved over a number of incoming messages on the same SMTP
30794 connection. However, Exim in fact uses two pools of dynamic memory; the second
30795 one is not recycled, and can be used for this purpose.
30796
30797 If you want to allocate memory that remains available for subsequent messages
30798 in the same SMTP connection, you should set
30799 .code
30800 store_pool = POOL_PERM
30801 .endd
30802 before calling the function that does the allocation. There is no need to
30803 restore the value if you do not need to; however, if you do want to revert to
30804 the normal pool, you can either restore the previous value of &%store_pool%& or
30805 set it explicitly to POOL_MAIN.
30806
30807 The pool setting applies to all functions that get dynamic memory, including
30808 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
30809 There is also a convenience function called &'store_get_perm()'& that gets a
30810 block of memory from the permanent pool while preserving the value of
30811 &%store_pool%&.
30812 .ecindex IIDlosca
30813
30814
30815
30816
30817 . ////////////////////////////////////////////////////////////////////////////
30818 . ////////////////////////////////////////////////////////////////////////////
30819
30820 .chapter "System-wide message filtering" "CHAPsystemfilter"
30821 .scindex IIDsysfil1 "filter" "system filter"
30822 .scindex IIDsysfil2 "filtering all mail"
30823 .scindex IIDsysfil3 "system filter"
30824 The previous chapters (on ACLs and the local scan function) describe checks
30825 that can be applied to messages before they are accepted by a host. There is
30826 also a mechanism for checking messages once they have been received, but before
30827 they are delivered. This is called the &'system filter'&.
30828
30829 The system filter operates in a similar manner to users' filter files, but it
30830 is run just once per message (however many recipients the message has).
30831 It should not normally be used as a substitute for routing, because &%deliver%&
30832 commands in a system router provide new envelope recipient addresses.
30833 The system filter must be an Exim filter. It cannot be a Sieve filter.
30834
30835 The system filter is run at the start of a delivery attempt, before any routing
30836 is done. If a message fails to be completely delivered at the first attempt,
30837 the system filter is run again at the start of every retry.
30838 If you want your filter to do something only once per message, you can make use
30839 of the &%first_delivery%& condition in an &%if%& command in the filter to
30840 prevent it happening on retries.
30841
30842 .vindex "&$domain$&"
30843 .vindex "&$local_part$&"
30844 &*Warning*&: Because the system filter runs just once, variables that are
30845 specific to individual recipient addresses, such as &$local_part$& and
30846 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
30847 you want to run a centrally-specified filter for each recipient address
30848 independently, you can do so by setting up a suitable &(redirect)& router, as
30849 described in section &<<SECTperaddfil>>& below.
30850
30851
30852 .section "Specifying a system filter" "SECID212"
30853 .cindex "uid (user id)" "system filter"
30854 .cindex "gid (group id)" "system filter"
30855 The name of the file that contains the system filter must be specified by
30856 setting &%system_filter%&. If you want the filter to run under a uid and gid
30857 other than root, you must also set &%system_filter_user%& and
30858 &%system_filter_group%& as appropriate. For example:
30859 .code
30860 system_filter = /etc/mail/exim.filter
30861 system_filter_user = exim
30862 .endd
30863 If a system filter generates any deliveries directly to files or pipes (via the
30864 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
30865 specified by setting &%system_filter_file_transport%& and
30866 &%system_filter_pipe_transport%&, respectively. Similarly,
30867 &%system_filter_reply_transport%& must be set to handle any messages generated
30868 by the &%reply%& command.
30869
30870
30871 .section "Testing a system filter" "SECID213"
30872 You can run simple tests of a system filter in the same way as for a user
30873 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
30874 are permitted only in system filters are recognized.
30875
30876 If you want to test the combined effect of a system filter and a user filter,
30877 you can use both &%-bF%& and &%-bf%& on the same command line.
30878
30879
30880
30881 .section "Contents of a system filter" "SECID214"
30882 The language used to specify system filters is the same as for users' filter
30883 files. It is described in the separate end-user document &'Exim's interface to
30884 mail filtering'&. However, there are some additional features that are
30885 available only in system filters; these are described in subsequent sections.
30886 If they are encountered in a user's filter file or when testing with &%-bf%&,
30887 they cause errors.
30888
30889 .cindex "frozen messages" "manual thaw; testing in filter"
30890 There are two special conditions which, though available in users' filter
30891 files, are designed for use in system filters. The condition &%first_delivery%&
30892 is true only for the first attempt at delivering a message, and
30893 &%manually_thawed%& is true only if the message has been frozen, and
30894 subsequently thawed by an admin user. An explicit forced delivery counts as a
30895 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
30896
30897 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
30898 specify an &"unseen"& (non-significant) delivery, and that delivery does not
30899 succeed, it will not be tried again.
30900 If you want Exim to retry an unseen delivery until it succeeds, you should
30901 arrange to set it up every time the filter runs.
30902
30903 When a system filter finishes running, the values of the variables &$n0$& &--
30904 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
30905 users' filter files. Thus a system filter can, for example, set up &"scores"&
30906 to which users' filter files can refer.
30907
30908
30909
30910 .section "Additional variable for system filters" "SECID215"
30911 .vindex "&$recipients$&"
30912 The expansion variable &$recipients$&, containing a list of all the recipients
30913 of the message (separated by commas and white space), is available in system
30914 filters. It is not available in users' filters for privacy reasons.
30915
30916
30917
30918 .section "Defer, freeze, and fail commands for system filters" "SECID216"
30919 .cindex "freezing messages"
30920 .cindex "message" "freezing"
30921 .cindex "message" "forced failure"
30922 .cindex "&%fail%&" "in system filter"
30923 .cindex "&%freeze%& in system filter"
30924 .cindex "&%defer%& in system filter"
30925 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
30926 always available in system filters, but are not normally enabled in users'
30927 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
30928 for the &(redirect)& router.) These commands can optionally be followed by the
30929 word &%text%& and a string containing an error message, for example:
30930 .code
30931 fail text "this message looks like spam to me"
30932 .endd
30933 The keyword &%text%& is optional if the next character is a double quote.
30934
30935 The &%defer%& command defers delivery of the original recipients of the
30936 message. The &%fail%& command causes all the original recipients to be failed,
30937 and a bounce message to be created. The &%freeze%& command suspends all
30938 delivery attempts for the original recipients. In all cases, any new deliveries
30939 that are specified by the filter are attempted as normal after the filter has
30940 run.
30941
30942 The &%freeze%& command is ignored if the message has been manually unfrozen and
30943 not manually frozen since. This means that automatic freezing by a system
30944 filter can be used as a way of checking out suspicious messages. If a message
30945 is found to be all right, manually unfreezing it allows it to be delivered.
30946
30947 .cindex "log" "&%fail%& command log line"
30948 .cindex "&%fail%&" "log line; reducing"
30949 The text given with a fail command is used as part of the bounce message as
30950 well as being written to the log. If the message is quite long, this can fill
30951 up a lot of log space when such failures are common. To reduce the size of the
30952 log message, Exim interprets the text in a special way if it starts with the
30953 two characters &`<<`& and contains &`>>`& later. The text between these two
30954 strings is written to the log, and the rest of the text is used in the bounce
30955 message. For example:
30956 .code
30957 fail "<<filter test 1>>Your message is rejected \
30958      because it contains attachments that we are \
30959      not prepared to receive."
30960 .endd
30961
30962 .cindex "loop" "caused by &%fail%&"
30963 Take great care with the &%fail%& command when basing the decision to fail on
30964 the contents of the message, because the bounce message will of course include
30965 the contents of the original message and will therefore trigger the &%fail%&
30966 command again (causing a mail loop) unless steps are taken to prevent this.
30967 Testing the &%error_message%& condition is one way to prevent this. You could
30968 use, for example
30969 .code
30970 if $message_body contains "this is spam" and not error_message
30971 then fail text "spam is not wanted here" endif
30972 .endd
30973 though of course that might let through unwanted bounce messages. The
30974 alternative is clever checking of the body and/or headers to detect bounces
30975 generated by the filter.
30976
30977 The interpretation of a system filter file ceases after a
30978 &%defer%&,
30979 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
30980 set up earlier in the filter file are honoured, so you can use a sequence such
30981 as
30982 .code
30983 mail ...
30984 freeze
30985 .endd
30986 to send a specified message when the system filter is freezing (or deferring or
30987 failing) a message. The normal deliveries for the message do not, of course,
30988 take place.
30989
30990
30991
30992 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
30993 .cindex "header lines" "adding; in system filter"
30994 .cindex "header lines" "removing; in system filter"
30995 .cindex "filter" "header lines; adding/removing"
30996 Two filter commands that are available only in system filters are:
30997 .code
30998 headers add <string>
30999 headers remove <string>
31000 .endd
31001 The argument for the &%headers add%& is a string that is expanded and then
31002 added to the end of the message's headers. It is the responsibility of the
31003 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
31004 space is ignored, and if the string is otherwise empty, or if the expansion is
31005 forced to fail, the command has no effect.
31006
31007 You can use &"\n"& within the string, followed by white space, to specify
31008 continued header lines. More than one header may be added in one command by
31009 including &"\n"& within the string without any following white space. For
31010 example:
31011 .code
31012 headers add "X-header-1: ....\n  \
31013              continuation of X-header-1 ...\n\
31014              X-header-2: ...."
31015 .endd
31016 Note that the header line continuation white space after the first newline must
31017 be placed before the backslash that continues the input string, because white
31018 space after input continuations is ignored.
31019
31020 The argument for &%headers remove%& is a colon-separated list of header names.
31021 This command applies only to those headers that are stored with the message;
31022 those that are added at delivery time (such as &'Envelope-To:'& and
31023 &'Return-Path:'&) cannot be removed by this means. If there is more than one
31024 header with the same name, they are all removed.
31025
31026 The &%headers%& command in a system filter makes an immediate change to the set
31027 of header lines that was received with the message (with possible additions
31028 from ACL processing). Subsequent commands in the system filter operate on the
31029 modified set, which also forms the basis for subsequent message delivery.
31030 Unless further modified during routing or transporting, this set of headers is
31031 used for all recipients of the message.
31032
31033 During routing and transporting, the variables that refer to the contents of
31034 header lines refer only to those lines that are in this set. Thus, header lines
31035 that are added by a system filter are visible to users' filter files and to all
31036 routers and transports. This contrasts with the manipulation of header lines by
31037 routers and transports, which is not immediate, but which instead is saved up
31038 until the message is actually being written (see section
31039 &<<SECTheadersaddrem>>&).
31040
31041 If the message is not delivered at the first attempt, header lines that were
31042 added by the system filter are stored with the message, and so are still
31043 present at the next delivery attempt. Header lines that were removed are still
31044 present, but marked &"deleted"& so that they are not transported with the
31045 message. For this reason, it is usual to make the &%headers%& command
31046 conditional on &%first_delivery%& so that the set of header lines is not
31047 modified more than once.
31048
31049 Because header modification in a system filter acts immediately, you have to
31050 use an indirect approach if you want to modify the contents of a header line.
31051 For example:
31052 .code
31053 headers add "Old-Subject: $h_subject:"
31054 headers remove "Subject"
31055 headers add "Subject: new subject (was: $h_old-subject:)"
31056 headers remove "Old-Subject"
31057 .endd
31058
31059
31060
31061 .section "Setting an errors address in a system filter" "SECID217"
31062 .cindex "envelope sender"
31063 In a system filter, if a &%deliver%& command is followed by
31064 .code
31065 errors_to <some address>
31066 .endd
31067 in order to change the envelope sender (and hence the error reporting) for that
31068 delivery, any address may be specified. (In a user filter, only the current
31069 user's address can be set.) For example, if some mail is being monitored, you
31070 might use
31071 .code
31072 unseen deliver monitor@spying.example errors_to root@local.example
31073 .endd
31074 to take a copy which would not be sent back to the normal error reporting
31075 address if its delivery failed.
31076
31077
31078
31079 .section "Per-address filtering" "SECTperaddfil"
31080 .vindex "&$domain$&"
31081 .vindex "&$local_part$&"
31082 In contrast to the system filter, which is run just once per message for each
31083 delivery attempt, it is also possible to set up a system-wide filtering
31084 operation that runs once for each recipient address. In this case, variables
31085 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
31086 filter file could be made dependent on them. This is an example of a router
31087 which implements such a filter:
31088 .code
31089 central_filter:
31090   check_local_user
31091   driver = redirect
31092   domains = +local_domains
31093   file = /central/filters/$local_part
31094   no_verify
31095   allow_filter
31096   allow_freeze
31097 .endd
31098 The filter is run in a separate process under its own uid. Therefore, either
31099 &%check_local_user%& must be set (as above), in which case the filter is run as
31100 the local user, or the &%user%& option must be used to specify which user to
31101 use. If both are set, &%user%& overrides.
31102
31103 Care should be taken to ensure that none of the commands in the filter file
31104 specify a significant delivery if the message is to go on to be delivered to
31105 its intended recipient. The router will not then claim to have dealt with the
31106 address, so it will be passed on to subsequent routers to be delivered in the
31107 normal way.
31108 .ecindex IIDsysfil1
31109 .ecindex IIDsysfil2
31110 .ecindex IIDsysfil3
31111
31112
31113
31114
31115
31116
31117 . ////////////////////////////////////////////////////////////////////////////
31118 . ////////////////////////////////////////////////////////////////////////////
31119
31120 .chapter "Message processing" "CHAPmsgproc"
31121 .scindex IIDmesproc "message" "general processing"
31122 Exim performs various transformations on the sender and recipient addresses of
31123 all messages that it handles, and also on the messages' header lines. Some of
31124 these are optional and configurable, while others always take place. All of
31125 this processing, except rewriting as a result of routing, and the addition or
31126 removal of header lines while delivering, happens when a message is received,
31127 before it is placed on Exim's queue.
31128
31129 Some of the automatic processing takes place by default only for
31130 &"locally-originated"& messages. This adjective is used to describe messages
31131 that are not received over TCP/IP, but instead are passed to an Exim process on
31132 its standard input. This includes the interactive &"local SMTP"& case that is
31133 set up by the &%-bs%& command line option.
31134
31135 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
31136 or ::1) are not considered to be locally-originated. Exim does not treat the
31137 loopback interface specially in any way.
31138
31139 If you want the loopback interface to be treated specially, you must ensure
31140 that there are appropriate entries in your ACLs.
31141
31142
31143
31144
31145 .section "Submission mode for non-local messages" "SECTsubmodnon"
31146 .cindex "message" "submission"
31147 .cindex "submission mode"
31148 Processing that happens automatically for locally-originated messages (unless
31149 &%suppress_local_fixups%& is set) can also be requested for messages that are
31150 received over TCP/IP. The term &"submission mode"& is used to describe this
31151 state. Submission mode is set by the modifier
31152 .code
31153 control = submission
31154 .endd
31155 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
31156 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
31157 a local submission, and is normally used when the source of the message is
31158 known to be an MUA running on a client host (as opposed to an MTA). For
31159 example, to set submission mode for messages originating on the IPv4 loopback
31160 interface, you could include the following in the MAIL ACL:
31161 .code
31162 warn  hosts = 127.0.0.1
31163       control = submission
31164 .endd
31165 .cindex "&%sender_retain%& submission option"
31166 There are some options that can be used when setting submission mode. A slash
31167 is used to separate options. For example:
31168 .code
31169 control = submission/sender_retain
31170 .endd
31171 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
31172 true and &%local_from_check%& false for the current incoming message. The first
31173 of these allows an existing &'Sender:'& header in the message to remain, and
31174 the second suppresses the check to ensure that &'From:'& matches the
31175 authenticated sender. With this setting, Exim still fixes up messages by adding
31176 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
31177 attempt to check sender authenticity in header lines.
31178
31179 When &%sender_retain%& is not set, a submission mode setting may specify a
31180 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
31181 example:
31182 .code
31183 control = submission/domain=some.domain
31184 .endd
31185 The domain may be empty. How this value is used is described in sections
31186 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
31187 that allows you to specify the user's full name for inclusion in a created
31188 &'Sender:'& or &'From:'& header line. For example:
31189 .code
31190 accept authenticated = *
31191        control = submission/domain=wonderland.example/\
31192                             name=${lookup {$authenticated_id} \
31193                                    lsearch {/etc/exim/namelist}}
31194 .endd
31195 Because the name may contain any characters, including slashes, the &%name%&
31196 option must be given last. The remainder of the string is used as the name. For
31197 the example above, if &_/etc/exim/namelist_& contains:
31198 .code
31199 bigegg:  Humpty Dumpty
31200 .endd
31201 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
31202 line would be:
31203 .code
31204 Sender: Humpty Dumpty <bigegg@wonderland.example>
31205 .endd
31206 .cindex "return path" "in submission mode"
31207 By default, submission mode forces the return path to the same address as is
31208 used to create the &'Sender:'& header. However, if &%sender_retain%& is
31209 specified, the return path is also left unchanged.
31210
31211 &*Note*&: The changes caused by submission mode take effect after the predata
31212 ACL. This means that any sender checks performed before the fix-ups use the
31213 untrusted sender address specified by the user, not the trusted sender address
31214 specified by submission mode. Although this might be slightly unexpected, it
31215 does mean that you can configure ACL checks to spot that a user is trying to
31216 spoof another's address.
31217
31218 .section "Line endings" "SECTlineendings"
31219 .cindex "line endings"
31220 .cindex "carriage return"
31221 .cindex "linefeed"
31222 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
31223 linefeed) is the line ending for messages transmitted over the Internet using
31224 SMTP over TCP/IP. However, within individual operating systems, different
31225 conventions are used. For example, Unix-like systems use just LF, but others
31226 use CRLF or just CR.
31227
31228 Exim was designed for Unix-like systems, and internally, it stores messages
31229 using the system's convention of a single LF as a line terminator. When
31230 receiving a message, all line endings are translated to this standard format.
31231 Originally, it was thought that programs that passed messages directly to an
31232 MTA within an operating system would use that system's convention. Experience
31233 has shown that this is not the case; for example, there are Unix applications
31234 that use CRLF in this circumstance. For this reason, and for compatibility with
31235 other MTAs, the way Exim handles line endings for all messages is now as
31236 follows:
31237
31238 .ilist
31239 LF not preceded by CR is treated as a line ending.
31240 .next
31241 CR is treated as a line ending; if it is immediately followed by LF, the LF
31242 is ignored.
31243 .next
31244 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
31245 nor a local message in the state where a line containing only a dot is a
31246 terminator.
31247 .next
31248 If a bare CR is encountered within a header line, an extra space is added after
31249 the line terminator so as not to end the header line. The reasoning behind this
31250 is that bare CRs in header lines are most likely either to be mistakes, or
31251 people trying to play silly games.
31252 .next
31253 If the first header line received in a message ends with CRLF, a subsequent
31254 bare LF in a header line is treated in the same way as a bare CR in a header
31255 line.
31256 .endlist
31257
31258
31259
31260
31261
31262 .section "Unqualified addresses" "SECID218"
31263 .cindex "unqualified addresses"
31264 .cindex "address" "qualification"
31265 By default, Exim expects every envelope address it receives from an external
31266 host to be fully qualified. Unqualified addresses cause negative responses to
31267 SMTP commands. However, because SMTP is used as a means of transporting
31268 messages from MUAs running on personal workstations, there is sometimes a
31269 requirement to accept unqualified addresses from specific hosts or IP networks.
31270
31271 Exim has two options that separately control which hosts may send unqualified
31272 sender or recipient addresses in SMTP commands, namely
31273 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
31274 cases, if an unqualified address is accepted, it is qualified by adding the
31275 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
31276
31277 .oindex "&%qualify_domain%&"
31278 .oindex "&%qualify_recipient%&"
31279 Unqualified addresses in header lines are automatically qualified for messages
31280 that are locally originated, unless the &%-bnq%& option is given on the command
31281 line. For messages received over SMTP, unqualified addresses in header lines
31282 are qualified only if unqualified addresses are permitted in SMTP commands. In
31283 other words, such qualification is also controlled by
31284 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
31285
31286
31287
31288
31289 .section "The UUCP From line" "SECID219"
31290 .cindex "&""From""& line"
31291 .cindex "UUCP" "&""From""& line"
31292 .cindex "sender" "address"
31293 .oindex "&%uucp_from_pattern%&"
31294 .oindex "&%uucp_from_sender%&"
31295 .cindex "envelope sender"
31296 .cindex "Sendmail compatibility" "&""From""& line"
31297 Messages that have come from UUCP (and some other applications) often begin
31298 with a line containing the envelope sender and a timestamp, following the word
31299 &"From"&. Examples of two common formats are:
31300 .code
31301 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
31302 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
31303 .endd
31304 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
31305 Exim recognizes such lines at the start of messages that are submitted to it
31306 via the command line (that is, on the standard input). It does not recognize
31307 such lines in incoming SMTP messages, unless the sending host matches
31308 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
31309 and &%ignore_fromline_local%& is set. The recognition is controlled by a
31310 regular expression that is defined by the &%uucp_from_pattern%& option, whose
31311 default value matches the two common cases shown above and puts the address
31312 that follows &"From"& into &$1$&.
31313
31314 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
31315 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
31316 a trusted user, the message's sender address is constructed by expanding the
31317 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
31318 then parsed as an RFC 2822 address. If there is no domain, the local part is
31319 qualified with &%qualify_domain%& unless it is the empty string. However, if
31320 the command line &%-f%& option is used, it overrides the &"From"& line.
31321
31322 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
31323 sender address is not changed. This is also the case for incoming SMTP messages
31324 that are permitted to contain &"From"& lines.
31325
31326 Only one &"From"& line is recognized. If there is more than one, the second is
31327 treated as a data line that starts the body of the message, as it is not valid
31328 as a header line. This also happens if a &"From"& line is present in an
31329 incoming SMTP message from a source that is not permitted to send them.
31330
31331
31332
31333 .section "Resent- header lines" "SECID220"
31334 .cindex "&%Resent-%& header lines"
31335 RFC 2822 makes provision for sets of header lines starting with the string
31336 &`Resent-`& to be added to a message when it is resent by the original
31337 recipient to somebody else. These headers are &'Resent-Date:'&,
31338 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
31339 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
31340
31341 .blockquote
31342 &'Resent fields are strictly informational. They MUST NOT be used in the normal
31343 processing of replies or other such automatic actions on messages.'&
31344 .endblockquote
31345
31346 This leaves things a bit vague as far as other processing actions such as
31347 address rewriting are concerned. Exim treats &%Resent-%& header lines as
31348 follows:
31349
31350 .ilist
31351 A &'Resent-From:'& line that just contains the login id of the submitting user
31352 is automatically rewritten in the same way as &'From:'& (see below).
31353 .next
31354 If there's a rewriting rule for a particular header line, it is also applied to
31355 &%Resent-%& header lines of the same type. For example, a rule that rewrites
31356 &'From:'& also rewrites &'Resent-From:'&.
31357 .next
31358 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
31359 also removed.
31360 .next
31361 For a locally-submitted message,
31362 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
31363 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
31364 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
31365 included in log lines in this case.
31366 .next
31367 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
31368 &%Resent-%& header lines are present.
31369 .endlist
31370
31371
31372
31373
31374 .section "The Auto-Submitted: header line" "SECID221"
31375 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
31376 includes the header line:
31377 .code
31378 Auto-Submitted: auto-replied
31379 .endd
31380
31381 .section "The Bcc: header line" "SECID222"
31382 .cindex "&'Bcc:'& header line"
31383 If Exim is called with the &%-t%& option, to take recipient addresses from a
31384 message's header, it removes any &'Bcc:'& header line that may exist (after
31385 extracting its addresses). If &%-t%& is not present on the command line, any
31386 existing &'Bcc:'& is not removed.
31387
31388
31389 .section "The Date: header line" "SECID223"
31390 .cindex "&'Date:'& header line"
31391 If a locally-generated or submission-mode message has no &'Date:'& header line,
31392 Exim adds one, using the current date and time, unless the
31393 &%suppress_local_fixups%& control has been specified.
31394
31395 .section "The Delivery-date: header line" "SECID224"
31396 .cindex "&'Delivery-date:'& header line"
31397 .oindex "&%delivery_date_remove%&"
31398 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
31399 set. Exim can be configured to add them to the final delivery of messages. (See
31400 the generic &%delivery_date_add%& transport option.) They should not be present
31401 in messages in transit. If the &%delivery_date_remove%& configuration option is
31402 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
31403 messages.
31404
31405
31406 .section "The Envelope-to: header line" "SECID225"
31407 .cindex "&'Envelope-to:'& header line"
31408 .oindex "&%envelope_to_remove%&"
31409 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
31410 Exim can be configured to add them to the final delivery of messages. (See the
31411 generic &%envelope_to_add%& transport option.) They should not be present in
31412 messages in transit. If the &%envelope_to_remove%& configuration option is set
31413 (the default), Exim removes &'Envelope-to:'& header lines from incoming
31414 messages.
31415
31416
31417 .section "The From: header line" "SECTthefrohea"
31418 .cindex "&'From:'& header line"
31419 .cindex "Sendmail compatibility" "&""From""& line"
31420 .cindex "message" "submission"
31421 .cindex "submission mode"
31422 If a submission-mode message does not contain a &'From:'& header line, Exim
31423 adds one if either of the following conditions is true:
31424
31425 .ilist
31426 The envelope sender address is not empty (that is, this is not a bounce
31427 message). The added header line copies the envelope sender address.
31428 .next
31429 .vindex "&$authenticated_id$&"
31430 The SMTP session is authenticated and &$authenticated_id$& is not empty.
31431 .olist
31432 .vindex "&$qualify_domain$&"
31433 If no domain is specified by the submission control, the local part is
31434 &$authenticated_id$& and the domain is &$qualify_domain$&.
31435 .next
31436 If a non-empty domain is specified by the submission control, the local
31437 part is &$authenticated_id$&, and the domain is the specified domain.
31438 .next
31439 If an empty domain is specified by the submission control,
31440 &$authenticated_id$& is assumed to be the complete address.
31441 .endlist
31442 .endlist
31443
31444 A non-empty envelope sender takes precedence.
31445
31446 If a locally-generated incoming message does not contain a &'From:'& header
31447 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
31448 containing the sender's address. The calling user's login name and full name
31449 are used to construct the address, as described in section &<<SECTconstr>>&.
31450 They are obtained from the password data by calling &[getpwuid()]& (but see the
31451 &%unknown_login%& configuration option). The address is qualified with
31452 &%qualify_domain%&.
31453
31454 For compatibility with Sendmail, if an incoming, non-SMTP message has a
31455 &'From:'& header line containing just the unqualified login name of the calling
31456 user, this is replaced by an address containing the user's login name and full
31457 name as described in section &<<SECTconstr>>&.
31458
31459
31460 .section "The Message-ID: header line" "SECID226"
31461 .cindex "&'Message-ID:'& header line"
31462 .cindex "message" "submission"
31463 .oindex "&%message_id_header_text%&"
31464 If a locally-generated or submission-mode incoming message does not contain a
31465 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
31466 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
31467 to the message. If there are any &'Resent-:'& headers in the message, it
31468 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
31469 message id, preceded by the letter E to ensure it starts with a letter, and
31470 followed by @ and the primary host name. Additional information can be included
31471 in this header line by setting the &%message_id_header_text%& and/or
31472 &%message_id_header_domain%& options.
31473
31474
31475 .section "The Received: header line" "SECID227"
31476 .cindex "&'Received:'& header line"
31477 A &'Received:'& header line is added at the start of every message. The
31478 contents are defined by the &%received_header_text%& configuration option, and
31479 Exim automatically adds a semicolon and a timestamp to the configured string.
31480
31481 The &'Received:'& header is generated as soon as the message's header lines
31482 have been received. At this stage, the timestamp in the &'Received:'& header
31483 line is the time that the message started to be received. This is the value
31484 that is seen by the DATA ACL and by the &[local_scan()]& function.
31485
31486 Once a message is accepted, the timestamp in the &'Received:'& header line is
31487 changed to the time of acceptance, which is (apart from a small delay while the
31488 -H spool file is written) the earliest time at which delivery could start.
31489
31490
31491 .section "The References: header line" "SECID228"
31492 .cindex "&'References:'& header line"
31493 Messages created by the &(autoreply)& transport include a &'References:'&
31494 header line. This is constructed according to the rules that are described in
31495 section 3.64 of RFC 2822 (which states that replies should contain such a
31496 header line), and section 3.14 of RFC 3834 (which states that automatic
31497 responses are not different in this respect). However, because some mail
31498 processing software does not cope well with very long header lines, no more
31499 than 12 message IDs are copied from the &'References:'& header line in the
31500 incoming message. If there are more than 12, the first one and then the final
31501 11 are copied, before adding the message ID of the incoming message.
31502
31503
31504
31505 .section "The Return-path: header line" "SECID229"
31506 .cindex "&'Return-path:'& header line"
31507 .oindex "&%return_path_remove%&"
31508 &'Return-path:'& header lines are defined as something an MTA may insert when
31509 it does the final delivery of messages. (See the generic &%return_path_add%&
31510 transport option.) Therefore, they should not be present in messages in
31511 transit. If the &%return_path_remove%& configuration option is set (the
31512 default), Exim removes &'Return-path:'& header lines from incoming messages.
31513
31514
31515
31516 .section "The Sender: header line" "SECTthesenhea"
31517 .cindex "&'Sender:'& header line"
31518 .cindex "message" "submission"
31519 For a locally-originated message from an untrusted user, Exim may remove an
31520 existing &'Sender:'& header line, and it may add a new one. You can modify
31521 these actions by setting the &%local_sender_retain%& option true, the
31522 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31523 control setting.
31524
31525 When a local message is received from an untrusted user and
31526 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31527 control has not been set, a check is made to see if the address given in the
31528 &'From:'& header line is the correct (local) sender of the message. The address
31529 that is expected has the login name as the local part and the value of
31530 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31531 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31532 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31533 line is added to the message.
31534
31535 If you set &%local_from_check%& false, this checking does not occur. However,
31536 the removal of an existing &'Sender:'& line still happens, unless you also set
31537 &%local_sender_retain%& to be true. It is not possible to set both of these
31538 options true at the same time.
31539
31540 .cindex "submission mode"
31541 By default, no processing of &'Sender:'& header lines is done for messages
31542 received over TCP/IP or for messages submitted by trusted users. However, when
31543 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31544 not specified on the submission control, the following processing takes place:
31545
31546 .vindex "&$authenticated_id$&"
31547 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31548 authenticated, and &$authenticated_id$& is not empty, a sender address is
31549 created as follows:
31550
31551 .ilist
31552 .vindex "&$qualify_domain$&"
31553 If no domain is specified by the submission control, the local part is
31554 &$authenticated_id$& and the domain is &$qualify_domain$&.
31555 .next
31556 If a non-empty domain is specified by the submission control, the local part
31557 is &$authenticated_id$&, and the domain is the specified domain.
31558 .next
31559 If an empty domain is specified by the submission control,
31560 &$authenticated_id$& is assumed to be the complete address.
31561 .endlist
31562
31563 This address is compared with the address in the &'From:'& header line. If they
31564 are different, a &'Sender:'& header line containing the created address is
31565 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31566 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31567
31568 .cindex "return path" "created from &'Sender:'&"
31569 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31570 the message (the envelope sender address) is changed to be the same address,
31571 except in the case of submission mode when &%sender_retain%& is specified.
31572
31573
31574
31575 .section "Adding and removing header lines in routers and transports" &&&
31576          "SECTheadersaddrem"
31577 .cindex "header lines" "adding; in router or transport"
31578 .cindex "header lines" "removing; in router or transport"
31579 When a message is delivered, the addition and removal of header lines can be
31580 specified in a system filter, or on any of the routers and transports that
31581 process the message. Section &<<SECTaddremheasys>>& contains details about
31582 modifying headers in a system filter. Header lines can also be added in an ACL
31583 as a message is received (see section &<<SECTaddheadacl>>&).
31584
31585 In contrast to what happens in a system filter, header modifications that are
31586 specified on routers and transports apply only to the particular recipient
31587 addresses that are being processed by those routers and transports. These
31588 changes do not actually take place until a copy of the message is being
31589 transported. Therefore, they do not affect the basic set of header lines, and
31590 they do not affect the values of the variables that refer to header lines.
31591
31592 &*Note*&: In particular, this means that any expansions in the configuration of
31593 the transport cannot refer to the modified header lines, because such
31594 expansions all occur before the message is actually transported.
31595
31596 For both routers and transports, the result of expanding a &%headers_add%&
31597 option must be in the form of one or more RFC 2822 header lines, separated by
31598 newlines (coded as &"\n"&). For example:
31599 .code
31600 headers_add = X-added-header: added by $primary_hostname\n\
31601               X-added-second: another added header line
31602 .endd
31603 Exim does not check the syntax of these added header lines.
31604
31605 Multiple &%headers_add%& options for a single router or transport can be
31606 specified; the values will be concatenated (with a separating newline
31607 added) before expansion.
31608
31609 The result of expanding &%headers_remove%& must consist of a colon-separated
31610 list of header names. This is confusing, because header names themselves are
31611 often terminated by colons. In this case, the colons are the list separators,
31612 not part of the names. For example:
31613 .code
31614 headers_remove = return-receipt-to:acknowledge-to
31615 .endd
31616
31617 Multiple &%headers_remove%& options for a single router or transport can be
31618 specified; the values will be concatenated (with a separating colon
31619 added) before expansion.
31620
31621 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31622 is expanded at routing time, and then associated with all addresses that are
31623 accepted by that router, and also with any new addresses that it generates. If
31624 an address passes through several routers as a result of aliasing or
31625 forwarding, the changes are cumulative.
31626
31627 .oindex "&%unseen%&"
31628 However, this does not apply to multiple routers that result from the use of
31629 the &%unseen%& option. Any header modifications that were specified by the
31630 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
31631
31632 Addresses that end up with different &%headers_add%& or &%headers_remove%&
31633 settings cannot be delivered together in a batch, so a transport is always
31634 dealing with a set of addresses that have the same header-processing
31635 requirements.
31636
31637 The transport starts by writing the original set of header lines that arrived
31638 with the message, possibly modified by the system filter. As it writes out
31639 these lines, it consults the list of header names that were attached to the
31640 recipient address(es) by &%headers_remove%& options in routers, and it also
31641 consults the transport's own &%headers_remove%& option. Header lines whose
31642 names are on either of these lists are not written out. If there are multiple
31643 instances of any listed header, they are all skipped.
31644
31645 After the remaining original header lines have been written, new header
31646 lines that were specified by routers' &%headers_add%& options are written, in
31647 the order in which they were attached to the address. These are followed by any
31648 header lines specified by the transport's &%headers_add%& option.
31649
31650 This way of handling header line modifications in routers and transports has
31651 the following consequences:
31652
31653 .ilist
31654 The original set of header lines, possibly modified by the system filter,
31655 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
31656 to it, at all times.
31657 .next
31658 Header lines that are added by a router's
31659 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
31660 expansion syntax in subsequent routers or the transport.
31661 .next
31662 Conversely, header lines that are specified for removal by &%headers_remove%&
31663 in a router remain visible to subsequent routers and the transport.
31664 .next
31665 Headers added to an address by &%headers_add%& in a router cannot be removed by
31666 a later router or by a transport.
31667 .next
31668 An added header can refer to the contents of an original header that is to be
31669 removed, even it has the same name as the added header. For example:
31670 .code
31671 headers_remove = subject
31672 headers_add = Subject: new subject (was: $h_subject:)
31673 .endd
31674 .endlist
31675
31676 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
31677 for a &(redirect)& router that has the &%one_time%& option set.
31678
31679
31680
31681
31682
31683 .section "Constructed addresses" "SECTconstr"
31684 .cindex "address" "constructed"
31685 .cindex "constructed address"
31686 When Exim constructs a sender address for a locally-generated message, it uses
31687 the form
31688 .display
31689 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
31690 .endd
31691 For example:
31692 .code
31693 Zaphod Beeblebrox <zaphod@end.univ.example>
31694 .endd
31695 The user name is obtained from the &%-F%& command line option if set, or
31696 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
31697 &"gecos"& field from the password entry. If the &"gecos"& field contains an
31698 ampersand character, this is replaced by the login name with the first letter
31699 upper cased, as is conventional in a number of operating systems. See the
31700 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
31701 The &%unknown_username%& option can be used to specify user names in cases when
31702 there is no password file entry.
31703
31704 .cindex "RFC 2047"
31705 In all cases, the user name is made to conform to RFC 2822 by quoting all or
31706 parts of it if necessary. In addition, if it contains any non-printing
31707 characters, it is encoded as described in RFC 2047, which defines a way of
31708 including non-ASCII characters in header lines. The value of the
31709 &%headers_charset%& option specifies the name of the encoding that is used (the
31710 characters are assumed to be in this encoding). The setting of
31711 &%print_topbitchars%& controls whether characters with the top bit set (that
31712 is, with codes greater than 127) count as printing characters or not.
31713
31714
31715
31716 .section "Case of local parts" "SECID230"
31717 .cindex "case of local parts"
31718 .cindex "local part" "case of"
31719 RFC 2822 states that the case of letters in the local parts of addresses cannot
31720 be assumed to be non-significant. Exim preserves the case of local parts of
31721 addresses, but by default it uses a lower-cased form when it is routing,
31722 because on most Unix systems, usernames are in lower case and case-insensitive
31723 routing is required. However, any particular router can be made to use the
31724 original case for local parts by setting the &%caseful_local_part%& generic
31725 router option.
31726
31727 .cindex "mixed-case login names"
31728 If you must have mixed-case user names on your system, the best way to proceed,
31729 assuming you want case-independent handling of incoming email, is to set up
31730 your first router to convert incoming local parts in your domains to the
31731 correct case by means of a file lookup. For example:
31732 .code
31733 correct_case:
31734   driver = redirect
31735   domains = +local_domains
31736   data = ${lookup{$local_part}cdb\
31737               {/etc/usercased.cdb}{$value}fail}\
31738               @$domain
31739 .endd
31740 For this router, the local part is forced to lower case by the default action
31741 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
31742 up a new local part in the correct case. If you then set &%caseful_local_part%&
31743 on any subsequent routers which process your domains, they will operate on
31744 local parts with the correct case in a case-sensitive manner.
31745
31746
31747
31748 .section "Dots in local parts" "SECID231"
31749 .cindex "dot" "in local part"
31750 .cindex "local part" "dots in"
31751 RFC 2822 forbids empty components in local parts. That is, an unquoted local
31752 part may not begin or end with a dot, nor have two consecutive dots in the
31753 middle. However, it seems that many MTAs do not enforce this, so Exim permits
31754 empty components for compatibility.
31755
31756
31757
31758 .section "Rewriting addresses" "SECID232"
31759 .cindex "rewriting" "addresses"
31760 Rewriting of sender and recipient addresses, and addresses in headers, can
31761 happen automatically, or as the result of configuration options, as described
31762 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
31763 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
31764
31765 Automatic rewriting includes qualification, as mentioned above. The other case
31766 in which it can happen is when an incomplete non-local domain is given. The
31767 routing process may cause this to be expanded into the full domain name. For
31768 example, a header such as
31769 .code
31770 To: hare@teaparty
31771 .endd
31772 might get rewritten as
31773 .code
31774 To: hare@teaparty.wonderland.fict.example
31775 .endd
31776 Rewriting as a result of routing is the one kind of message processing that
31777 does not happen at input time, as it cannot be done until the address has
31778 been routed.
31779
31780 Strictly, one should not do &'any'& deliveries of a message until all its
31781 addresses have been routed, in case any of the headers get changed as a
31782 result of routing. However, doing this in practice would hold up many
31783 deliveries for unreasonable amounts of time, just because one address could not
31784 immediately be routed. Exim therefore does not delay other deliveries when
31785 routing of one or more addresses is deferred.
31786 .ecindex IIDmesproc
31787
31788
31789
31790 . ////////////////////////////////////////////////////////////////////////////
31791 . ////////////////////////////////////////////////////////////////////////////
31792
31793 .chapter "SMTP processing" "CHAPSMTP"
31794 .scindex IIDsmtpproc1 "SMTP" "processing details"
31795 .scindex IIDsmtpproc2 "LMTP" "processing details"
31796 Exim supports a number of different ways of using the SMTP protocol, and its
31797 LMTP variant, which is an interactive protocol for transferring messages into a
31798 closed mail store application. This chapter contains details of how SMTP is
31799 processed. For incoming mail, the following are available:
31800
31801 .ilist
31802 SMTP over TCP/IP (Exim daemon or &'inetd'&);
31803 .next
31804 SMTP over the standard input and output (the &%-bs%& option);
31805 .next
31806 Batched SMTP on the standard input (the &%-bS%& option).
31807 .endlist
31808
31809 For mail delivery, the following are available:
31810
31811 .ilist
31812 SMTP over TCP/IP (the &(smtp)& transport);
31813 .next
31814 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
31815 &"lmtp"&);
31816 .next
31817 LMTP over a pipe to a process running in the local host (the &(lmtp)&
31818 transport);
31819 .next
31820 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
31821 the &%use_bsmtp%& option set).
31822 .endlist
31823
31824 &'Batched SMTP'& is the name for a process in which batches of messages are
31825 stored in or read from files (or pipes), in a format in which SMTP commands are
31826 used to contain the envelope information.
31827
31828
31829
31830 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
31831 .cindex "SMTP" "outgoing over TCP/IP"
31832 .cindex "outgoing SMTP over TCP/IP"
31833 .cindex "LMTP" "over TCP/IP"
31834 .cindex "outgoing LMTP over TCP/IP"
31835 .cindex "EHLO"
31836 .cindex "HELO"
31837 .cindex "SIZE option on MAIL command"
31838 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
31839 The &%protocol%& option selects which protocol is to be used, but the actual
31840 processing is the same in both cases.
31841
31842 If, in response to its EHLO command, Exim is told that the SIZE
31843 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
31844 command. The value of <&'n'&> is the message size plus the value of the
31845 &%size_addition%& option (default 1024) to allow for additions to the message
31846 such as per-transport header lines, or changes made in a
31847 .cindex "transport" "filter"
31848 .cindex "filter" "transport filter"
31849 transport filter. If &%size_addition%& is set negative, the use of SIZE is
31850 suppressed.
31851
31852 If the remote server advertises support for PIPELINING, Exim uses the
31853 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
31854 required for the transaction.
31855
31856 If the remote server advertises support for the STARTTLS command, and Exim
31857 was built to support TLS encryption, it tries to start a TLS session unless the
31858 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
31859 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
31860 is called for verification.
31861
31862 If the remote server advertises support for the AUTH command, Exim scans
31863 the authenticators configuration for any suitable client settings, as described
31864 in chapter &<<CHAPSMTPAUTH>>&.
31865
31866 .cindex "carriage return"
31867 .cindex "linefeed"
31868 Responses from the remote host are supposed to be terminated by CR followed by
31869 LF. However, there are known to be hosts that do not send CR characters, so in
31870 order to be able to interwork with such hosts, Exim treats LF on its own as a
31871 line terminator.
31872
31873 If a message contains a number of different addresses, all those with the same
31874 characteristics (for example, the same envelope sender) that resolve to the
31875 same set of hosts, in the same order, are sent in a single SMTP transaction,
31876 even if they are for different domains, unless there are more than the setting
31877 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
31878 they are split into groups containing no more than &%max_rcpt%&s addresses
31879 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
31880 in parallel sessions. The order of hosts with identical MX values is not
31881 significant when checking whether addresses can be batched in this way.
31882
31883 When the &(smtp)& transport suffers a temporary failure that is not
31884 message-related, Exim updates its transport-specific database, which contains
31885 records indexed by host name that remember which messages are waiting for each
31886 particular host. It also updates the retry database with new retry times.
31887
31888 .cindex "hints database" "retry keys"
31889 Exim's retry hints are based on host name plus IP address, so if one address of
31890 a multi-homed host is broken, it will soon be skipped most of the time.
31891 See the next section for more detail about error handling.
31892
31893 .cindex "SMTP" "passed connection"
31894 .cindex "SMTP" "batching over TCP/IP"
31895 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
31896 looks in the hints database for the transport to see if there are any queued
31897 messages waiting for the host to which it is connected. If it finds one, it
31898 creates a new Exim process using the &%-MC%& option (which can only be used by
31899 a process running as root or the Exim user) and passes the TCP/IP socket to it
31900 so that it can deliver another message using the same socket. The new process
31901 does only those deliveries that are routed to the connected host, and may in
31902 turn pass the socket on to a third process, and so on.
31903
31904 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
31905 limit the number of messages sent down a single TCP/IP connection.
31906
31907 .cindex "asterisk" "after IP address"
31908 The second and subsequent messages delivered down an existing connection are
31909 identified in the main log by the addition of an asterisk after the closing
31910 square bracket of the IP address.
31911
31912
31913
31914
31915 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
31916 .cindex "error" "in outgoing SMTP"
31917 .cindex "SMTP" "errors in outgoing"
31918 .cindex "host" "error"
31919 Three different kinds of error are recognized for outgoing SMTP: host errors,
31920 message errors, and recipient errors.
31921
31922 .vlist
31923 .vitem "&*Host errors*&"
31924 A host error is not associated with a particular message or with a
31925 particular recipient of a message. The host errors are:
31926
31927 .ilist
31928 Connection refused or timed out,
31929 .next
31930 Any error response code on connection,
31931 .next
31932 Any error response code to EHLO or HELO,
31933 .next
31934 Loss of connection at any time, except after &"."&,
31935 .next
31936 I/O errors at any time,
31937 .next
31938 Timeouts during the session, other than in response to MAIL, RCPT or
31939 the &"."& at the end of the data.
31940 .endlist ilist
31941
31942 For a host error, a permanent error response on connection, or in response to
31943 EHLO, causes all addresses routed to the host to be failed. Any other host
31944 error causes all addresses to be deferred, and retry data to be created for the
31945 host. It is not tried again, for any message, until its retry time arrives. If
31946 the current set of addresses are not all delivered in this run (to some
31947 alternative host), the message is added to the list of those waiting for this
31948 host, so if it is still undelivered when a subsequent successful delivery is
31949 made to the host, it will be sent down the same SMTP connection.
31950
31951 .vitem "&*Message errors*&"
31952 .cindex "message" "error"
31953 A message error is associated with a particular message when sent to a
31954 particular host, but not with a particular recipient of the message. The
31955 message errors are:
31956
31957 .ilist
31958 Any error response code to MAIL, DATA, or the &"."& that terminates
31959 the data,
31960 .next
31961 Timeout after MAIL,
31962 .next
31963 Timeout or loss of connection after the &"."& that terminates the data. A
31964 timeout after the DATA command itself is treated as a host error, as is loss of
31965 connection at any other time.
31966 .endlist ilist
31967
31968 For a message error, a permanent error response (5&'xx'&) causes all addresses
31969 to be failed, and a delivery error report to be returned to the sender. A
31970 temporary error response (4&'xx'&), or one of the timeouts, causes all
31971 addresses to be deferred. Retry data is not created for the host, but instead,
31972 a retry record for the combination of host plus message id is created. The
31973 message is not added to the list of those waiting for this host. This ensures
31974 that the failing message will not be sent to this host again until the retry
31975 time arrives. However, other messages that are routed to the host are not
31976 affected, so if it is some property of the message that is causing the error,
31977 it will not stop the delivery of other mail.
31978
31979 If the remote host specified support for the SIZE parameter in its response
31980 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
31981 over-large message will cause a message error because the error arrives as a
31982 response to MAIL.
31983
31984 .vitem "&*Recipient errors*&"
31985 .cindex "recipient" "error"
31986 A recipient error is associated with a particular recipient of a message. The
31987 recipient errors are:
31988
31989 .ilist
31990 Any error response to RCPT,
31991 .next
31992 Timeout after RCPT.
31993 .endlist
31994
31995 For a recipient error, a permanent error response (5&'xx'&) causes the
31996 recipient address to be failed, and a bounce message to be returned to the
31997 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
31998 address to be deferred, and routing retry data to be created for it. This is
31999 used to delay processing of the address in subsequent queue runs, until its
32000 routing retry time arrives. This applies to all messages, but because it
32001 operates only in queue runs, one attempt will be made to deliver a new message
32002 to the failing address before the delay starts to operate. This ensures that,
32003 if the failure is really related to the message rather than the recipient
32004 (&"message too big for this recipient"& is a possible example), other messages
32005 have a chance of getting delivered. If a delivery to the address does succeed,
32006 the retry information gets cleared, so all stuck messages get tried again, and
32007 the retry clock is reset.
32008
32009 The message is not added to the list of those waiting for this host. Use of the
32010 host for other messages is unaffected, and except in the case of a timeout,
32011 other recipients are processed independently, and may be successfully delivered
32012 in the current SMTP session. After a timeout it is of course impossible to
32013 proceed with the session, so all addresses get deferred. However, those other
32014 than the one that failed do not suffer any subsequent retry delays. Therefore,
32015 if one recipient is causing trouble, the others have a chance of getting
32016 through when a subsequent delivery attempt occurs before the failing
32017 recipient's retry time.
32018 .endlist
32019
32020 In all cases, if there are other hosts (or IP addresses) available for the
32021 current set of addresses (for example, from multiple MX records), they are
32022 tried in this run for any undelivered addresses, subject of course to their
32023 own retry data. In other words, recipient error retry data does not take effect
32024 until the next delivery attempt.
32025
32026 Some hosts have been observed to give temporary error responses to every
32027 MAIL command at certain times (&"insufficient space"& has been seen). It
32028 would be nice if such circumstances could be recognized, and defer data for the
32029 host itself created, but this is not possible within the current Exim design.
32030 What actually happens is that retry data for every (host, message) combination
32031 is created.
32032
32033 The reason that timeouts after MAIL and RCPT are treated specially is that
32034 these can sometimes arise as a result of the remote host's verification
32035 procedures. Exim makes this assumption, and treats them as if a temporary error
32036 response had been received. A timeout after &"."& is treated specially because
32037 it is known that some broken implementations fail to recognize the end of the
32038 message if the last character of the last line is a binary zero. Thus, it is
32039 helpful to treat this case as a message error.
32040
32041 Timeouts at other times are treated as host errors, assuming a problem with the
32042 host, or the connection to it. If a timeout after MAIL, RCPT,
32043 or &"."& is really a connection problem, the assumption is that at the next try
32044 the timeout is likely to occur at some other point in the dialogue, causing it
32045 then to be treated as a host error.
32046
32047 There is experimental evidence that some MTAs drop the connection after the
32048 terminating &"."& if they do not like the contents of the message for some
32049 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
32050 should be given. That is why Exim treats this case as a message rather than a
32051 host error, in order not to delay other messages to the same host.
32052
32053
32054
32055
32056 .section "Incoming SMTP messages over TCP/IP" "SECID233"
32057 .cindex "SMTP" "incoming over TCP/IP"
32058 .cindex "incoming SMTP over TCP/IP"
32059 .cindex "inetd"
32060 .cindex "daemon"
32061 Incoming SMTP messages can be accepted in one of two ways: by running a
32062 listening daemon, or by using &'inetd'&. In the latter case, the entry in
32063 &_/etc/inetd.conf_& should be like this:
32064 .code
32065 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
32066 .endd
32067 Exim distinguishes between this case and the case of a locally running user
32068 agent using the &%-bs%& option by checking whether or not the standard input is
32069 a socket. When it is, either the port must be privileged (less than 1024), or
32070 the caller must be root or the Exim user. If any other user passes a socket
32071 with an unprivileged port number, Exim prints a message on the standard error
32072 stream and exits with an error code.
32073
32074 By default, Exim does not make a log entry when a remote host connects or
32075 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
32076 unexpected. It can be made to write such log entries by setting the
32077 &%smtp_connection%& log selector.
32078
32079 .cindex "carriage return"
32080 .cindex "linefeed"
32081 Commands from the remote host are supposed to be terminated by CR followed by
32082 LF. However, there are known to be hosts that do not send CR characters. In
32083 order to be able to interwork with such hosts, Exim treats LF on its own as a
32084 line terminator.
32085 Furthermore, because common code is used for receiving messages from all
32086 sources, a CR on its own is also interpreted as a line terminator. However, the
32087 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
32088
32089 .cindex "EHLO" "invalid data"
32090 .cindex "HELO" "invalid data"
32091 One area that sometimes gives rise to problems concerns the EHLO or
32092 HELO commands. Some clients send syntactically invalid versions of these
32093 commands, which Exim rejects by default. (This is nothing to do with verifying
32094 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
32095 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
32096 match the broken hosts that send invalid commands.
32097
32098 .cindex "SIZE option on MAIL command"
32099 .cindex "MAIL" "SIZE option"
32100 The amount of disk space available is checked whenever SIZE is received on
32101 a MAIL command, independently of whether &%message_size_limit%& or
32102 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
32103 false. A temporary error is given if there is not enough space. If
32104 &%check_spool_space%& is set, the check is for that amount of space plus the
32105 value given with SIZE, that is, it checks that the addition of the incoming
32106 message will not reduce the space below the threshold.
32107
32108 When a message is successfully received, Exim includes the local message id in
32109 its response to the final &"."& that terminates the data. If the remote host
32110 logs this text it can help with tracing what has happened to a message.
32111
32112 The Exim daemon can limit the number of simultaneous incoming connections it is
32113 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
32114 number of simultaneous incoming connections from a single remote host (see the
32115 &%smtp_accept_max_per_host%& option). Additional connection attempts are
32116 rejected using the SMTP temporary error code 421.
32117
32118 The Exim daemon does not rely on the SIGCHLD signal to detect when a
32119 subprocess has finished, as this can get lost at busy times. Instead, it looks
32120 for completed subprocesses every time it wakes up. Provided there are other
32121 things happening (new incoming calls, starts of queue runs), completed
32122 processes will be noticed and tidied away. On very quiet systems you may
32123 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
32124 it will be noticed when the daemon next wakes up.
32125
32126 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
32127 and can also be set up to reject SMTP calls from non-reserved hosts at times of
32128 high system load &-- for details see the &%smtp_accept_reserve%&,
32129 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
32130 applies in both the daemon and &'inetd'& cases.
32131
32132 Exim normally starts a delivery process for each message received, though this
32133 can be varied by means of the &%-odq%& command line option and the
32134 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
32135 number of simultaneously running delivery processes started in this way from
32136 SMTP input can be limited by the &%smtp_accept_queue%& and
32137 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
32138 subsequently received messages are just put on the input queue without starting
32139 a delivery process.
32140
32141 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
32142 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
32143 started up from the &'inetd'& daemon, because in that case each connection is
32144 handled by an entirely independent Exim process. Control by load average is,
32145 however, available with &'inetd'&.
32146
32147 Exim can be configured to verify addresses in incoming SMTP commands as they
32148 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
32149 to rewrite addresses at this time &-- before any syntax checking is done. See
32150 section &<<SECTrewriteS>>&.
32151
32152 Exim can also be configured to limit the rate at which a client host submits
32153 MAIL and RCPT commands in a single SMTP session. See the
32154 &%smtp_ratelimit_hosts%& option.
32155
32156
32157
32158 .section "Unrecognized SMTP commands" "SECID234"
32159 .cindex "SMTP" "unrecognized commands"
32160 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
32161 commands during a single SMTP connection, it drops the connection after sending
32162 the error response to the last command. The default value for
32163 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
32164 abuse that subvert web servers into making connections to SMTP ports; in these
32165 circumstances, a number of non-SMTP lines are sent first.
32166
32167
32168 .section "Syntax and protocol errors in SMTP commands" "SECID235"
32169 .cindex "SMTP" "syntax errors"
32170 .cindex "SMTP" "protocol errors"
32171 A syntax error is detected if an SMTP command is recognized, but there is
32172 something syntactically wrong with its data, for example, a malformed email
32173 address in a RCPT command. Protocol errors include invalid command
32174 sequencing such as RCPT before MAIL. If Exim receives more than
32175 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
32176 drops the connection after sending the error response to the last command. The
32177 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
32178 broken clients that loop sending bad commands (yes, it has been seen).
32179
32180
32181
32182 .section "Use of non-mail SMTP commands" "SECID236"
32183 .cindex "SMTP" "non-mail commands"
32184 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
32185 DATA. Exim counts such commands, and drops the connection if there are too
32186 many of them in a single SMTP session. This action catches some
32187 denial-of-service attempts and things like repeated failing AUTHs, or a mad
32188 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
32189 defines what &"too many"& means. Its default value is 10.
32190
32191 When a new message is expected, one occurrence of RSET is not counted. This
32192 allows a client to send one RSET between messages (this is not necessary,
32193 but some clients do it). Exim also allows one uncounted occurrence of HELO
32194 or EHLO, and one occurrence of STARTTLS between messages. After
32195 starting up a TLS session, another EHLO is expected, and so it too is not
32196 counted.
32197
32198 The first occurrence of AUTH in a connection, or immediately following
32199 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
32200 RCPT, DATA, and QUIT are counted.
32201
32202 You can control which hosts are subject to the limit set by
32203 &%smtp_accept_max_nonmail%& by setting
32204 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
32205 the limit apply to all hosts. This option means that you can exclude any
32206 specific badly-behaved hosts that you have to live with.
32207
32208
32209
32210
32211 .section "The VRFY and EXPN commands" "SECID237"
32212 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
32213 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
32214 appropriate) in order to decide whether the command should be accepted or not.
32215 If no ACL is defined, the command is rejected.
32216
32217 .cindex "VRFY" "processing"
32218 When VRFY is accepted, it runs exactly the same code as when Exim is
32219 called with the &%-bv%& option.
32220
32221 .cindex "EXPN" "processing"
32222 When EXPN is accepted, a single-level expansion of the address is done.
32223 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
32224 than a verification (the &%-bv%& option). If an unqualified local part is given
32225 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
32226 of VRFY and EXPN commands are logged on the main and reject logs, and
32227 VRFY verification failures are logged on the main log for consistency with
32228 RCPT failures.
32229
32230
32231
32232 .section "The ETRN command" "SECTETRN"
32233 .cindex "ETRN" "processing"
32234 RFC 1985 describes an SMTP command called ETRN that is designed to
32235 overcome the security problems of the TURN command (which has fallen into
32236 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
32237 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
32238 should be accepted or not. If no ACL is defined, the command is rejected.
32239
32240 The ETRN command is concerned with &"releasing"& messages that are awaiting
32241 delivery to certain hosts. As Exim does not organize its message queue by host,
32242 the only form of ETRN that is supported by default is the one where the
32243 text starts with the &"#"& prefix, in which case the remainder of the text is
32244 specific to the SMTP server. A valid ETRN command causes a run of Exim with
32245 the &%-R%& option to happen, with the remainder of the ETRN text as its
32246 argument. For example,
32247 .code
32248 ETRN #brigadoon
32249 .endd
32250 runs the command
32251 .code
32252 exim -R brigadoon
32253 .endd
32254 which causes a delivery attempt on all messages with undelivered addresses
32255 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
32256 default), Exim prevents the simultaneous execution of more than one queue run
32257 for the same argument string as a result of an ETRN command. This stops
32258 a misbehaving client from starting more than one queue runner at once.
32259
32260 .cindex "hints database" "ETRN serialization"
32261 Exim implements the serialization by means of a hints database in which a
32262 record is written whenever a process is started by ETRN, and deleted when
32263 the process completes. However, Exim does not keep the SMTP session waiting for
32264 the ETRN process to complete. Once ETRN is accepted, the client is sent
32265 a &"success"& return code. Obviously there is scope for hints records to get
32266 left lying around if there is a system or program crash. To guard against this,
32267 Exim ignores any records that are more than six hours old.
32268
32269 .oindex "&%smtp_etrn_command%&"
32270 For more control over what ETRN does, the &%smtp_etrn_command%& option can
32271 used. This specifies a command that is run whenever ETRN is received,
32272 whatever the form of its argument. For
32273 example:
32274 .code
32275 smtp_etrn_command = /etc/etrn_command $domain \
32276                     $sender_host_address
32277 .endd
32278 .vindex "&$domain$&"
32279 The string is split up into arguments which are independently expanded. The
32280 expansion variable &$domain$& is set to the argument of the ETRN command,
32281 and no syntax checking is done on the contents of this argument. Exim does not
32282 wait for the command to complete, so its status code is not checked. Exim runs
32283 under its own uid and gid when receiving incoming SMTP, so it is not possible
32284 for it to change them before running the command.
32285
32286
32287
32288 .section "Incoming local SMTP" "SECID238"
32289 .cindex "SMTP" "local incoming"
32290 Some user agents use SMTP to pass messages to their local MTA using the
32291 standard input and output, as opposed to passing the envelope on the command
32292 line and writing the message to the standard input. This is supported by the
32293 &%-bs%& option. This form of SMTP is handled in the same way as incoming
32294 messages over TCP/IP (including the use of ACLs), except that the envelope
32295 sender given in a MAIL command is ignored unless the caller is trusted. In
32296 an ACL you can detect this form of SMTP input by testing for an empty host
32297 identification. It is common to have this as the first line in the ACL that
32298 runs for RCPT commands:
32299 .code
32300 accept hosts = :
32301 .endd
32302 This accepts SMTP messages from local processes without doing any other tests.
32303
32304
32305
32306 .section "Outgoing batched SMTP" "SECTbatchSMTP"
32307 .cindex "SMTP" "batched outgoing"
32308 .cindex "batched SMTP output"
32309 Both the &(appendfile)& and &(pipe)& transports can be used for handling
32310 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
32311 be output in BSMTP format. No SMTP responses are possible for this form of
32312 delivery. All it is doing is using SMTP commands as a way of transmitting the
32313 envelope along with the message.
32314
32315 The message is written to the file or pipe preceded by the SMTP commands
32316 MAIL and RCPT, and followed by a line containing a single dot. Lines in
32317 the message that start with a dot have an extra dot added. The SMTP command
32318 HELO is not normally used. If it is required, the &%message_prefix%& option
32319 can be used to specify it.
32320
32321 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
32322 one recipient address at a time by default. However, you can arrange for them
32323 to handle several addresses at once by setting the &%batch_max%& option. When
32324 this is done for BSMTP, messages may contain multiple RCPT commands. See
32325 chapter &<<CHAPbatching>>& for more details.
32326
32327 .vindex "&$host$&"
32328 When one or more addresses are routed to a BSMTP transport by a router that
32329 sets up a host list, the name of the first host on the list is available to the
32330 transport in the variable &$host$&. Here is an example of such a transport and
32331 router:
32332 .code
32333 begin routers
32334 route_append:
32335   driver = manualroute
32336   transport = smtp_appendfile
32337   route_list = domain.example  batch.host.example
32338
32339 begin transports
32340 smtp_appendfile:
32341   driver = appendfile
32342   directory = /var/bsmtp/$host
32343   batch_max = 1000
32344   use_bsmtp
32345   user = exim
32346 .endd
32347 This causes messages addressed to &'domain.example'& to be written in BSMTP
32348 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
32349 message (unless there are more than 1000 recipients).
32350
32351
32352
32353 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
32354 .cindex "SMTP" "batched incoming"
32355 .cindex "batched SMTP input"
32356 The &%-bS%& command line option causes Exim to accept one or more messages by
32357 reading SMTP on the standard input, but to generate no responses. If the caller
32358 is trusted, the senders in the MAIL commands are believed; otherwise the
32359 sender is always the caller of Exim. Unqualified senders and receivers are not
32360 rejected (there seems little point) but instead just get qualified. HELO
32361 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
32362 as NOOP; QUIT quits.
32363
32364 Minimal policy checking is done for BSMTP input. Only the non-SMTP
32365 ACL is run in the same way as for non-SMTP local input.
32366
32367 If an error is detected while reading a message, including a missing &"."& at
32368 the end, Exim gives up immediately. It writes details of the error to the
32369 standard output in a stylized way that the calling program should be able to
32370 make some use of automatically, for example:
32371 .code
32372 554 Unexpected end of file
32373 Transaction started in line 10
32374 Error detected in line 14
32375 .endd
32376 It writes a more verbose version, for human consumption, to the standard error
32377 file, for example:
32378 .code
32379 An error was detected while processing a file of BSMTP input.
32380 The error message was:
32381
32382 501 '>' missing at end of address
32383
32384 The SMTP transaction started in line 10.
32385 The error was detected in line 12.
32386 The SMTP command at fault was:
32387
32388 rcpt to:<malformed@in.com.plete
32389
32390 1 previous message was successfully processed.
32391 The rest of the batch was abandoned.
32392 .endd
32393 The return code from Exim is zero only if there were no errors. It is 1 if some
32394 messages were accepted before an error was detected, and 2 if no messages were
32395 accepted.
32396 .ecindex IIDsmtpproc1
32397 .ecindex IIDsmtpproc2
32398
32399
32400
32401 . ////////////////////////////////////////////////////////////////////////////
32402 . ////////////////////////////////////////////////////////////////////////////
32403
32404 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
32405          "Customizing messages"
32406 When a message fails to be delivered, or remains on the queue for more than a
32407 configured amount of time, Exim sends a message to the original sender, or
32408 to an alternative configured address. The text of these messages is built into
32409 the code of Exim, but it is possible to change it, either by adding a single
32410 string, or by replacing each of the paragraphs by text supplied in a file.
32411
32412 The &'From:'& and &'To:'& header lines are automatically generated; you can
32413 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
32414 option. Exim also adds the line
32415 .code
32416 Auto-Submitted: auto-generated
32417 .endd
32418 to all warning and bounce messages,
32419
32420
32421 .section "Customizing bounce messages" "SECID239"
32422 .cindex "customizing" "bounce message"
32423 .cindex "bounce message" "customizing"
32424 If &%bounce_message_text%& is set, its contents are included in the default
32425 message immediately after &"This message was created automatically by mail
32426 delivery software."& The string is not expanded. It is not used if
32427 &%bounce_message_file%& is set.
32428
32429 When &%bounce_message_file%& is set, it must point to a template file for
32430 constructing error messages. The file consists of a series of text items,
32431 separated by lines consisting of exactly four asterisks. If the file cannot be
32432 opened, default text is used and a message is written to the main and panic
32433 logs. If any text item in the file is empty, default text is used for that
32434 item.
32435
32436 .vindex "&$bounce_recipient$&"
32437 .vindex "&$bounce_return_size_limit$&"
32438 Each item of text that is read from the file is expanded, and there are two
32439 expansion variables which can be of use here: &$bounce_recipient$& is set to
32440 the recipient of an error message while it is being created, and
32441 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
32442 option, rounded to a whole number.
32443
32444 The items must appear in the file in the following order:
32445
32446 .ilist
32447 The first item is included in the headers, and should include at least a
32448 &'Subject:'& header. Exim does not check the syntax of these headers.
32449 .next
32450 The second item forms the start of the error message. After it, Exim lists the
32451 failing addresses with their error messages.
32452 .next
32453 The third item is used to introduce any text from pipe transports that is to be
32454 returned to the sender. It is omitted if there is no such text.
32455 .next
32456 The fourth item is used to introduce the copy of the message that is returned
32457 as part of the error report.
32458 .next
32459 The fifth item is added after the fourth one if the returned message is
32460 truncated because it is bigger than &%return_size_limit%&.
32461 .next
32462 The sixth item is added after the copy of the original message.
32463 .endlist
32464
32465 The default state (&%bounce_message_file%& unset) is equivalent to the
32466 following file, in which the sixth item is empty. The &'Subject:'& and some
32467 other lines have been split in order to fit them on the page:
32468 .code
32469 Subject: Mail delivery failed
32470   ${if eq{$sender_address}{$bounce_recipient}
32471   {: returning message to sender}}
32472 ****
32473 This message was created automatically by mail delivery software.
32474
32475 A message ${if eq{$sender_address}{$bounce_recipient}
32476   {that you sent }{sent by
32477
32478 <$sender_address>
32479
32480 }}could not be delivered to all of its recipients.
32481 This is a permanent error. The following address(es) failed:
32482 ****
32483 The following text was generated during the delivery attempt(s):
32484 ****
32485 ------ This is a copy of the message, including all the headers.
32486   ------
32487 ****
32488 ------ The body of the message is $message_size characters long;
32489   only the first
32490 ------ $bounce_return_size_limit or so are included here.
32491 ****
32492 .endd
32493 .section "Customizing warning messages" "SECTcustwarn"
32494 .cindex "customizing" "warning message"
32495 .cindex "warning of delay" "customizing the message"
32496 The option &%warn_message_file%& can be pointed at a template file for use when
32497 warnings about message delays are created. In this case there are only three
32498 text sections:
32499
32500 .ilist
32501 The first item is included in the headers, and should include at least a
32502 &'Subject:'& header. Exim does not check the syntax of these headers.
32503 .next
32504 The second item forms the start of the warning message. After it, Exim lists
32505 the delayed addresses.
32506 .next
32507 The third item then ends the message.
32508 .endlist
32509
32510 The default state is equivalent to the following file, except that some lines
32511 have been split here, in order to fit them on the page:
32512 .code
32513 Subject: Warning: message $message_exim_id delayed
32514   $warn_message_delay
32515 ****
32516 This message was created automatically by mail delivery software.
32517
32518 A message ${if eq{$sender_address}{$warn_message_recipients}
32519 {that you sent }{sent by
32520
32521 <$sender_address>
32522
32523 }}has not been delivered to all of its recipients after
32524 more than $warn_message_delay on the queue on $primary_hostname.
32525
32526 The message identifier is:     $message_exim_id
32527 The subject of the message is: $h_subject
32528 The date of the message is:    $h_date
32529
32530 The following address(es) have not yet been delivered:
32531 ****
32532 No action is required on your part. Delivery attempts will
32533 continue for some time, and this warning may be repeated at
32534 intervals if the message remains undelivered. Eventually the
32535 mail delivery software will give up, and when that happens,
32536 the message will be returned to you.
32537 .endd
32538 .vindex "&$warn_message_delay$&"
32539 .vindex "&$warn_message_recipients$&"
32540 However, in the default state the subject and date lines are omitted if no
32541 appropriate headers exist. During the expansion of this file,
32542 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32543 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32544 of recipients for the warning message. There may be more than one if there are
32545 multiple addresses with different &%errors_to%& settings on the routers that
32546 handled them.
32547
32548
32549
32550
32551 . ////////////////////////////////////////////////////////////////////////////
32552 . ////////////////////////////////////////////////////////////////////////////
32553
32554 .chapter "Some common configuration settings" "CHAPcomconreq"
32555 This chapter discusses some configuration settings that seem to be fairly
32556 common. More examples and discussion can be found in the Exim book.
32557
32558
32559
32560 .section "Sending mail to a smart host" "SECID240"
32561 .cindex "smart host" "example router"
32562 If you want to send all mail for non-local domains to a &"smart host"&, you
32563 should replace the default &(dnslookup)& router with a router which does the
32564 routing explicitly:
32565 .code
32566 send_to_smart_host:
32567   driver = manualroute
32568   route_list = !+local_domains smart.host.name
32569   transport = remote_smtp
32570 .endd
32571 You can use the smart host's IP address instead of the name if you wish.
32572 If you are using Exim only to submit messages to a smart host, and not for
32573 receiving incoming messages, you can arrange for it to do the submission
32574 synchronously by setting the &%mua_wrapper%& option (see chapter
32575 &<<CHAPnonqueueing>>&).
32576
32577
32578
32579
32580 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32581 .cindex "mailing lists"
32582 Exim can be used to run simple mailing lists, but for large and/or complicated
32583 requirements, the use of additional specialized mailing list software such as
32584 Majordomo or Mailman is recommended.
32585
32586 The &(redirect)& router can be used to handle mailing lists where each list
32587 is maintained in a separate file, which can therefore be managed by an
32588 independent manager. The &%domains%& router option can be used to run these
32589 lists in a separate domain from normal mail. For example:
32590 .code
32591 lists:
32592   driver = redirect
32593   domains = lists.example
32594   file = /usr/lists/$local_part
32595   forbid_pipe
32596   forbid_file
32597   errors_to = $local_part-request@lists.example
32598   no_more
32599 .endd
32600 This router is skipped for domains other than &'lists.example'&. For addresses
32601 in that domain, it looks for a file that matches the local part. If there is no
32602 such file, the router declines, but because &%no_more%& is set, no subsequent
32603 routers are tried, and so the whole delivery fails.
32604
32605 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32606 expanded into a file name or a pipe delivery, which is usually inappropriate in
32607 a mailing list.
32608
32609 .oindex "&%errors_to%&"
32610 The &%errors_to%& option specifies that any delivery errors caused by addresses
32611 taken from a mailing list are to be sent to the given address rather than the
32612 original sender of the message. However, before acting on this, Exim verifies
32613 the error address, and ignores it if verification fails.
32614
32615 For example, using the configuration above, mail sent to
32616 &'dicts@lists.example'& is passed on to those addresses contained in
32617 &_/usr/lists/dicts_&, with error reports directed to
32618 &'dicts-request@lists.example'&, provided that this address can be verified.
32619 There could be a file called &_/usr/lists/dicts-request_& containing
32620 the address(es) of this particular list's manager(s), but other approaches,
32621 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32622 or &%local_part_suffix%& options) to handle addresses of the form
32623 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32624
32625
32626
32627 .section "Syntax errors in mailing lists" "SECID241"
32628 .cindex "mailing lists" "syntax errors in"
32629 If an entry in redirection data contains a syntax error, Exim normally defers
32630 delivery of the original address. That means that a syntax error in a mailing
32631 list holds up all deliveries to the list. This may not be appropriate when a
32632 list is being maintained automatically from data supplied by users, and the
32633 addresses are not rigorously checked.
32634
32635 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
32636 entries that fail to parse, noting the incident in the log. If in addition
32637 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
32638 whenever a broken address is skipped. It is usually appropriate to set
32639 &%syntax_errors_to%& to the same address as &%errors_to%&.
32640
32641
32642
32643 .section "Re-expansion of mailing lists" "SECID242"
32644 .cindex "mailing lists" "re-expansion of"
32645 Exim remembers every individual address to which a message has been delivered,
32646 in order to avoid duplication, but it normally stores only the original
32647 recipient addresses with a message. If all the deliveries to a mailing list
32648 cannot be done at the first attempt, the mailing list is re-expanded when the
32649 delivery is next tried. This means that alterations to the list are taken into
32650 account at each delivery attempt, so addresses that have been added to
32651 the list since the message arrived will therefore receive a copy of the
32652 message, even though it pre-dates their subscription.
32653
32654 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
32655 on the &(redirect)& router. If this is done, any addresses generated by the
32656 router that fail to deliver at the first attempt are added to the message as
32657 &"top level"& addresses, and the parent address that generated them is marked
32658 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
32659 subsequent delivery attempts. The disadvantage of this is that if any of the
32660 failing addresses are incorrect, correcting them in the file has no effect on
32661 pre-existing messages.
32662
32663 The original top-level address is remembered with each of the generated
32664 addresses, and is output in any log messages. However, any intermediate parent
32665 addresses are not recorded. This makes a difference to the log only if the
32666 &%all_parents%& selector is set, but for mailing lists there is normally only
32667 one level of expansion anyway.
32668
32669
32670
32671 .section "Closed mailing lists" "SECID243"
32672 .cindex "mailing lists" "closed"
32673 The examples so far have assumed open mailing lists, to which anybody may
32674 send mail. It is also possible to set up closed lists, where mail is accepted
32675 from specified senders only. This is done by making use of the generic
32676 &%senders%& option to restrict the router that handles the list.
32677
32678 The following example uses the same file as a list of recipients and as a list
32679 of permitted senders. It requires three routers:
32680 .code
32681 lists_request:
32682   driver = redirect
32683   domains = lists.example
32684   local_part_suffix = -request
32685   file = /usr/lists/$local_part$local_part_suffix
32686   no_more
32687
32688 lists_post:
32689   driver = redirect
32690   domains = lists.example
32691   senders = ${if exists {/usr/lists/$local_part}\
32692              {lsearch;/usr/lists/$local_part}{*}}
32693   file = /usr/lists/$local_part
32694   forbid_pipe
32695   forbid_file
32696   errors_to = $local_part-request@lists.example
32697   no_more
32698
32699 lists_closed:
32700   driver = redirect
32701   domains = lists.example
32702   allow_fail
32703   data = :fail: $local_part@lists.example is a closed mailing list
32704 .endd
32705 All three routers have the same &%domains%& setting, so for any other domains,
32706 they are all skipped. The first router runs only if the local part ends in
32707 &%-request%&. It handles messages to the list manager(s) by means of an open
32708 mailing list.
32709
32710 The second router runs only if the &%senders%& precondition is satisfied. It
32711 checks for the existence of a list that corresponds to the local part, and then
32712 checks that the sender is on the list by means of a linear search. It is
32713 necessary to check for the existence of the file before trying to search it,
32714 because otherwise Exim thinks there is a configuration error. If the file does
32715 not exist, the expansion of &%senders%& is *, which matches all senders. This
32716 means that the router runs, but because there is no list, declines, and
32717 &%no_more%& ensures that no further routers are run. The address fails with an
32718 &"unrouteable address"& error.
32719
32720 The third router runs only if the second router is skipped, which happens when
32721 a mailing list exists, but the sender is not on it. This router forcibly fails
32722 the address, giving a suitable error message.
32723
32724
32725
32726
32727 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
32728 .cindex "VERP"
32729 .cindex "Variable Envelope Return Paths"
32730 .cindex "envelope sender"
32731 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
32732 are a way of helping mailing list administrators discover which subscription
32733 address is the cause of a particular delivery failure. The idea is to encode
32734 the original recipient address in the outgoing envelope sender address, so that
32735 if the message is forwarded by another host and then subsequently bounces, the
32736 original recipient can be extracted from the recipient address of the bounce.
32737
32738 .oindex &%errors_to%&
32739 .oindex &%return_path%&
32740 Envelope sender addresses can be modified by Exim using two different
32741 facilities: the &%errors_to%& option on a router (as shown in previous mailing
32742 list examples), or the &%return_path%& option on a transport. The second of
32743 these is effective only if the message is successfully delivered to another
32744 host; it is not used for errors detected on the local host (see the description
32745 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
32746 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
32747 .code
32748 verp_smtp:
32749   driver = smtp
32750   max_rcpt = 1
32751   return_path = \
32752     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32753       {$1-request+$local_part=$domain@your.dom.example}fail}
32754 .endd
32755 This has the effect of rewriting the return path (envelope sender) on outgoing
32756 SMTP messages, if the local part of the original return path ends in
32757 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
32758 local part and domain of the recipient into the return path. Suppose, for
32759 example, that a message whose return path has been set to
32760 &'somelist-request@your.dom.example'& is sent to
32761 &'subscriber@other.dom.example'&. In the transport, the return path is
32762 rewritten as
32763 .code
32764 somelist-request+subscriber=other.dom.example@your.dom.example
32765 .endd
32766 .vindex "&$local_part$&"
32767 For this to work, you must tell Exim to send multiple copies of messages that
32768 have more than one recipient, so that each copy has just one recipient. This is
32769 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
32770 might be sent to several different recipients in the same domain, in which case
32771 &$local_part$& is not available in the transport, because it is not unique.
32772
32773 Unless your host is doing nothing but mailing list deliveries, you should
32774 probably use a separate transport for the VERP deliveries, so as not to use
32775 extra resources in making one-per-recipient copies for other deliveries. This
32776 can easily be done by expanding the &%transport%& option in the router:
32777 .code
32778 dnslookup:
32779   driver = dnslookup
32780   domains = ! +local_domains
32781   transport = \
32782     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32783       {verp_smtp}{remote_smtp}}
32784   no_more
32785 .endd
32786 If you want to change the return path using &%errors_to%& in a router instead
32787 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
32788 routers that handle mailing list addresses. This will ensure that all delivery
32789 errors, including those detected on the local host, are sent to the VERP
32790 address.
32791
32792 On a host that does no local deliveries and has no manual routing, only the
32793 &(dnslookup)& router needs to be changed. A special transport is not needed for
32794 SMTP deliveries. Every mailing list recipient has its own return path value,
32795 and so Exim must hand them to the transport one at a time. Here is an example
32796 of a &(dnslookup)& router that implements VERP:
32797 .code
32798 verp_dnslookup:
32799   driver = dnslookup
32800   domains = ! +local_domains
32801   transport = remote_smtp
32802   errors_to = \
32803     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
32804      {$1-request+$local_part=$domain@your.dom.example}fail}
32805   no_more
32806 .endd
32807 Before you start sending out messages with VERPed return paths, you must also
32808 configure Exim to accept the bounce messages that come back to those paths.
32809 Typically this is done by setting a &%local_part_suffix%& option for a
32810 router, and using this to route the messages to wherever you want to handle
32811 them.
32812
32813 The overhead incurred in using VERP depends very much on the size of the
32814 message, the number of recipient addresses that resolve to the same remote
32815 host, and the speed of the connection over which the message is being sent. If
32816 a lot of addresses resolve to the same host and the connection is slow, sending
32817 a separate copy of the message for each address may take substantially longer
32818 than sending a single copy with many recipients (for which VERP cannot be
32819 used).
32820
32821
32822
32823
32824
32825
32826 .section "Virtual domains" "SECTvirtualdomains"
32827 .cindex "virtual domains"
32828 .cindex "domain" "virtual"
32829 The phrase &'virtual domain'& is unfortunately used with two rather different
32830 meanings:
32831
32832 .ilist
32833 A domain for which there are no real mailboxes; all valid local parts are
32834 aliases for other email addresses. Common examples are organizational
32835 top-level domains and &"vanity"& domains.
32836 .next
32837 One of a number of independent domains that are all handled by the same host,
32838 with mailboxes on that host, but where the mailbox owners do not necessarily
32839 have login accounts on that host.
32840 .endlist
32841
32842 The first usage is probably more common, and does seem more &"virtual"& than
32843 the second. This kind of domain can be handled in Exim with a straightforward
32844 aliasing router. One approach is to create a separate alias file for each
32845 virtual domain. Exim can test for the existence of the alias file to determine
32846 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
32847 to a router of this form:
32848 .code
32849 virtual:
32850   driver = redirect
32851   domains = dsearch;/etc/mail/virtual
32852   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
32853   no_more
32854 .endd
32855 The &%domains%& option specifies that the router is to be skipped, unless there
32856 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
32857 domain that is being processed. When the router runs, it looks up the local
32858 part in the file to find a new address (or list of addresses). The &%no_more%&
32859 setting ensures that if the lookup fails (leading to &%data%& being an empty
32860 string), Exim gives up on the address without trying any subsequent routers.
32861
32862 This one router can handle all the virtual domains because the alias file names
32863 follow a fixed pattern. Permissions can be arranged so that appropriate people
32864 can edit the different alias files. A successful aliasing operation results in
32865 a new envelope recipient address, which is then routed from scratch.
32866
32867 The other kind of &"virtual"& domain can also be handled in a straightforward
32868 way. One approach is to create a file for each domain containing a list of
32869 valid local parts, and use it in a router like this:
32870 .code
32871 my_domains:
32872   driver = accept
32873   domains = dsearch;/etc/mail/domains
32874   local_parts = lsearch;/etc/mail/domains/$domain
32875   transport = my_mailboxes
32876 .endd
32877 The address is accepted if there is a file for the domain, and the local part
32878 can be found in the file. The &%domains%& option is used to check for the
32879 file's existence because &%domains%& is tested before the &%local_parts%&
32880 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
32881 because that option is tested after &%local_parts%&. The transport is as
32882 follows:
32883 .code
32884 my_mailboxes:
32885   driver = appendfile
32886   file = /var/mail/$domain/$local_part
32887   user = mail
32888 .endd
32889 This uses a directory of mailboxes for each domain. The &%user%& setting is
32890 required, to specify which uid is to be used for writing to the mailboxes.
32891
32892 The configuration shown here is just one example of how you might support this
32893 requirement. There are many other ways this kind of configuration can be set
32894 up, for example, by using a database instead of separate files to hold all the
32895 information about the domains.
32896
32897
32898
32899 .section "Multiple user mailboxes" "SECTmulbox"
32900 .cindex "multiple mailboxes"
32901 .cindex "mailbox" "multiple"
32902 .cindex "local part" "prefix"
32903 .cindex "local part" "suffix"
32904 Heavy email users often want to operate with multiple mailboxes, into which
32905 incoming mail is automatically sorted. A popular way of handling this is to
32906 allow users to use multiple sender addresses, so that replies can easily be
32907 identified. Users are permitted to add prefixes or suffixes to their local
32908 parts for this purpose. The wildcard facility of the generic router options
32909 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
32910 example, consider this router:
32911 .code
32912 userforward:
32913   driver = redirect
32914   check_local_user
32915   file = $home/.forward
32916   local_part_suffix = -*
32917   local_part_suffix_optional
32918   allow_filter
32919 .endd
32920 .vindex "&$local_part_suffix$&"
32921 It runs a user's &_.forward_& file for all local parts of the form
32922 &'username-*'&. Within the filter file the user can distinguish different
32923 cases by testing the variable &$local_part_suffix$&. For example:
32924 .code
32925 if $local_part_suffix contains -special then
32926 save /home/$local_part/Mail/special
32927 endif
32928 .endd
32929 If the filter file does not exist, or does not deal with such addresses, they
32930 fall through to subsequent routers, and, assuming no subsequent use of the
32931 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
32932 control over which suffixes are valid.
32933
32934 Alternatively, a suffix can be used to trigger the use of a different
32935 &_.forward_& file &-- which is the way a similar facility is implemented in
32936 another MTA:
32937 .code
32938 userforward:
32939   driver = redirect
32940   check_local_user
32941   file = $home/.forward$local_part_suffix
32942   local_part_suffix = -*
32943   local_part_suffix_optional
32944   allow_filter
32945 .endd
32946 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
32947 example, &_.forward-special_& is used. Once again, if the appropriate file
32948 does not exist, or does not deal with the address, it is passed on to
32949 subsequent routers, which could, if required, look for an unqualified
32950 &_.forward_& file to use as a default.
32951
32952
32953
32954 .section "Simplified vacation processing" "SECID244"
32955 .cindex "vacation processing"
32956 The traditional way of running the &'vacation'& program is for a user to set up
32957 a pipe command in a &_.forward_& file
32958 (see section &<<SECTspecitredli>>& for syntax details).
32959 This is prone to error by inexperienced users. There are two features of Exim
32960 that can be used to make this process simpler for users:
32961
32962 .ilist
32963 A local part prefix such as &"vacation-"& can be specified on a router which
32964 can cause the message to be delivered directly to the &'vacation'& program, or
32965 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
32966 &_.forward_& file are then much simpler. For example:
32967 .code
32968 spqr, vacation-spqr
32969 .endd
32970 .next
32971 The &%require_files%& generic router option can be used to trigger a
32972 vacation delivery by checking for the existence of a certain file in the
32973 user's home directory. The &%unseen%& generic option should also be used, to
32974 ensure that the original delivery also proceeds. In this case, all the user has
32975 to do is to create a file called, say, &_.vacation_&, containing a vacation
32976 message.
32977 .endlist
32978
32979 Another advantage of both these methods is that they both work even when the
32980 use of arbitrary pipes by users is locked out.
32981
32982
32983
32984 .section "Taking copies of mail" "SECID245"
32985 .cindex "message" "copying every"
32986 Some installations have policies that require archive copies of all messages to
32987 be made. A single copy of each message can easily be taken by an appropriate
32988 command in a system filter, which could, for example, use a different file for
32989 each day's messages.
32990
32991 There is also a shadow transport mechanism that can be used to take copies of
32992 messages that are successfully delivered by local transports, one copy per
32993 delivery. This could be used, &'inter alia'&, to implement automatic
32994 notification of delivery by sites that insist on doing such things.
32995
32996
32997
32998 .section "Intermittently connected hosts" "SECID246"
32999 .cindex "intermittently connected hosts"
33000 It has become quite common (because it is cheaper) for hosts to connect to the
33001 Internet periodically rather than remain connected all the time. The normal
33002 arrangement is that mail for such hosts accumulates on a system that is
33003 permanently connected.
33004
33005 Exim was designed for use on permanently connected hosts, and so it is not
33006 particularly well-suited to use in an intermittently connected environment.
33007 Nevertheless there are some features that can be used.
33008
33009
33010 .section "Exim on the upstream server host" "SECID247"
33011 It is tempting to arrange for incoming mail for the intermittently connected
33012 host to remain on Exim's queue until the client connects. However, this
33013 approach does not scale very well. Two different kinds of waiting message are
33014 being mixed up in the same queue &-- those that cannot be delivered because of
33015 some temporary problem, and those that are waiting for their destination host
33016 to connect. This makes it hard to manage the queue, as well as wasting
33017 resources, because each queue runner scans the entire queue.
33018
33019 A better approach is to separate off those messages that are waiting for an
33020 intermittently connected host. This can be done by delivering these messages
33021 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
33022 format, from where they are transmitted by other software when their
33023 destination connects. This makes it easy to collect all the mail for one host
33024 in a single directory, and to apply local timeout rules on a per-message basis
33025 if required.
33026
33027 On a very small scale, leaving the mail on Exim's queue can be made to work. If
33028 you are doing this, you should configure Exim with a long retry period for the
33029 intermittent host. For example:
33030 .code
33031 cheshire.wonderland.fict.example    *   F,5d,24h
33032 .endd
33033 This stops a lot of failed delivery attempts from occurring, but Exim remembers
33034 which messages it has queued up for that host. Once the intermittent host comes
33035 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
33036 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
33037 causes all the queued up messages to be delivered, often down a single SMTP
33038 connection. While the host remains connected, any new messages get delivered
33039 immediately.
33040
33041 If the connecting hosts do not have fixed IP addresses, that is, if a host is
33042 issued with a different IP address each time it connects, Exim's retry
33043 mechanisms on the holding host get confused, because the IP address is normally
33044 used as part of the key string for holding retry information. This can be
33045 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
33046 Since this has disadvantages for permanently connected hosts, it is best to
33047 arrange a separate transport for the intermittently connected ones.
33048
33049
33050
33051 .section "Exim on the intermittently connected client host" "SECID248"
33052 The value of &%smtp_accept_queue_per_connection%& should probably be
33053 increased, or even set to zero (that is, disabled) on the intermittently
33054 connected host, so that all incoming messages down a single connection get
33055 delivered immediately.
33056
33057 .cindex "SMTP" "passed connection"
33058 .cindex "SMTP" "multiple deliveries"
33059 .cindex "multiple SMTP deliveries"
33060 Mail waiting to be sent from an intermittently connected host will probably
33061 not have been routed, because without a connection DNS lookups are not
33062 possible. This means that if a normal queue run is done at connection time,
33063 each message is likely to be sent in a separate SMTP session. This can be
33064 avoided by starting the queue run with a command line option beginning with
33065 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
33066 first pass, routing is done but no deliveries take place. The second pass is a
33067 normal queue run; since all the messages have been previously routed, those
33068 destined for the same host are likely to get sent as multiple deliveries in a
33069 single SMTP connection.
33070
33071
33072
33073 . ////////////////////////////////////////////////////////////////////////////
33074 . ////////////////////////////////////////////////////////////////////////////
33075
33076 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
33077          "Exim as a non-queueing client"
33078 .cindex "client, non-queueing"
33079 .cindex "smart host" "suppressing queueing"
33080 On a personal computer, it is a common requirement for all
33081 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
33082 configured to operate that way, for all the popular operating systems.
33083 However, there are some MUAs for Unix-like systems that cannot be so
33084 configured: they submit messages using the command line interface of
33085 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
33086 messages this way.
33087
33088 If the personal computer runs continuously, there is no problem, because it can
33089 run a conventional MTA that handles delivery to the smart host, and deal with
33090 any delays via its queueing mechanism. However, if the computer does not run
33091 continuously or runs different operating systems at different times, queueing
33092 email is not desirable.
33093
33094 There is therefore a requirement for something that can provide the
33095 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
33096 any queueing or retrying facilities. Furthermore, the delivery to the smart
33097 host should be synchronous, so that if it fails, the sending MUA is immediately
33098 informed. In other words, we want something that extends an MUA that submits
33099 to a local MTA via the command line so that it behaves like one that submits
33100 to a remote smart host using TCP/SMTP.
33101
33102 There are a number of applications (for example, there is one called &'ssmtp'&)
33103 that do this job. However, people have found them to be lacking in various
33104 ways. For instance, you might want to allow aliasing and forwarding to be done
33105 before sending a message to the smart host.
33106
33107 Exim already had the necessary infrastructure for doing this job. Just a few
33108 tweaks were needed to make it behave as required, though it is somewhat of an
33109 overkill to use a fully-featured MTA for this purpose.
33110
33111 .oindex "&%mua_wrapper%&"
33112 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
33113 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
33114 assumes that it is being used to &"wrap"& a command-line MUA in the manner
33115 just described. As well as setting &%mua_wrapper%&, you also need to provide a
33116 compatible router and transport configuration. Typically there will be just one
33117 router and one transport, sending everything to a smart host.
33118
33119 When run in MUA wrapping mode, the behaviour of Exim changes in the
33120 following ways:
33121
33122 .ilist
33123 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
33124 In other words, the only way to submit messages is via the command line.
33125 .next
33126 Each message is synchronously delivered as soon as it is received (&%-odi%& is
33127 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
33128 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
33129 does not finish until the delivery attempt is complete. If the delivery is
33130 successful, a zero return code is given.
33131 .next
33132 Address redirection is permitted, but the final routing for all addresses must
33133 be to the same remote transport, and to the same list of hosts. Furthermore,
33134 the return address (envelope sender) must be the same for all recipients, as
33135 must any added or deleted header lines. In other words, it must be possible to
33136 deliver the message in a single SMTP transaction, however many recipients there
33137 are.
33138 .next
33139 If these conditions are not met, or if routing any address results in a
33140 failure or defer status, or if Exim is unable to deliver all the recipients
33141 successfully to one of the smart hosts, delivery of the entire message fails.
33142 .next
33143 Because no queueing is allowed, all failures are treated as permanent; there
33144 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
33145 smart host. Furthermore, because only a single yes/no response can be given to
33146 the caller, it is not possible to deliver to some recipients and not others. If
33147 there is an error (temporary or permanent) for any recipient, all are failed.
33148 .next
33149 If more than one smart host is listed, Exim will try another host after a
33150 connection failure or a timeout, in the normal way. However, if this kind of
33151 failure happens for all the hosts, the delivery fails.
33152 .next
33153 When delivery fails, an error message is written to the standard error stream
33154 (as well as to Exim's log), and Exim exits to the caller with a return code
33155 value 1. The message is expunged from Exim's spool files. No bounce messages
33156 are ever generated.
33157 .next
33158 No retry data is maintained, and any retry rules are ignored.
33159 .next
33160 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
33161 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
33162 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
33163 .endlist
33164
33165 The overall effect is that Exim makes a single synchronous attempt to deliver
33166 the message, failing if there is any kind of problem. Because no local
33167 deliveries are done and no daemon can be run, Exim does not need root
33168 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
33169 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
33170 the advantages and disadvantages of running without root privilege.
33171
33172
33173
33174
33175 . ////////////////////////////////////////////////////////////////////////////
33176 . ////////////////////////////////////////////////////////////////////////////
33177
33178 .chapter "Log files" "CHAPlog"
33179 .scindex IIDloggen "log" "general description"
33180 .cindex "log" "types of"
33181 Exim writes three different logs, referred to as the main log, the reject log,
33182 and the panic log:
33183
33184 .ilist
33185 .cindex "main log"
33186 The main log records the arrival of each message and each delivery in a single
33187 line in each case. The format is as compact as possible, in an attempt to keep
33188 down the size of log files. Two-character flag sequences make it easy to pick
33189 out these lines. A number of other events are recorded in the main log. Some of
33190 them are optional, in which case the &%log_selector%& option controls whether
33191 they are included or not. A Perl script called &'eximstats'&, which does simple
33192 analysis of main log files, is provided in the Exim distribution (see section
33193 &<<SECTmailstat>>&).
33194 .next
33195 .cindex "reject log"
33196 The reject log records information from messages that are rejected as a result
33197 of a configuration option (that is, for policy reasons).
33198 The first line of each rejection is a copy of the line that is also written to
33199 the main log. Then, if the message's header has been read at the time the log
33200 is written, its contents are written to this log. Only the original header
33201 lines are available; header lines added by ACLs are not logged. You can use the
33202 reject log to check that your policy controls are working correctly; on a busy
33203 host this may be easier than scanning the main log for rejection messages. You
33204 can suppress the writing of the reject log by setting &%write_rejectlog%&
33205 false.
33206 .next
33207 .cindex "panic log"
33208 .cindex "system log"
33209 When certain serious errors occur, Exim writes entries to its panic log. If the
33210 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
33211 are usually written to the main log as well, but can get lost amid the mass of
33212 other entries. The panic log should be empty under normal circumstances. It is
33213 therefore a good idea to check it (or to have a &'cron'& script check it)
33214 regularly, in order to become aware of any problems. When Exim cannot open its
33215 panic log, it tries as a last resort to write to the system log (syslog). This
33216 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
33217 message itself is written at priority LOG_CRIT.
33218 .endlist
33219
33220 Every log line starts with a timestamp, in the format shown in the following
33221 example. Note that many of the examples shown in this chapter are line-wrapped.
33222 In the log file, this would be all on one line:
33223 .code
33224 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
33225   by QUIT
33226 .endd
33227 By default, the timestamps are in the local timezone. There are two
33228 ways of changing this:
33229
33230 .ilist
33231 You can set the &%timezone%& option to a different time zone; in particular, if
33232 you set
33233 .code
33234 timezone = UTC
33235 .endd
33236 the timestamps will be in UTC (aka GMT).
33237 .next
33238 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
33239 example:
33240 .code
33241 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
33242 .endd
33243 .endlist
33244
33245 .cindex "log" "process ids in"
33246 .cindex "pid (process id)" "in log lines"
33247 Exim does not include its process id in log lines by default, but you can
33248 request that it does so by specifying the &`pid`& log selector (see section
33249 &<<SECTlogselector>>&). When this is set, the process id is output, in square
33250 brackets, immediately after the time and date.
33251
33252
33253
33254
33255 .section "Where the logs are written" "SECTwhelogwri"
33256 .cindex "log" "destination"
33257 .cindex "log" "to file"
33258 .cindex "log" "to syslog"
33259 .cindex "syslog"
33260 The logs may be written to local files, or to syslog, or both. However, it
33261 should be noted that many syslog implementations use UDP as a transport, and
33262 are therefore unreliable in the sense that messages are not guaranteed to
33263 arrive at the loghost, nor is the ordering of messages necessarily maintained.
33264 It has also been reported that on large log files (tens of megabytes) you may
33265 need to tweak syslog to prevent it syncing the file with each write &-- on
33266 Linux this has been seen to make syslog take 90% plus of CPU time.
33267
33268 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
33269 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
33270 configuration. This latter string is expanded, so it can contain, for example,
33271 references to the host name:
33272 .code
33273 log_file_path = /var/log/$primary_hostname/exim_%slog
33274 .endd
33275 It is generally advisable, however, to set the string in &_Local/Makefile_&
33276 rather than at run time, because then the setting is available right from the
33277 start of Exim's execution. Otherwise, if there's something it wants to log
33278 before it has read the configuration file (for example, an error in the
33279 configuration file) it will not use the path you want, and may not be able to
33280 log at all.
33281
33282 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
33283 list, currently limited to at most two items. This is one option where the
33284 facility for changing a list separator may not be used. The list must always be
33285 colon-separated. If an item in the list is &"syslog"& then syslog is used;
33286 otherwise the item must either be an absolute path, containing &`%s`& at the
33287 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
33288 implying the use of a default path.
33289
33290 When Exim encounters an empty item in the list, it searches the list defined by
33291 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
33292 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
33293 mean &"use the path specified at build time"&. It no such item exists, log
33294 files are written in the &_log_& subdirectory of the spool directory. This is
33295 equivalent to the setting:
33296 .code
33297 log_file_path = $spool_directory/log/%slog
33298 .endd
33299 If you do not specify anything at build time or run time, that is where the
33300 logs are written.
33301
33302 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
33303 are in use &-- see section &<<SECTdatlogfil>>& below.
33304
33305 Here are some examples of possible settings:
33306 .display
33307 &`LOG_FILE_PATH=syslog                    `& syslog only
33308 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
33309 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
33310 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
33311 .endd
33312 If there are more than two paths in the list, the first is used and a panic
33313 error is logged.
33314
33315
33316
33317 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
33318 .cindex "log" "cycling local files"
33319 .cindex "cycling logs"
33320 .cindex "&'exicyclog'&"
33321 .cindex "log" "local files; writing to"
33322 Some operating systems provide centralized and standardized methods for cycling
33323 log files. For those that do not, a utility script called &'exicyclog'& is
33324 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
33325 main and reject logs each time it is called. The maximum number of old logs to
33326 keep can be set. It is suggested this script is run as a daily &'cron'& job.
33327
33328 An Exim delivery process opens the main log when it first needs to write to it,
33329 and it keeps the file open in case subsequent entries are required &-- for
33330 example, if a number of different deliveries are being done for the same
33331 message. However, remote SMTP deliveries can take a long time, and this means
33332 that the file may be kept open long after it is renamed if &'exicyclog'& or
33333 something similar is being used to rename log files on a regular basis. To
33334 ensure that a switch of log files is noticed as soon as possible, Exim calls
33335 &[stat()]& on the main log's name before reusing an open file, and if the file
33336 does not exist, or its inode has changed, the old file is closed and Exim
33337 tries to open the main log from scratch. Thus, an old log file may remain open
33338 for quite some time, but no Exim processes should write to it once it has been
33339 renamed.
33340
33341
33342
33343 .section "Datestamped log files" "SECTdatlogfil"
33344 .cindex "log" "datestamped files"
33345 Instead of cycling the main and reject log files by renaming them
33346 periodically, some sites like to use files whose names contain a datestamp,
33347 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
33348 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
33349 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
33350 point where the datestamp is required. For example:
33351 .code
33352 log_file_path = /var/spool/exim/log/%slog-%D
33353 log_file_path = /var/log/exim-%s-%D.log
33354 log_file_path = /var/spool/exim/log/%D-%slog
33355 log_file_path = /var/log/exim/%s.%M
33356 .endd
33357 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
33358 examples of names generated by the above examples:
33359 .code
33360 /var/spool/exim/log/mainlog-20021225
33361 /var/log/exim-reject-20021225.log
33362 /var/spool/exim/log/20021225-mainlog
33363 /var/log/exim/main.200212
33364 .endd
33365 When this form of log file is specified, Exim automatically switches to new
33366 files at midnight. It does not make any attempt to compress old logs; you
33367 will need to write your own script if you require this. You should not
33368 run &'exicyclog'& with this form of logging.
33369
33370 The location of the panic log is also determined by &%log_file_path%&, but it
33371 is not datestamped, because rotation of the panic log does not make sense.
33372 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
33373 the string. In addition, if it immediately follows a slash, a following
33374 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
33375 character is removed. Thus, the four examples above would give these panic
33376 log names:
33377 .code
33378 /var/spool/exim/log/paniclog
33379 /var/log/exim-panic.log
33380 /var/spool/exim/log/paniclog
33381 /var/log/exim/panic
33382 .endd
33383
33384
33385 .section "Logging to syslog" "SECID249"
33386 .cindex "log" "syslog; writing to"
33387 The use of syslog does not change what Exim logs or the format of its messages,
33388 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
33389 Exim's log lines are omitted when these lines are sent to syslog. Apart from
33390 that, the same strings are written to syslog as to log files. The syslog
33391 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
33392 by default, but you can change these by setting the &%syslog_facility%& and
33393 &%syslog_processname%& options, respectively. If Exim was compiled with
33394 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
33395 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
33396 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
33397 the time and host name to each line.
33398 The three log streams are mapped onto syslog priorities as follows:
33399
33400 .ilist
33401 &'mainlog'& is mapped to LOG_INFO
33402 .next
33403 &'rejectlog'& is mapped to LOG_NOTICE
33404 .next
33405 &'paniclog'& is mapped to LOG_ALERT
33406 .endlist
33407
33408 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
33409 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
33410 these are routed by syslog to the same place. You can suppress this duplication
33411 by setting &%syslog_duplication%& false.
33412
33413 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
33414 entries contain multiple lines when headers are included. To cope with both
33415 these cases, entries written to syslog are split into separate &[syslog()]&
33416 calls at each internal newline, and also after a maximum of
33417 870 data characters. (This allows for a total syslog line length of 1024, when
33418 additions such as timestamps are added.) If you are running a syslog
33419 replacement that can handle lines longer than the 1024 characters allowed by
33420 RFC 3164, you should set
33421 .code
33422 SYSLOG_LONG_LINES=yes
33423 .endd
33424 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
33425 lines, but it still splits at internal newlines in &'reject'& log entries.
33426
33427 To make it easy to re-assemble split lines later, each component of a split
33428 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
33429 where <&'n'&> is the component number and <&'m'&> is the total number of
33430 components in the entry. The / delimiter is used when the line was split
33431 because it was too long; if it was split because of an internal newline, the \
33432 delimiter is used. For example, supposing the length limit to be 50 instead of
33433 870, the following would be the result of a typical rejection message to
33434 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
33435 name, and pid as added by syslog:
33436 .code
33437 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
33438 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
33439 [3/5]  when scanning for sender: missing or malformed lo
33440 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
33441 [5/5] mple>)
33442 .endd
33443 The same error might cause the following lines to be written to &"rejectlog"&
33444 (LOG_NOTICE):
33445 .code
33446 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
33447 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
33448 [3/18] er when scanning for sender: missing or malformed
33449 [4/18]  local part in "<>" (envelope sender is <ph10@cam
33450 [5\18] .example>)
33451 [6\18] Recipients: ph10@some.domain.cam.example
33452 [7\18] P Received: from [127.0.0.1] (ident=ph10)
33453 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
33454 [9\18]        id 16RdAL-0006pc-00
33455 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
33456 [11\18] 09:43 +0100
33457 [12\18] F From: <>
33458 [13\18]   Subject: this is a test header
33459 [18\18]   X-something: this is another header
33460 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
33461 [16\18] le>
33462 [17\18] B Bcc:
33463 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
33464 .endd
33465 Log lines that are neither too long nor contain newlines are written to syslog
33466 without modification.
33467
33468 If only syslog is being used, the Exim monitor is unable to provide a log tail
33469 display, unless syslog is routing &'mainlog'& to a file on the local host and
33470 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
33471 where it is.
33472
33473
33474
33475 .section "Log line flags" "SECID250"
33476 One line is written to the main log for each message received, and for each
33477 successful, unsuccessful, and delayed delivery. These lines can readily be
33478 picked out by the distinctive two-character flags that immediately follow the
33479 timestamp. The flags are:
33480 .display
33481 &`<=`&     message arrival
33482 &`=>`&     normal message delivery
33483 &`->`&     additional address in same delivery
33484 &`*>`&     delivery suppressed by &%-N%&
33485 &`**`&     delivery failed; address bounced
33486 &`==`&     delivery deferred; temporary problem
33487 .endd
33488
33489
33490 .section "Logging message reception" "SECID251"
33491 .cindex "log" "reception line"
33492 The format of the single-line entry in the main log that is written for every
33493 message received is shown in the basic example below, which is split over
33494 several lines in order to fit it on the page:
33495 .code
33496 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
33497   H=mailer.fict.example [192.168.123.123] U=exim
33498   P=smtp S=5678 id=<incoming message id>
33499 .endd
33500 The address immediately following &"<="& is the envelope sender address. A
33501 bounce message is shown with the sender address &"<>"&, and if it is locally
33502 generated, this is followed by an item of the form
33503 .code
33504 R=<message id>
33505 .endd
33506 which is a reference to the message that caused the bounce to be sent.
33507
33508 .cindex "HELO"
33509 .cindex "EHLO"
33510 For messages from other hosts, the H and U fields identify the remote host and
33511 record the RFC 1413 identity of the user that sent the message, if one was
33512 received. The number given in square brackets is the IP address of the sending
33513 host. If there is a single, unparenthesized  host name in the H field, as
33514 above, it has been verified to correspond to the IP address (see the
33515 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
33516 by the remote host in the SMTP HELO or EHLO command, and has not been
33517 verified. If verification yields a different name to that given for HELO or
33518 EHLO, the verified name appears first, followed by the HELO or EHLO
33519 name in parentheses.
33520
33521 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
33522 without brackets, in the HELO or EHLO command, leading to entries in
33523 the log containing text like these examples:
33524 .code
33525 H=(10.21.32.43) [192.168.8.34]
33526 H=([10.21.32.43]) [192.168.8.34]
33527 .endd
33528 This can be confusing. Only the final address in square brackets can be relied
33529 on.
33530
33531 For locally generated messages (that is, messages not received over TCP/IP),
33532 the H field is omitted, and the U field contains the login name of the caller
33533 of Exim.
33534
33535 .cindex "authentication" "logging"
33536 .cindex "AUTH" "logging"
33537 For all messages, the P field specifies the protocol used to receive the
33538 message. This is the value that is stored in &$received_protocol$&. In the case
33539 of incoming SMTP messages, the value indicates whether or not any SMTP
33540 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33541 session was encrypted, there is an additional X field that records the cipher
33542 suite that was used.
33543
33544 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33545 hosts that have authenticated themselves using the SMTP AUTH command. The first
33546 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33547 there is an additional item A= followed by the name of the authenticator that
33548 was used. If an authenticated identification was set up by the authenticator's
33549 &%server_set_id%& option, this is logged too, separated by a colon from the
33550 authenticator name.
33551
33552 .cindex "size" "of message"
33553 The id field records the existing message id, if present. The size of the
33554 received message is given by the S field. When the message is delivered,
33555 headers may be removed or added, so that the size of delivered copies of the
33556 message may not correspond with this value (and indeed may be different to each
33557 other).
33558
33559 The &%log_selector%& option can be used to request the logging of additional
33560 data when a message is received. See section &<<SECTlogselector>>& below.
33561
33562
33563
33564 .section "Logging deliveries" "SECID252"
33565 .cindex "log" "delivery line"
33566 The format of the single-line entry in the main log that is written for every
33567 delivery is shown in one of the examples below, for local and remote
33568 deliveries, respectively. Each example has been split into two lines in order
33569 to fit it on the page:
33570 .code
33571 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33572   <marv@hitch.fict.example> R=localuser T=local_delivery
33573 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33574   monk@holistic.fict.example R=dnslookup T=remote_smtp
33575   H=holistic.fict.example [192.168.234.234]
33576 .endd
33577 For ordinary local deliveries, the original address is given in angle brackets
33578 after the final delivery address, which might be a pipe or a file. If
33579 intermediate address(es) exist between the original and the final address, the
33580 last of these is given in parentheses after the final address. The R and T
33581 fields record the router and transport that were used to process the address.
33582
33583 If a shadow transport was run after a successful local delivery, the log line
33584 for the successful delivery has an item added on the end, of the form
33585 .display
33586 &`ST=<`&&'shadow transport name'&&`>`&
33587 .endd
33588 If the shadow transport did not succeed, the error message is put in
33589 parentheses afterwards.
33590
33591 .cindex "asterisk" "after IP address"
33592 When more than one address is included in a single delivery (for example, two
33593 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33594 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33595 down a single SMTP connection, an asterisk follows the IP address in the log
33596 lines for the second and subsequent messages.
33597
33598 The generation of a reply message by a filter file gets logged as a
33599 &"delivery"& to the addressee, preceded by &">"&.
33600
33601 The &%log_selector%& option can be used to request the logging of additional
33602 data when a message is delivered. See section &<<SECTlogselector>>& below.
33603
33604
33605 .section "Discarded deliveries" "SECID253"
33606 .cindex "discarded messages"
33607 .cindex "message" "discarded"
33608 .cindex "delivery" "discarded; logging"
33609 When a message is discarded as a result of the command &"seen finish"& being
33610 obeyed in a filter file which generates no deliveries, a log entry of the form
33611 .code
33612 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33613   <low.club@bridge.example> R=userforward
33614 .endd
33615 is written, to record why no deliveries are logged. When a message is discarded
33616 because it is aliased to &":blackhole:"& the log line is like this:
33617 .code
33618 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
33619   <hole@nowhere.example> R=blackhole_router
33620 .endd
33621
33622
33623 .section "Deferred deliveries" "SECID254"
33624 When a delivery is deferred, a line of the following form is logged:
33625 .code
33626 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
33627   R=dnslookup T=smtp defer (146): Connection refused
33628 .endd
33629 In the case of remote deliveries, the error is the one that was given for the
33630 last IP address that was tried. Details of individual SMTP failures are also
33631 written to the log, so the above line would be preceded by something like
33632 .code
33633 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
33634   mail1.endrest.example [192.168.239.239]: Connection refused
33635 .endd
33636 When a deferred address is skipped because its retry time has not been reached,
33637 a message is written to the log, but this can be suppressed by setting an
33638 appropriate value in &%log_selector%&.
33639
33640
33641
33642 .section "Delivery failures" "SECID255"
33643 .cindex "delivery" "failure; logging"
33644 If a delivery fails because an address cannot be routed, a line of the
33645 following form is logged:
33646 .code
33647 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
33648   <jim@trek99.example>: unknown mail domain
33649 .endd
33650 If a delivery fails at transport time, the router and transport are shown, and
33651 the response from the remote host is included, as in this example:
33652 .code
33653 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
33654   R=dnslookup T=remote_smtp: SMTP error from remote mailer
33655   after pipelined RCPT TO:<ace400@pb.example>: host
33656   pbmail3.py.example [192.168.63.111]: 553 5.3.0
33657   <ace400@pb.example>...Addressee unknown
33658 .endd
33659 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
33660 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
33661 disabling PIPELINING. The log lines for all forms of delivery failure are
33662 flagged with &`**`&.
33663
33664
33665
33666 .section "Fake deliveries" "SECID256"
33667 .cindex "delivery" "fake; logging"
33668 If a delivery does not actually take place because the &%-N%& option has been
33669 used to suppress it, a normal delivery line is written to the log, except that
33670 &"=>"& is replaced by &"*>"&.
33671
33672
33673
33674 .section "Completion" "SECID257"
33675 A line of the form
33676 .code
33677 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
33678 .endd
33679 is written to the main log when a message is about to be removed from the spool
33680 at the end of its processing.
33681
33682
33683
33684
33685 .section "Summary of Fields in Log Lines" "SECID258"
33686 .cindex "log" "summary of fields"
33687 A summary of the field identifiers that are used in log lines is shown in
33688 the following table:
33689 .display
33690 &`A   `&        authenticator name (and optional id)
33691 &`C   `&        SMTP confirmation on delivery
33692 &`    `&        command list for &"no mail in SMTP session"&
33693 &`CV  `&        certificate verification status
33694 &`D   `&        duration of &"no mail in SMTP session"&
33695 &`DN  `&        distinguished name from peer certificate
33696 &`DT  `&        on &`=>`& lines: time taken for a delivery
33697 &`F   `&        sender address (on delivery lines)
33698 &`H   `&        host name and IP address
33699 &`I   `&        local interface used
33700 &`id  `&        message id for incoming message
33701 &`P   `&        on &`<=`& lines: protocol used
33702 &`    `&        on &`=>`& and &`**`& lines: return path
33703 &`QT  `&        on &`=>`& lines: time spent on queue so far
33704 &`    `&        on &"Completed"& lines: time spent on queue
33705 &`R   `&        on &`<=`& lines: reference for local bounce
33706 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
33707 &`S   `&        size of message
33708 &`ST  `&        shadow transport name
33709 &`T   `&        on &`<=`& lines: message subject (topic)
33710 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
33711 &`U   `&        local user or RFC 1413 identity
33712 &`X   `&        TLS cipher suite
33713 .endd
33714
33715
33716 .section "Other log entries" "SECID259"
33717 Various other types of log entry are written from time to time. Most should be
33718 self-explanatory. Among the more common are:
33719
33720 .ilist
33721 .cindex "retry" "time not reached"
33722 &'retry time not reached'&&~&~An address previously suffered a temporary error
33723 during routing or local delivery, and the time to retry has not yet arrived.
33724 This message is not written to an individual message log file unless it happens
33725 during the first delivery attempt.
33726 .next
33727 &'retry time not reached for any host'&&~&~An address previously suffered
33728 temporary errors during remote delivery, and the retry time has not yet arrived
33729 for any of the hosts to which it is routed.
33730 .next
33731 .cindex "spool directory" "file locked"
33732 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
33733 some other Exim process is already working on the message. This can be quite
33734 common if queue running processes are started at frequent intervals. The
33735 &'exiwhat'& utility script can be used to find out what Exim processes are
33736 doing.
33737 .next
33738 .cindex "error" "ignored"
33739 &'error ignored'&&~&~There are several circumstances that give rise to this
33740 message:
33741 .olist
33742 Exim failed to deliver a bounce message whose age was greater than
33743 &%ignore_bounce_errors_after%&. The bounce was discarded.
33744 .next
33745 A filter file set up a delivery using the &"noerror"& option, and the delivery
33746 failed. The delivery was discarded.
33747 .next
33748 A delivery set up by a router configured with
33749 . ==== As this is a nested list, any displays it contains must be indented
33750 . ==== as otherwise they are too far to the left.
33751 .code
33752     errors_to = <>
33753 .endd
33754 failed. The delivery was discarded.
33755 .endlist olist
33756 .endlist ilist
33757
33758
33759
33760
33761
33762 .section "Reducing or increasing what is logged" "SECTlogselector"
33763 .cindex "log" "selectors"
33764 By setting the &%log_selector%& global option, you can disable some of Exim's
33765 default logging, or you can request additional logging. The value of
33766 &%log_selector%& is made up of names preceded by plus or minus characters. For
33767 example:
33768 .code
33769 log_selector = +arguments -retry_defer
33770 .endd
33771 The list of optional log items is in the following table, with the default
33772 selection marked by asterisks:
33773 .display
33774 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
33775 &` address_rewrite            `&  address rewriting
33776 &` all_parents                `&  all parents in => lines
33777 &` arguments                  `&  command line arguments
33778 &`*connection_reject          `&  connection rejections
33779 &`*delay_delivery             `&  immediate delivery delayed
33780 &` deliver_time               `&  time taken to perform delivery
33781 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
33782 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
33783 &`*etrn                       `&  ETRN commands
33784 &`*host_lookup_failed         `&  as it says
33785 &` ident_timeout              `&  timeout for ident connection
33786 &` incoming_interface         `&  incoming interface on <= lines
33787 &` incoming_port              `&  incoming port on <= lines
33788 &`*lost_incoming_connection   `&  as it says (includes timeouts)
33789 &` outgoing_port              `&  add remote port to => lines
33790 &`*queue_run                  `&  start and end queue runs
33791 &` queue_time                 `&  time on queue for one recipient
33792 &` queue_time_overall         `&  time on queue for whole message
33793 &` pid                        `&  Exim process id
33794 &` received_recipients        `&  recipients on <= lines
33795 &` received_sender            `&  sender on <= lines
33796 &`*rejected_header            `&  header contents on reject log
33797 &`*retry_defer                `&  &"retry time not reached"&
33798 &` return_path_on_delivery    `&  put return path on => and ** lines
33799 &` sender_on_delivery         `&  add sender to => lines
33800 &`*sender_verify_fail         `&  sender verification failures
33801 &`*size_reject                `&  rejection because too big
33802 &`*skip_delivery              `&  delivery skipped in a queue run
33803 &`*smtp_confirmation          `&  SMTP confirmation on => lines
33804 &` smtp_connection            `&  SMTP connections
33805 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
33806 &` smtp_no_mail               `&  session with no MAIL commands
33807 &` smtp_protocol_error        `&  SMTP protocol errors
33808 &` smtp_syntax_error          `&  SMTP syntax errors
33809 &` subject                    `&  contents of &'Subject:'& on <= lines
33810 &` tls_certificate_verified   `&  certificate verification status
33811 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
33812 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
33813 &` tls_sni                    `&  TLS SNI on <= lines
33814 &` unknown_in_list            `&  DNS lookup failed in list match
33815
33816 &` all                        `&  all of the above
33817 .endd
33818 More details on each of these items follows:
33819
33820 .ilist
33821 .cindex "&%warn%& ACL verb" "log when skipping"
33822 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
33823 its conditions cannot be evaluated, a log line to this effect is written if
33824 this log selector is set.
33825 .next
33826 .cindex "log" "rewriting"
33827 .cindex "rewriting" "logging"
33828 &%address_rewrite%&: This applies both to global rewrites and per-transport
33829 rewrites, but not to rewrites in filters run as an unprivileged user (because
33830 such users cannot access the log).
33831 .next
33832 .cindex "log" "full parentage"
33833 &%all_parents%&: Normally only the original and final addresses are logged on
33834 delivery lines; with this selector, intermediate parents are given in
33835 parentheses between them.
33836 .next
33837 .cindex "log" "Exim arguments"
33838 .cindex "Exim arguments, logging"
33839 &%arguments%&: This causes Exim to write the arguments with which it was called
33840 to the main log, preceded by the current working directory. This is a debugging
33841 feature, added to make it easier to find out how certain MUAs call
33842 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
33843 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
33844 that are empty or that contain white space are quoted. Non-printing characters
33845 are shown as escape sequences. This facility cannot log unrecognized arguments,
33846 because the arguments are checked before the configuration file is read. The
33847 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
33848 between the caller and Exim.
33849 .next
33850 .cindex "log" "connection rejections"
33851 &%connection_reject%&: A log entry is written whenever an incoming SMTP
33852 connection is rejected, for whatever reason.
33853 .next
33854 .cindex "log" "delayed delivery"
33855 .cindex "delayed delivery, logging"
33856 &%delay_delivery%&: A log entry is written whenever a delivery process is not
33857 started for an incoming message because the load is too high or too many
33858 messages were received on one connection. Logging does not occur if no delivery
33859 process is started because &%queue_only%& is set or &%-odq%& was used.
33860 .next
33861 .cindex "log" "delivery duration"
33862 &%deliver_time%&: For each delivery, the amount of real time it has taken to
33863 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
33864 .next
33865 .cindex "log" "message size on delivery"
33866 .cindex "size" "of message"
33867 &%delivery_size%&: For each delivery, the size of message delivered is added to
33868 the &"=>"& line, tagged with S=.
33869 .next
33870 .cindex "log" "dnslist defer"
33871 .cindex "DNS list" "logging defer"
33872 .cindex "black list (DNS)"
33873 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
33874 DNS black list suffers a temporary error.
33875 .next
33876 .cindex "log" "ETRN commands"
33877 .cindex "ETRN" "logging"
33878 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
33879 is run to determine whether or not it is actually accepted. An invalid ETRN
33880 command, or one received within a message transaction is not logged by this
33881 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
33882 .next
33883 .cindex "log" "host lookup failure"
33884 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
33885 any addresses, or when a lookup of an IP address fails to find a host name, a
33886 log line is written. This logging does not apply to direct DNS lookups when
33887 routing email addresses, but it does apply to &"byname"& lookups.
33888 .next
33889 .cindex "log" "ident timeout"
33890 .cindex "RFC 1413" "logging timeout"
33891 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
33892 client's ident port times out.
33893 .next
33894 .cindex "log" "incoming interface"
33895 .cindex "interface" "logging"
33896 &%incoming_interface%&: The interface on which a message was received is added
33897 to the &"<="& line as an IP address in square brackets, tagged by I= and
33898 followed by a colon and the port number. The local interface and port are also
33899 added to other SMTP log lines, for example &"SMTP connection from"&, and to
33900 rejection lines.
33901 .next
33902 .cindex "log" "incoming remote port"
33903 .cindex "port" "logging remote"
33904 .cindex "TCP/IP" "logging incoming remote port"
33905 .vindex "&$sender_fullhost$&"
33906 .vindex "&$sender_rcvhost$&"
33907 &%incoming_port%&: The remote port number from which a message was received is
33908 added to log entries and &'Received:'& header lines, following the IP address
33909 in square brackets, and separated from it by a colon. This is implemented by
33910 changing the value that is put in the &$sender_fullhost$& and
33911 &$sender_rcvhost$& variables. Recording the remote port number has become more
33912 important with the widening use of NAT (see RFC 2505).
33913 .next
33914 .cindex "log" "dropped connection"
33915 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
33916 connection is unexpectedly dropped.
33917 .next
33918 .cindex "log" "outgoing remote port"
33919 .cindex "port" "logging outgoint remote"
33920 .cindex "TCP/IP" "logging ougtoing remote port"
33921 &%outgoing_port%&: The remote port number is added to delivery log lines (those
33922 containing => tags) following the IP address. This option is not included in
33923 the default setting, because for most ordinary configurations, the remote port
33924 number is always 25 (the SMTP port).
33925 .next
33926 .cindex "log" "process ids in"
33927 .cindex "pid (process id)" "in log lines"
33928 &%pid%&: The current process id is added to every log line, in square brackets,
33929 immediately after the time and date.
33930 .next
33931 .cindex "log" "queue run"
33932 .cindex "queue runner" "logging"
33933 &%queue_run%&: The start and end of every queue run are logged.
33934 .next
33935 .cindex "log" "queue time"
33936 &%queue_time%&: The amount of time the message has been in the queue on the
33937 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
33938 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
33939 includes reception time as well as the delivery time for the current address.
33940 This means that it may be longer than the difference between the arrival and
33941 delivery log line times, because the arrival log line is not written until the
33942 message has been successfully received.
33943 .next
33944 &%queue_time_overall%&: The amount of time the message has been in the queue on
33945 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
33946 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
33947 message, so it includes reception time as well as the total delivery time.
33948 .next
33949 .cindex "log" "recipients"
33950 &%received_recipients%&: The recipients of a message are listed in the main log
33951 as soon as the message is received. The list appears at the end of the log line
33952 that is written when a message is received, preceded by the word &"for"&. The
33953 addresses are listed after they have been qualified, but before any rewriting
33954 has taken place.
33955 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
33956 in the list.
33957 .next
33958 .cindex "log" "sender reception"
33959 &%received_sender%&: The unrewritten original sender of a message is added to
33960 the end of the log line that records the message's arrival, after the word
33961 &"from"& (before the recipients if &%received_recipients%& is also set).
33962 .next
33963 .cindex "log" "header lines for rejection"
33964 &%rejected_header%&: If a message's header has been received at the time a
33965 rejection is written to the reject log, the complete header is added to the
33966 log. Header logging can be turned off individually for messages that are
33967 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
33968 .next
33969 .cindex "log" "retry defer"
33970 &%retry_defer%&: A log line is written if a delivery is deferred because a
33971 retry time has not yet been reached. However, this &"retry time not reached"&
33972 message is always omitted from individual message logs after the first delivery
33973 attempt.
33974 .next
33975 .cindex "log" "return path"
33976 &%return_path_on_delivery%&: The return path that is being transmitted with
33977 the message is included in delivery and bounce lines, using the tag P=.
33978 This is omitted if no delivery actually happens, for example, if routing fails,
33979 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
33980 .next
33981 .cindex "log" "sender on delivery"
33982 &%sender_on_delivery%&: The message's sender address is added to every delivery
33983 and bounce line, tagged by F= (for &"from"&).
33984 This is the original sender that was received with the message; it is not
33985 necessarily the same as the outgoing return path.
33986 .next
33987 .cindex "log" "sender verify failure"
33988 &%sender_verify_fail%&: If this selector is unset, the separate log line that
33989 gives details of a sender verification failure is not written. Log lines for
33990 the rejection of SMTP commands contain just &"sender verify failed"&, so some
33991 detail is lost.
33992 .next
33993 .cindex "log" "size rejection"
33994 &%size_reject%&: A log line is written whenever a message is rejected because
33995 it is too big.
33996 .next
33997 .cindex "log" "frozen messages; skipped"
33998 .cindex "frozen messages" "logging skipping"
33999 &%skip_delivery%&: A log line is written whenever a message is skipped during a
34000 queue run because it is frozen or because another process is already delivering
34001 it.
34002 .cindex "&""spool file is locked""&"
34003 The message that is written is &"spool file is locked"&.
34004 .next
34005 .cindex "log" "smtp confirmation"
34006 .cindex "SMTP" "logging confirmation"
34007 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
34008 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
34009 A number of MTAs (including Exim) return an identifying string in this
34010 response.
34011 .next
34012 .cindex "log" "SMTP connections"
34013 .cindex "SMTP" "logging connections"
34014 &%smtp_connection%&: A log line is written whenever an SMTP connection is
34015 established or closed, unless the connection is from a host that matches
34016 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
34017 only when the closure is unexpected.) This applies to connections from local
34018 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
34019 dropped in the middle of a message, a log line is always written, whether or
34020 not this selector is set, but otherwise nothing is written at the start and end
34021 of connections unless this selector is enabled.
34022
34023 For TCP/IP connections to an Exim daemon, the current number of connections is
34024 included in the log message for each new connection, but note that the count is
34025 reset if the daemon is restarted.
34026 Also, because connections are closed (and the closure is logged) in
34027 subprocesses, the count may not include connections that have been closed but
34028 whose termination the daemon has not yet noticed. Thus, while it is possible to
34029 match up the opening and closing of connections in the log, the value of the
34030 logged counts may not be entirely accurate.
34031 .next
34032 .cindex "log" "SMTP transaction; incomplete"
34033 .cindex "SMTP" "logging incomplete transactions"
34034 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
34035 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
34036 and the message sender plus any accepted recipients are included in the log
34037 line. This can provide evidence of dictionary attacks.
34038 .next
34039 .cindex "log" "non-MAIL SMTP sessions"
34040 .cindex "MAIL" "logging session without"
34041 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
34042 connection terminates without having issued a MAIL command. This includes both
34043 the case when the connection is dropped, and the case when QUIT is used. It
34044 does not include cases where the connection is rejected right at the start (by
34045 an ACL, or because there are too many connections, or whatever). These cases
34046 already have their own log lines.
34047
34048 The log line that is written contains the identity of the client in the usual
34049 way, followed by D= and a time, which records the duration of the connection.
34050 If the connection was authenticated, this fact is logged exactly as it is for
34051 an incoming message, with an A= item. If the connection was encrypted, CV=,
34052 DN=, and X= items may appear as they do for an incoming message, controlled by
34053 the same logging options.
34054
34055 Finally, if any SMTP commands were issued during the connection, a C= item
34056 is added to the line, listing the commands that were used. For example,
34057 .code
34058 C=EHLO,QUIT
34059 .endd
34060 shows that the client issued QUIT straight after EHLO. If there were fewer
34061 than 20 commands, they are all listed. If there were more than 20 commands,
34062 the last 20 are listed, preceded by &"..."&. However, with the default
34063 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
34064 have been aborted before 20 non-mail commands are processed.
34065 .next
34066 .cindex "log" "SMTP protocol error"
34067 .cindex "SMTP" "logging protocol error"
34068 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
34069 encountered. Exim does not have perfect detection of all protocol errors
34070 because of transmission delays and the use of pipelining. If PIPELINING has
34071 been advertised to a client, an Exim server assumes that the client will use
34072 it, and therefore it does not count &"expected"& errors (for example, RCPT
34073 received after rejecting MAIL) as protocol errors.
34074 .next
34075 .cindex "SMTP" "logging syntax errors"
34076 .cindex "SMTP" "syntax errors; logging"
34077 .cindex "SMTP" "unknown command; logging"
34078 .cindex "log" "unknown SMTP command"
34079 .cindex "log" "SMTP syntax error"
34080 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
34081 encountered. An unrecognized command is treated as a syntax error. For an
34082 external connection, the host identity is given; for an internal connection
34083 using &%-bs%& the sender identification (normally the calling user) is given.
34084 .next
34085 .cindex "log" "subject"
34086 .cindex "subject, logging"
34087 &%subject%&: The subject of the message is added to the arrival log line,
34088 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
34089 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
34090 specifies whether characters with values greater than 127 should be logged
34091 unchanged, or whether they should be rendered as escape sequences.
34092 .next
34093 .cindex "log" "certificate verification"
34094 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
34095 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
34096 verified, and &`CV=no`& if not.
34097 .next
34098 .cindex "log" "TLS cipher"
34099 .cindex "TLS" "logging cipher"
34100 &%tls_cipher%&: When a message is sent or received over an encrypted
34101 connection, the cipher suite used is added to the log line, preceded by X=.
34102 .next
34103 .cindex "log" "TLS peer DN"
34104 .cindex "TLS" "logging peer DN"
34105 &%tls_peerdn%&: When a message is sent or received over an encrypted
34106 connection, and a certificate is supplied by the remote host, the peer DN is
34107 added to the log line, preceded by DN=.
34108 .next
34109 .cindex "log" "TLS SNI"
34110 .cindex "TLS" "logging SNI"
34111 &%tls_sni%&: When a message is received over an encrypted connection, and
34112 the remote host provided the Server Name Indication extension, the SNI is
34113 added to the log line, preceded by SNI=.
34114 .next
34115 .cindex "log" "DNS failure in list"
34116 &%unknown_in_list%&: This setting causes a log entry to be written when the
34117 result of a list match is failure because a DNS lookup failed.
34118 .endlist
34119
34120
34121 .section "Message log" "SECID260"
34122 .cindex "message" "log file for"
34123 .cindex "log" "message log; description of"
34124 .cindex "&_msglog_& directory"
34125 .oindex "&%preserve_message_logs%&"
34126 In addition to the general log files, Exim writes a log file for each message
34127 that it handles. The names of these per-message logs are the message ids, and
34128 they are kept in the &_msglog_& sub-directory of the spool directory. Each
34129 message log contains copies of the log lines that apply to the message. This
34130 makes it easier to inspect the status of an individual message without having
34131 to search the main log. A message log is deleted when processing of the message
34132 is complete, unless &%preserve_message_logs%& is set, but this should be used
34133 only with great care because they can fill up your disk very quickly.
34134
34135 On a heavily loaded system, it may be desirable to disable the use of
34136 per-message logs, in order to reduce disk I/O. This can be done by setting the
34137 &%message_logs%& option false.
34138 .ecindex IIDloggen
34139
34140
34141
34142
34143 . ////////////////////////////////////////////////////////////////////////////
34144 . ////////////////////////////////////////////////////////////////////////////
34145
34146 .chapter "Exim utilities" "CHAPutils"
34147 .scindex IIDutils "utilities"
34148 A number of utility scripts and programs are supplied with Exim and are
34149 described in this chapter. There is also the Exim Monitor, which is covered in
34150 the next chapter. The utilities described here are:
34151
34152 .itable none 0 0 3  7* left  15* left  40* left
34153 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
34154   "list what Exim processes are doing"
34155 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
34156 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
34157 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
34158 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
34159                                                 various criteria"
34160 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
34161 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
34162   "extract statistics from the log"
34163 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
34164   "check address acceptance from given IP"
34165 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
34166 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
34167 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
34168 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
34169 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
34170 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
34171 .endtable
34172
34173 Another utility that might be of use to sites with many MTAs is Tom Kistner's
34174 &'exilog'&. It provides log visualizations across multiple Exim servers. See
34175 &url(http://duncanthrax.net/exilog/) for details.
34176
34177
34178
34179
34180 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
34181 .cindex "&'exiwhat'&"
34182 .cindex "process, querying"
34183 .cindex "SIGUSR1"
34184 On operating systems that can restart a system call after receiving a signal
34185 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
34186 a line describing what it is doing to the file &_exim-process.info_& in the
34187 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
34188 processes it can find, having first emptied the file. It then waits for one
34189 second to allow the Exim processes to react before displaying the results. In
34190 order to run &'exiwhat'& successfully you have to have sufficient privilege to
34191 send the signal to the Exim processes, so it is normally run as root.
34192
34193 &*Warning*&: This is not an efficient process. It is intended for occasional
34194 use by system administrators. It is not sensible, for example, to set up a
34195 script that sends SIGUSR1 signals to Exim processes at short intervals.
34196
34197
34198 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
34199 varies in different operating systems. Not only are different options used,
34200 but the format of the output is different. For this reason, there are some
34201 system configuration options that configure exactly how &'exiwhat'& works. If
34202 it doesn't seem to be working for you, check the following compile-time
34203 options:
34204 .display
34205 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
34206 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
34207 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
34208 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
34209 .endd
34210 An example of typical output from &'exiwhat'& is
34211 .code
34212 164 daemon: -q1h, listening on port 25
34213 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
34214 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
34215   [10.19.42.42] (editor@ref.example)
34216 10592 handling incoming call from [192.168.243.242]
34217 10628 accepting a local non-SMTP message
34218 .endd
34219 The first number in the output line is the process number. The third line has
34220 been split here, in order to fit it on the page.
34221
34222
34223
34224 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
34225 .cindex "&'exiqgrep'&"
34226 .cindex "queue" "grepping"
34227 This utility is a Perl script contributed by Matt Hubbard. It runs
34228 .code
34229 exim -bpu
34230 .endd
34231 to obtain a queue listing with undelivered recipients only, and then greps the
34232 output to select messages that match given criteria. The following selection
34233 options are available:
34234
34235 .vlist
34236 .vitem &*-f*&&~<&'regex'&>
34237 Match the sender address. The field that is tested is enclosed in angle
34238 brackets, so you can test for bounce messages with
34239 .code
34240 exiqgrep -f '^<>$'
34241 .endd
34242 .vitem &*-r*&&~<&'regex'&>
34243 Match a recipient address. The field that is tested is not enclosed in angle
34244 brackets.
34245
34246 .vitem &*-s*&&~<&'regex'&>
34247 Match against the size field.
34248
34249 .vitem &*-y*&&~<&'seconds'&>
34250 Match messages that are younger than the given time.
34251
34252 .vitem &*-o*&&~<&'seconds'&>
34253 Match messages that are older than the given time.
34254
34255 .vitem &*-z*&
34256 Match only frozen messages.
34257
34258 .vitem &*-x*&
34259 Match only non-frozen messages.
34260 .endlist
34261
34262 The following options control the format of the output:
34263
34264 .vlist
34265 .vitem &*-c*&
34266 Display only the count of matching messages.
34267
34268 .vitem &*-l*&
34269 Long format &-- display the full message information as output by Exim. This is
34270 the default.
34271
34272 .vitem &*-i*&
34273 Display message ids only.
34274
34275 .vitem &*-b*&
34276 Brief format &-- one line per message.
34277
34278 .vitem &*-R*&
34279 Display messages in reverse order.
34280 .endlist
34281
34282 There is one more option, &%-h%&, which outputs a list of options.
34283
34284
34285
34286 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
34287 .cindex "&'exiqsumm'&"
34288 .cindex "queue" "summary"
34289 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
34290 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
34291 running a command such as
34292 .code
34293 exim -bp | exiqsumm
34294 .endd
34295 The output consists of one line for each domain that has messages waiting for
34296 it, as in the following example:
34297 .code
34298 3   2322   74m   66m  msn.com.example
34299 .endd
34300 Each line lists the number of pending deliveries for a domain, their total
34301 volume, and the length of time that the oldest and the newest messages have
34302 been waiting. Note that the number of pending deliveries is greater than the
34303 number of messages when messages have more than one recipient.
34304
34305 A summary line is output at the end. By default the output is sorted on the
34306 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
34307 the output to be sorted by oldest message and by count of messages,
34308 respectively. There are also three options that split the messages for each
34309 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
34310 separates frozen messages, and &%-s%& separates messages according to their
34311 sender.
34312
34313 The output of &'exim -bp'& contains the original addresses in the message, so
34314 this also applies to the output from &'exiqsumm'&. No domains from addresses
34315 generated by aliasing or forwarding are included (unless the &%one_time%&
34316 option of the &(redirect)& router has been used to convert them into &"top
34317 level"& addresses).
34318
34319
34320
34321
34322 .section "Extracting specific information from the log (exigrep)" &&&
34323          "SECTextspeinf"
34324 .cindex "&'exigrep'&"
34325 .cindex "log" "extracts; grepping for"
34326 The &'exigrep'& utility is a Perl script that searches one or more main log
34327 files for entries that match a given pattern. When it finds a match, it
34328 extracts all the log entries for the relevant message, not just those that
34329 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
34330 given message, or all mail for a given user, or for a given host, for example.
34331 The input files can be in Exim log format or syslog format.
34332 If a matching log line is not associated with a specific message, it is
34333 included in &'exigrep'&'s output without any additional lines. The usage is:
34334 .display
34335 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
34336 .endd
34337 If no log file names are given on the command line, the standard input is read.
34338
34339 The &%-t%& argument specifies a number of seconds. It adds an additional
34340 condition for message selection. Messages that are complete are shown only if
34341 they spent more than <&'n'&> seconds on the queue.
34342
34343 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
34344 makes it case-sensitive. This may give a performance improvement when searching
34345 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
34346 option; with &%-I%& they do not. In both cases it is possible to change the
34347 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
34348
34349 The &%-l%& option means &"literal"&, that is, treat all characters in the
34350 pattern as standing for themselves. Otherwise the pattern must be a Perl
34351 regular expression.
34352
34353 The &%-v%& option inverts the matching condition. That is, a line is selected
34354 if it does &'not'& match the pattern.
34355
34356 If the location of a &'zcat'& command is known from the definition of
34357 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
34358 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
34359
34360
34361 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
34362 .cindex "&'exipick'&"
34363 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
34364 lists messages from the queue according to a variety of criteria. For details
34365 of &'exipick'&'s facilities, visit the web page at
34366 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
34367 the &%--help%& option.
34368
34369
34370 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
34371 .cindex "log" "cycling local files"
34372 .cindex "cycling logs"
34373 .cindex "&'exicyclog'&"
34374 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
34375 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
34376 you are using log files with datestamps in their names (see section
34377 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
34378 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
34379 There are two command line options for &'exicyclog'&:
34380 .ilist
34381 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
34382 default that is set when Exim is built. The default default is 10.
34383 .next
34384 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
34385 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
34386 overriding the script's default, which is to find the setting from Exim's
34387 configuration.
34388 .endlist
34389
34390 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
34391 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
34392 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
34393 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
34394 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
34395 logs are handled similarly.
34396
34397 If the limit is greater than 99, the script uses 3-digit numbers such as
34398 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
34399 to one that is greater, or &'vice versa'&, you will have to fix the names of
34400 any existing log files.
34401
34402 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
34403 the end are deleted. All files with numbers greater than 01 are compressed,
34404 using a compression command which is configured by the COMPRESS_COMMAND
34405 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
34406 root &%crontab%& entry of the form
34407 .code
34408 1 0 * * * su exim -c /usr/exim/bin/exicyclog
34409 .endd
34410 assuming you have used the name &"exim"& for the Exim user. You can run
34411 &'exicyclog'& as root if you wish, but there is no need.
34412
34413
34414
34415 .section "Mail statistics (eximstats)" "SECTmailstat"
34416 .cindex "statistics"
34417 .cindex "&'eximstats'&"
34418 A Perl script called &'eximstats'& is provided for extracting statistical
34419 information from log files. The output is either plain text, or HTML.
34420 Exim log files are also supported by the &'Lire'& system produced by the
34421 LogReport Foundation &url(http://www.logreport.org).
34422
34423 The &'eximstats'& script has been hacked about quite a bit over time. The
34424 latest version is the result of some extensive revision by Steve Campbell. A
34425 lot of information is given by default, but there are options for suppressing
34426 various parts of it. Following any options, the arguments to the script are a
34427 list of files, which should be main log files. For example:
34428 .code
34429 eximstats -nr /var/spool/exim/log/mainlog.01
34430 .endd
34431 By default, &'eximstats'& extracts information about the number and volume of
34432 messages received from or delivered to various hosts. The information is sorted
34433 both by message count and by volume, and the top fifty hosts in each category
34434 are listed on the standard output. Similar information, based on email
34435 addresses or domains instead of hosts can be requested by means of various
34436 options. For messages delivered and received locally, similar statistics are
34437 also produced per user.
34438
34439 The output also includes total counts and statistics about delivery errors, and
34440 histograms showing the number of messages received and deliveries made in each
34441 hour of the day. A delivery with more than one address in its envelope (for
34442 example, an SMTP transaction with more than one RCPT command) is counted
34443 as a single delivery by &'eximstats'&.
34444
34445 Though normally more deliveries than receipts are reported (as messages may
34446 have multiple recipients), it is possible for &'eximstats'& to report more
34447 messages received than delivered, even though the queue is empty at the start
34448 and end of the period in question. If an incoming message contains no valid
34449 recipients, no deliveries are recorded for it. A bounce message is handled as
34450 an entirely separate message.
34451
34452 &'eximstats'& always outputs a grand total summary giving the volume and number
34453 of messages received and deliveries made, and the number of hosts involved in
34454 each case. It also outputs the number of messages that were delayed (that is,
34455 not completely delivered at the first attempt), and the number that had at
34456 least one address that failed.
34457
34458 The remainder of the output is in sections that can be independently disabled
34459 or modified by various options. It consists of a summary of deliveries by
34460 transport, histograms of messages received and delivered per time interval
34461 (default per hour), information about the time messages spent on the queue,
34462 a list of relayed messages, lists of the top fifty sending hosts, local
34463 senders, destination hosts, and destination local users by count and by volume,
34464 and a list of delivery errors that occurred.
34465
34466 The relay information lists messages that were actually relayed, that is, they
34467 came from a remote host and were directly delivered to some other remote host,
34468 without being processed (for example, for aliasing or forwarding) locally.
34469
34470 There are quite a few options for &'eximstats'& to control exactly what it
34471 outputs. These are documented in the Perl script itself, and can be extracted
34472 by running the command &(perldoc)& on the script. For example:
34473 .code
34474 perldoc /usr/exim/bin/eximstats
34475 .endd
34476
34477 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
34478 .cindex "&'exim_checkaccess'&"
34479 .cindex "policy control" "checking access"
34480 .cindex "checking access"
34481 The &%-bh%& command line argument allows you to run a fake SMTP session with
34482 debugging output, in order to check what Exim is doing when it is applying
34483 policy controls to incoming SMTP mail. However, not everybody is sufficiently
34484 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
34485 sometimes you just want to answer the question &"Does this address have
34486 access?"& without bothering with any further details.
34487
34488 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
34489 two arguments, an IP address and an email address:
34490 .code
34491 exim_checkaccess 10.9.8.7 A.User@a.domain.example
34492 .endd
34493 The utility runs a call to Exim with the &%-bh%& option, to test whether the
34494 given email address would be accepted in a RCPT command in a TCP/IP
34495 connection from the host with the given IP address. The output of the utility
34496 is either the word &"accepted"&, or the SMTP error response, for example:
34497 .code
34498 Rejected:
34499 550 Relay not permitted
34500 .endd
34501 When running this test, the utility uses &`<>`& as the envelope sender address
34502 for the MAIL command, but you can change this by providing additional
34503 options. These are passed directly to the Exim command. For example, to specify
34504 that the test is to be run with the sender address &'himself@there.example'&
34505 you can use:
34506 .code
34507 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
34508                  -f himself@there.example
34509 .endd
34510 Note that these additional Exim command line items must be given after the two
34511 mandatory arguments.
34512
34513 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
34514 while running its checks. You can run checks that include callouts by using
34515 &%-bhc%&, but this is not yet available in a &"packaged"& form.
34516
34517
34518
34519 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
34520 .cindex "DBM" "building dbm files"
34521 .cindex "building DBM files"
34522 .cindex "&'exim_dbmbuild'&"
34523 .cindex "lower casing"
34524 .cindex "binary zero" "in lookup key"
34525 The &'exim_dbmbuild'& program reads an input file containing keys and data in
34526 the format used by the &(lsearch)& lookup (see section
34527 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
34528 names as keys and the remainder of the information as data. The lower-casing
34529 can be prevented by calling the program with the &%-nolc%& option.
34530
34531 A terminating zero is included as part of the key string. This is expected by
34532 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34533 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34534 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34535 files.
34536
34537 The program requires two arguments: the name of the input file (which can be a
34538 single hyphen to indicate the standard input), and the name of the output file.
34539 It creates the output under a temporary name, and then renames it if all went
34540 well.
34541
34542 .cindex "USE_DB"
34543 If the native DB interface is in use (USE_DB is set in a compile-time
34544 configuration file &-- this is common in free versions of Unix) the two file
34545 names must be different, because in this mode the Berkeley DB functions create
34546 a single output file using exactly the name given. For example,
34547 .code
34548 exim_dbmbuild /etc/aliases /etc/aliases.db
34549 .endd
34550 reads the system alias file and creates a DBM version of it in
34551 &_/etc/aliases.db_&.
34552
34553 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34554 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34555 environment, the suffixes are added to the second argument of
34556 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34557 when the Berkeley functions are used in compatibility mode (though this is not
34558 recommended), because in that case it adds a &_.db_& suffix to the file name.
34559
34560 If a duplicate key is encountered, the program outputs a warning, and when it
34561 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34562 option is used. By default, only the first of a set of duplicates is used &--
34563 this makes it compatible with &(lsearch)& lookups. There is an option
34564 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34565 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34566 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34567 return code is 2.
34568
34569
34570
34571
34572 .section "Finding individual retry times (exinext)" "SECTfinindret"
34573 .cindex "retry" "times"
34574 .cindex "&'exinext'&"
34575 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34576 fish specific information out of the retry database. Given a mail domain (or a
34577 complete address), it looks up the hosts for that domain, and outputs any retry
34578 information for the hosts or for the domain. At present, the retry information
34579 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34580 output. For example:
34581 .code
34582 $ exinext piglet@milne.fict.example
34583 kanga.milne.example:192.168.8.1 error 146: Connection refused
34584   first failed: 21-Feb-1996 14:57:34
34585   last tried:   21-Feb-1996 14:57:34
34586   next try at:  21-Feb-1996 15:02:34
34587 roo.milne.example:192.168.8.3 error 146: Connection refused
34588   first failed: 20-Jan-1996 13:12:08
34589   last tried:   21-Feb-1996 11:42:03
34590   next try at:  21-Feb-1996 19:42:03
34591   past final cutoff time
34592 .endd
34593 You can also give &'exinext'& a local part, without a domain, and it
34594 will give any retry information for that local part in your default domain.
34595 A message id can be used to obtain retry information pertaining to a specific
34596 message. This exists only when an attempt to deliver a message to a remote host
34597 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34598 &'exinext'& is not particularly efficient, but then it is not expected to be
34599 run very often.
34600
34601 The &'exinext'& utility calls Exim to find out information such as the location
34602 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
34603 passed on to the &'exim'& commands. The first specifies an alternate Exim
34604 configuration file, and the second sets macros for use within the configuration
34605 file. These features are mainly to help in testing, but might also be useful in
34606 environments where more than one configuration file is in use.
34607
34608
34609
34610 .section "Hints database maintenance" "SECThindatmai"
34611 .cindex "hints database" "maintenance"
34612 .cindex "maintaining Exim's hints database"
34613 Three utility programs are provided for maintaining the DBM files that Exim
34614 uses to contain its delivery hint information. Each program requires two
34615 arguments. The first specifies the name of Exim's spool directory, and the
34616 second is the name of the database it is to operate on. These are as follows:
34617
34618 .ilist
34619 &'retry'&: the database of retry information
34620 .next
34621 &'wait-'&<&'transport name'&>: databases of information about messages waiting
34622 for remote hosts
34623 .next
34624 &'callout'&: the callout cache
34625 .next
34626 &'ratelimit'&: the data for implementing the ratelimit ACL condition
34627 .next
34628 &'misc'&: other hints data
34629 .endlist
34630
34631 The &'misc'& database is used for
34632
34633 .ilist
34634 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
34635 .next
34636 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
34637 &(smtp)& transport)
34638 .endlist
34639
34640
34641
34642 .section "exim_dumpdb" "SECID261"
34643 .cindex "&'exim_dumpdb'&"
34644 The entire contents of a database are written to the standard output by the
34645 &'exim_dumpdb'& program, which has no options or arguments other than the
34646 spool and database names. For example, to dump the retry database:
34647 .code
34648 exim_dumpdb /var/spool/exim retry
34649 .endd
34650 Two lines of output are produced for each entry:
34651 .code
34652 T:mail.ref.example:192.168.242.242 146 77 Connection refused
34653 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
34654 .endd
34655 The first item on the first line is the key of the record. It starts with one
34656 of the letters R, or T, depending on whether it refers to a routing or
34657 transport retry. For a local delivery, the next part is the local address; for
34658 a remote delivery it is the name of the remote host, followed by its failing IP
34659 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
34660 transport). If the remote port is not the standard one (port 25), it is added
34661 to the IP address. Then there follows an error code, an additional error code,
34662 and a textual description of the error.
34663
34664 The three times on the second line are the time of first failure, the time of
34665 the last delivery attempt, and the computed time for the next attempt. The line
34666 ends with an asterisk if the cutoff time for the last retry rule has been
34667 exceeded.
34668
34669 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
34670 consists of a host name followed by a list of ids for messages that are or were
34671 waiting to be delivered to that host. If there are a very large number for any
34672 one host, continuation records, with a sequence number added to the host name,
34673 may be seen. The data in these records is often out of date, because a message
34674 may be routed to several alternative hosts, and Exim makes no effort to keep
34675 cross-references.
34676
34677
34678
34679 .section "exim_tidydb" "SECID262"
34680 .cindex "&'exim_tidydb'&"
34681 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
34682 database. If run with no options, it removes all records that are more than 30
34683 days old. The age is calculated from the date and time that the record was last
34684 updated. Note that, in the case of the retry database, it is &'not'& the time
34685 since the first delivery failure. Information about a host that has been down
34686 for more than 30 days will remain in the database, provided that the record is
34687 updated sufficiently often.
34688
34689 The cutoff date can be altered by means of the &%-t%& option, which must be
34690 followed by a time. For example, to remove all records older than a week from
34691 the retry database:
34692 .code
34693 exim_tidydb -t 7d /var/spool/exim retry
34694 .endd
34695 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
34696 message ids. In the former these appear as data in records keyed by host &--
34697 they were messages that were waiting for that host &-- and in the latter they
34698 are the keys for retry information for messages that have suffered certain
34699 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
34700 message ids in database records are those of messages that are still on the
34701 queue. Message ids for messages that no longer exist are removed from
34702 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
34703 For the &'retry'& database, records whose keys are non-existent message ids are
34704 removed. The &'exim_tidydb'& utility outputs comments on the standard output
34705 whenever it removes information from the database.
34706
34707 Certain records are automatically removed by Exim when they are no longer
34708 needed, but others are not. For example, if all the MX hosts for a domain are
34709 down, a retry record is created for each one. If the primary MX host comes back
34710 first, its record is removed when Exim successfully delivers to it, but the
34711 records for the others remain because Exim has not tried to use those hosts.
34712
34713 It is important, therefore, to run &'exim_tidydb'& periodically on all the
34714 hints databases. You should do this at a quiet time of day, because it requires
34715 a database to be locked (and therefore inaccessible to Exim) while it does its
34716 work. Removing records from a DBM file does not normally make the file smaller,
34717 but all the common DBM libraries are able to re-use the space that is released.
34718 After an initial phase of increasing in size, the databases normally reach a
34719 point at which they no longer get any bigger, as long as they are regularly
34720 tidied.
34721
34722 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
34723 databases is likely to keep on increasing.
34724
34725
34726
34727
34728 .section "exim_fixdb" "SECID263"
34729 .cindex "&'exim_fixdb'&"
34730 The &'exim_fixdb'& program is a utility for interactively modifying databases.
34731 Its main use is for testing Exim, but it might also be occasionally useful for
34732 getting round problems in a live system. It has no options, and its interface
34733 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
34734 key of a database record can then be entered, and the data for that record is
34735 displayed.
34736
34737 If &"d"& is typed at the next prompt, the entire record is deleted. For all
34738 except the &'retry'& database, that is the only operation that can be carried
34739 out. For the &'retry'& database, each field is output preceded by a number, and
34740 data for individual fields can be changed by typing the field number followed
34741 by new data, for example:
34742 .code
34743 > 4 951102:1000
34744 .endd
34745 resets the time of the next delivery attempt. Time values are given as a
34746 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
34747 used as optional separators.
34748
34749
34750
34751
34752 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
34753 .cindex "mailbox" "maintenance"
34754 .cindex "&'exim_lock'&"
34755 .cindex "locking mailboxes"
34756 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
34757 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
34758 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
34759 a user agent while investigating a problem. The utility requires the name of
34760 the file as its first argument. If the locking is successful, the second
34761 argument is run as a command (using C's &[system()]& function); if there is no
34762 second argument, the value of the SHELL environment variable is used; if this
34763 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
34764 is unlocked and the utility ends. The following options are available:
34765
34766 .vlist
34767 .vitem &%-fcntl%&
34768 Use &[fcntl()]& locking on the open mailbox.
34769
34770 .vitem &%-flock%&
34771 Use &[flock()]& locking on the open mailbox, provided the operating system
34772 supports it.
34773
34774 .vitem &%-interval%&
34775 This must be followed by a number, which is a number of seconds; it sets the
34776 interval to sleep between retries (default 3).
34777
34778 .vitem &%-lockfile%&
34779 Create a lock file before opening the mailbox.
34780
34781 .vitem &%-mbx%&
34782 Lock the mailbox using MBX rules.
34783
34784 .vitem &%-q%&
34785 Suppress verification output.
34786
34787 .vitem &%-retries%&
34788 This must be followed by a number; it sets the number of times to try to get
34789 the lock (default 10).
34790
34791 .vitem &%-restore_time%&
34792 This option causes &%exim_lock%& to restore the modified and read times to the
34793 locked file before exiting. This allows you to access a locked mailbox (for
34794 example, to take a backup copy) without disturbing the times that the user
34795 subsequently sees.
34796
34797 .vitem &%-timeout%&
34798 This must be followed by a number, which is a number of seconds; it sets a
34799 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
34800 default), a non-blocking call is used.
34801
34802 .vitem &%-v%&
34803 Generate verbose output.
34804 .endlist
34805
34806 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
34807 default is to create a lock file and also to use &[fcntl()]& locking on the
34808 mailbox, which is the same as Exim's default. The use of &%-flock%& or
34809 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
34810 requires that the directory containing the file be writeable. Locking by lock
34811 file does not last for ever; Exim assumes that a lock file is expired if it is
34812 more than 30 minutes old.
34813
34814 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
34815 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
34816 to be taken out on the open mailbox, and an exclusive lock on the file
34817 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
34818 number of the mailbox file. When the locking is released, if an exclusive lock
34819 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
34820
34821 The default output contains verification of the locking that takes place. The
34822 &%-v%& option causes some additional information to be given. The &%-q%& option
34823 suppresses all output except error messages.
34824
34825 A command such as
34826 .code
34827 exim_lock /var/spool/mail/spqr
34828 .endd
34829 runs an interactive shell while the file is locked, whereas
34830 .display
34831 &`exim_lock -q /var/spool/mail/spqr <<End`&
34832 <&'some commands'&>
34833 &`End`&
34834 .endd
34835 runs a specific non-interactive sequence of commands while the file is locked,
34836 suppressing all verification output. A single command can be run by a command
34837 such as
34838 .code
34839 exim_lock -q /var/spool/mail/spqr \
34840   "cp /var/spool/mail/spqr /some/where"
34841 .endd
34842 Note that if a command is supplied, it must be entirely contained within the
34843 second argument &-- hence the quotes.
34844 .ecindex IIDutils
34845
34846
34847 . ////////////////////////////////////////////////////////////////////////////
34848 . ////////////////////////////////////////////////////////////////////////////
34849
34850 .chapter "The Exim monitor" "CHAPeximon"
34851 .scindex IIDeximon "Exim monitor" "description"
34852 .cindex "X-windows"
34853 .cindex "&'eximon'&"
34854 .cindex "Local/eximon.conf"
34855 .cindex "&_exim_monitor/EDITME_&"
34856 The Exim monitor is an application which displays in an X window information
34857 about the state of Exim's queue and what Exim is doing. An admin user can
34858 perform certain operations on messages from this GUI interface; however all
34859 such facilities are also available from the command line, and indeed, the
34860 monitor itself makes use of the command line to perform any actions requested.
34861
34862
34863
34864 .section "Running the monitor" "SECID264"
34865 The monitor is started by running the script called &'eximon'&. This is a shell
34866 script that sets up a number of environment variables, and then runs the
34867 binary called &_eximon.bin_&. The default appearance of the monitor window can
34868 be changed by editing the &_Local/eximon.conf_& file created by editing
34869 &_exim_monitor/EDITME_&. Comments in that file describe what the various
34870 parameters are for.
34871
34872 The parameters that get built into the &'eximon'& script can be overridden for
34873 a particular invocation by setting up environment variables of the same names,
34874 preceded by &`EXIMON_`&. For example, a shell command such as
34875 .code
34876 EXIMON_LOG_DEPTH=400 eximon
34877 .endd
34878 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
34879 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
34880 overrides the Exim log file configuration. This makes it possible to have
34881 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
34882 syslog messages are routed to a file on the local host.
34883
34884 X resources can be used to change the appearance of the window in the normal
34885 way. For example, a resource setting of the form
34886 .code
34887 Eximon*background: gray94
34888 .endd
34889 changes the colour of the background to light grey rather than white. The
34890 stripcharts are drawn with both the data lines and the reference lines in
34891 black. This means that the reference lines are not visible when on top of the
34892 data. However, their colour can be changed by setting a resource called
34893 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
34894 For example, if your X server is running Unix, you could set up lighter
34895 reference lines in the stripcharts by obeying
34896 .code
34897 xrdb -merge <<End
34898 Eximon*highlight: gray
34899 End
34900 .endd
34901 .cindex "admin user"
34902 In order to see the contents of messages on the queue, and to operate on them,
34903 &'eximon'& must either be run as root or by an admin user.
34904
34905 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
34906 contain X11 resource parameters interpreted by the X11 library.  In addition,
34907 if the first parameter starts with the string "gdb" then it is removed and the
34908 binary is invoked under gdb (the parameter is used as the gdb command-name, so
34909 versioned variants of gdb can be invoked).
34910
34911 The monitor's window is divided into three parts. The first contains one or
34912 more stripcharts and two action buttons, the second contains a &"tail"& of the
34913 main log file, and the third is a display of the queue of messages awaiting
34914 delivery, with two more action buttons. The following sections describe these
34915 different parts of the display.
34916
34917
34918
34919
34920 .section "The stripcharts" "SECID265"
34921 .cindex "stripchart"
34922 The first stripchart is always a count of messages on the queue. Its name can
34923 be configured by setting QUEUE_STRIPCHART_NAME in the
34924 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
34925 configuration script by regular expression matches on log file entries, making
34926 it possible to display, for example, counts of messages delivered to certain
34927 hosts or using certain transports. The supplied defaults display counts of
34928 received and delivered messages, and of local and SMTP deliveries. The default
34929 period between stripchart updates is one minute; this can be adjusted by a
34930 parameter in the &_Local/eximon.conf_& file.
34931
34932 The stripchart displays rescale themselves automatically as the value they are
34933 displaying changes. There are always 10 horizontal lines in each chart; the
34934 title string indicates the value of each division when it is greater than one.
34935 For example, &"x2"& means that each division represents a value of 2.
34936
34937 It is also possible to have a stripchart which shows the percentage fullness of
34938 a particular disk partition, which is useful when local deliveries are confined
34939 to a single partition.
34940
34941 .cindex "&%statvfs%& function"
34942 This relies on the availability of the &[statvfs()]& function or equivalent in
34943 the operating system. Most, but not all versions of Unix that support Exim have
34944 this. For this particular stripchart, the top of the chart always represents
34945 100%, and the scale is given as &"x10%"&. This chart is configured by setting
34946 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
34947 &_Local/eximon.conf_& file.
34948
34949
34950
34951
34952 .section "Main action buttons" "SECID266"
34953 .cindex "size" "of monitor window"
34954 .cindex "Exim monitor" "window size"
34955 .cindex "window size"
34956 Below the stripcharts there is an action button for quitting the monitor. Next
34957 to this is another button marked &"Size"&. They are placed here so that
34958 shrinking the window to its default minimum size leaves just the queue count
34959 stripchart and these two buttons visible. Pressing the &"Size"& button causes
34960 the window to expand to its maximum size, unless it is already at the maximum,
34961 in which case it is reduced to its minimum.
34962
34963 When expanding to the maximum, if the window cannot be fully seen where it
34964 currently is, it is moved back to where it was the last time it was at full
34965 size. When it is expanding from its minimum size, the old position is
34966 remembered, and next time it is reduced to the minimum it is moved back there.
34967
34968 The idea is that you can keep a reduced window just showing one or two
34969 stripcharts at a convenient place on your screen, easily expand it to show
34970 the full window when required, and just as easily put it back to what it was.
34971 The idea is copied from what the &'twm'& window manager does for its
34972 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
34973 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
34974
34975 Normally, the monitor starts up with the window at its full size, but it can be
34976 built so that it starts up with the window at its smallest size, by setting
34977 START_SMALL=yes in &_Local/eximon.conf_&.
34978
34979
34980
34981 .section "The log display" "SECID267"
34982 .cindex "log" "tail of; in monitor"
34983 The second section of the window is an area in which a display of the tail of
34984 the main log is maintained.
34985 To save space on the screen, the timestamp on each log line is shortened by
34986 removing the date and, if &%log_timezone%& is set, the timezone.
34987 The log tail is not available when the only destination for logging data is
34988 syslog, unless the syslog lines are routed to a local file whose name is passed
34989 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
34990
34991 The log sub-window has a scroll bar at its lefthand side which can be used to
34992 move back to look at earlier text, and the up and down arrow keys also have a
34993 scrolling effect. The amount of log that is kept depends on the setting of
34994 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
34995 to use. When this is full, the earlier 50% of data is discarded &-- this is
34996 much more efficient than throwing it away line by line. The sub-window also has
34997 a horizontal scroll bar for accessing the ends of long log lines. This is the
34998 only means of horizontal scrolling; the right and left arrow keys are not
34999 available. Text can be cut from this part of the window using the mouse in the
35000 normal way. The size of this subwindow is controlled by parameters in the
35001 configuration file &_Local/eximon.conf_&.
35002
35003 Searches of the text in the log window can be carried out by means of the ^R
35004 and ^S keystrokes, which default to a reverse and a forward search,
35005 respectively. The search covers only the text that is displayed in the window.
35006 It cannot go further back up the log.
35007
35008 The point from which the search starts is indicated by a caret marker. This is
35009 normally at the end of the text in the window, but can be positioned explicitly
35010 by pointing and clicking with the left mouse button, and is moved automatically
35011 by a successful search. If new text arrives in the window when it is scrolled
35012 back, the caret remains where it is, but if the window is not scrolled back,
35013 the caret is moved to the end of the new text.
35014
35015 Pressing ^R or ^S pops up a window into which the search text can be typed.
35016 There are buttons for selecting forward or reverse searching, for carrying out
35017 the search, and for cancelling. If the &"Search"& button is pressed, the search
35018 happens and the window remains so that further searches can be done. If the
35019 &"Return"& key is pressed, a single search is done and the window is closed. If
35020 ^C is typed the search is cancelled.
35021
35022 The searching facility is implemented using the facilities of the Athena text
35023 widget. By default this pops up a window containing both &"search"& and
35024 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
35025 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
35026 However, the linkers in BSDI and HP-UX seem unable to handle an externally
35027 provided version of &%TextPop%& when the remaining parts of the text widget
35028 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
35029 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
35030 on these systems, at the expense of having unwanted items in the search popup
35031 window.
35032
35033
35034
35035 .section "The queue display" "SECID268"
35036 .cindex "queue" "display in monitor"
35037 The bottom section of the monitor window contains a list of all messages that
35038 are on the queue, which includes those currently being received or delivered,
35039 as well as those awaiting delivery. The size of this subwindow is controlled by
35040 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
35041 at which it is updated is controlled by another parameter in the same file &--
35042 the default is 5 minutes, since queue scans can be quite expensive. However,
35043 there is an &"Update"& action button just above the display which can be used
35044 to force an update of the queue display at any time.
35045
35046 When a host is down for some time, a lot of pending mail can build up for it,
35047 and this can make it hard to deal with other messages on the queue. To help
35048 with this situation there is a button next to &"Update"& called &"Hide"&. If
35049 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
35050 type anything in here and press &"Return"&, the text is added to a chain of
35051 such texts, and if every undelivered address in a message matches at least one
35052 of the texts, the message is not displayed.
35053
35054 If there is an address that does not match any of the texts, all the addresses
35055 are displayed as normal. The matching happens on the ends of addresses so, for
35056 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
35057 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
35058 has been set up, a button called &"Unhide"& is displayed. If pressed, it
35059 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
35060 a hide request is automatically cancelled after one hour.
35061
35062 While the dialogue box is displayed, you can't press any buttons or do anything
35063 else to the monitor window. For this reason, if you want to cut text from the
35064 queue display to use in the dialogue box, you have to do the cutting before
35065 pressing the &"Hide"& button.
35066
35067 The queue display contains, for each unhidden queued message, the length of
35068 time it has been on the queue, the size of the message, the message id, the
35069 message sender, and the first undelivered recipient, all on one line. If it is
35070 a bounce message, the sender is shown as &"<>"&. If there is more than one
35071 recipient to which the message has not yet been delivered, subsequent ones are
35072 listed on additional lines, up to a maximum configured number, following which
35073 an ellipsis is displayed. Recipients that have already received the message are
35074 not shown.
35075
35076 .cindex "frozen messages" "display"
35077 If a message is frozen, an asterisk is displayed at the left-hand side.
35078
35079 The queue display has a vertical scroll bar, and can also be scrolled by means
35080 of the arrow keys. Text can be cut from it using the mouse in the normal way.
35081 The text searching facilities, as described above for the log window, are also
35082 available, but the caret is always moved to the end of the text when the queue
35083 display is updated.
35084
35085
35086
35087 .section "The queue menu" "SECID269"
35088 .cindex "queue" "menu in monitor"
35089 If the &%shift%& key is held down and the left button is clicked when the mouse
35090 pointer is over the text for any message, an action menu pops up, and the first
35091 line of the queue display for the message is highlighted. This does not affect
35092 any selected text.
35093
35094 If you want to use some other event for popping up the menu, you can set the
35095 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
35096 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
35097 value set in this parameter is a standard X event description. For example, to
35098 run eximon using &%ctrl%& rather than &%shift%& you could use
35099 .code
35100 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
35101 .endd
35102 The title of the menu is the message id, and it contains entries which act as
35103 follows:
35104
35105 .ilist
35106 &'message log'&: The contents of the message log for the message are displayed
35107 in a new text window.
35108 .next
35109 &'headers'&: Information from the spool file that contains the envelope
35110 information and headers is displayed in a new text window. See chapter
35111 &<<CHAPspool>>& for a description of the format of spool files.
35112 .next
35113 &'body'&: The contents of the spool file containing the body of the message are
35114 displayed in a new text window. There is a default limit of 20,000 bytes to the
35115 amount of data displayed. This can be changed by setting the BODY_MAX
35116 option at compile time, or the EXIMON_BODY_MAX option at run time.
35117 .next
35118 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
35119 delivery of the message. This causes an automatic thaw if the message is
35120 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
35121 a new text window. The delivery is run in a separate process, to avoid holding
35122 up the monitor while the delivery proceeds.
35123 .next
35124 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
35125 that the message be frozen.
35126 .next
35127 .cindex "thawing messages"
35128 .cindex "unfreezing messages"
35129 .cindex "frozen messages" "thawing"
35130 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
35131 that the message be thawed.
35132 .next
35133 .cindex "delivery" "forcing failure"
35134 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
35135 that Exim gives up trying to deliver the message. A bounce message is generated
35136 for any remaining undelivered addresses.
35137 .next
35138 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
35139 that the message be deleted from the system without generating a bounce
35140 message.
35141 .next
35142 &'add recipient'&: A dialog box is displayed into which a recipient address can
35143 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35144 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35145 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35146 causes a call to Exim to be made using the &%-Mar%& option to request that an
35147 additional recipient be added to the message, unless the entry box is empty, in
35148 which case no action is taken.
35149 .next
35150 &'mark delivered'&: A dialog box is displayed into which a recipient address
35151 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35152 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35153 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35154 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
35155 recipient address as already delivered, unless the entry box is empty, in which
35156 case no action is taken.
35157 .next
35158 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
35159 mark all recipient addresses as already delivered.
35160 .next
35161 &'edit sender'&: A dialog box is displayed initialized with the current
35162 sender's address. Pressing RETURN causes a call to Exim to be made using the
35163 &%-Mes%& option to replace the sender address, unless the entry box is empty,
35164 in which case no action is taken. If you want to set an empty sender (as in
35165 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
35166 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
35167 the address is qualified with that domain.
35168 .endlist
35169
35170 When a delivery is forced, a window showing the &%-v%& output is displayed. In
35171 other cases when a call to Exim is made, if there is any output from Exim (in
35172 particular, if the command fails) a window containing the command and the
35173 output is displayed. Otherwise, the results of the action are normally apparent
35174 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
35175 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
35176 if no output is generated.
35177
35178 The queue display is automatically updated for actions such as freezing and
35179 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
35180 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
35181 force an update of the display after one of these actions.
35182
35183 In any text window that is displayed as result of a menu action, the normal
35184 cut-and-paste facility is available, and searching can be carried out using ^R
35185 and ^S, as described above for the log tail window.
35186 .ecindex IIDeximon
35187
35188
35189
35190
35191
35192 . ////////////////////////////////////////////////////////////////////////////
35193 . ////////////////////////////////////////////////////////////////////////////
35194
35195 .chapter "Security considerations" "CHAPsecurity"
35196 .scindex IIDsecurcon "security" "discussion of"
35197 This chapter discusses a number of issues concerned with security, some of
35198 which are also covered in other parts of this manual.
35199
35200 For reasons that this author does not understand, some people have promoted
35201 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
35202 existence of this chapter in the documentation. However, the intent of the
35203 chapter is simply to describe the way Exim works in relation to certain
35204 security concerns, not to make any specific claims about the effectiveness of
35205 its security as compared with other MTAs.
35206
35207 What follows is a description of the way Exim is supposed to be. Best efforts
35208 have been made to try to ensure that the code agrees with the theory, but an
35209 absence of bugs can never be guaranteed. Any that are reported will get fixed
35210 as soon as possible.
35211
35212
35213 .section "Building a more &""hardened""& Exim" "SECID286"
35214 .cindex "security" "build-time features"
35215 There are a number of build-time options that can be set in &_Local/Makefile_&
35216 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
35217 Exim administrator who does not have the root password, or by someone who has
35218 penetrated the Exim (but not the root) account. These options are as follows:
35219
35220 .ilist
35221 ALT_CONFIG_PREFIX can be set to a string that is required to match the
35222 start of any file names used with the &%-C%& option. When it is set, these file
35223 names are also not allowed to contain the sequence &"/../"&. (However, if the
35224 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
35225 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
35226 default setting for &%ALT_CONFIG_PREFIX%&.
35227
35228 If the permitted configuration files are confined to a directory to
35229 which only root has access, this guards against someone who has broken
35230 into the Exim account from running a privileged Exim with an arbitrary
35231 configuration file, and using it to break into other accounts.
35232 .next
35233
35234 If a non-trusted configuration file (i.e. not the default configuration file
35235 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
35236 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
35237 the next item), then root privilege is retained only if the caller of Exim is
35238 root. This locks out the possibility of testing a configuration using &%-C%&
35239 right through message reception and delivery, even if the caller is root. The
35240 reception works, but by that time, Exim is running as the Exim user, so when
35241 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
35242 privilege to be lost. However, root can test reception and delivery using two
35243 separate commands.
35244
35245 .next
35246 The WHITELIST_D_MACROS build option declares some macros to be safe to override
35247 with &%-D%& if the real uid is one of root, the Exim run-time user or the
35248 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
35249 requiring the run-time value supplied to &%-D%& to match a regex that errs on
35250 the restrictive side.  Requiring build-time selection of safe macros is onerous
35251 but this option is intended solely as a transition mechanism to permit
35252 previously-working configurations to continue to work after release 4.73.
35253 .next
35254 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
35255 is disabled.
35256 .next
35257 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
35258 never to be used for any deliveries. This is like the &%never_users%& runtime
35259 option, but it cannot be overridden; the runtime option adds additional users
35260 to the list. The default setting is &"root"&; this prevents a non-root user who
35261 is permitted to modify the runtime file from using Exim as a way to get root.
35262 .endlist
35263
35264
35265
35266 .section "Root privilege" "SECID270"
35267 .cindex "setuid"
35268 .cindex "root privilege"
35269 The Exim binary is normally setuid to root, which means that it gains root
35270 privilege (runs as root) when it starts execution. In some special cases (for
35271 example, when the daemon is not in use and there are no local deliveries), it
35272 may be possible to run Exim setuid to some user other than root. This is
35273 discussed in the next section. However, in most installations, root privilege
35274 is required for two things:
35275
35276 .ilist
35277 To set up a socket connected to the standard SMTP port (25) when initialising
35278 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
35279 not required.
35280 .next
35281 To be able to change uid and gid in order to read users' &_.forward_& files and
35282 perform local deliveries as the receiving user or as specified in the
35283 configuration.
35284 .endlist
35285
35286 It is not necessary to be root to do any of the other things Exim does, such as
35287 receiving messages and delivering them externally over SMTP, and it is
35288 obviously more secure if Exim does not run as root except when necessary.
35289 For this reason, a user and group for Exim to use must be defined in
35290 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
35291 group"&. Their values can be changed by the run time configuration, though this
35292 is not recommended. Often a user called &'exim'& is used, but some sites use
35293 &'mail'& or another user name altogether.
35294
35295 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
35296 abdication; the process cannot regain root afterwards. Prior to release 4.00,
35297 &[seteuid()]& was used in some circumstances, but this is no longer the case.
35298
35299 After a new Exim process has interpreted its command line options, it changes
35300 uid and gid in the following cases:
35301
35302 .ilist
35303 .oindex "&%-C%&"
35304 .oindex "&%-D%&"
35305 If the &%-C%& option is used to specify an alternate configuration file, or if
35306 the &%-D%& option is used to define macro values for the configuration, and the
35307 calling process is not running as root, the uid and gid are changed to those of
35308 the calling process.
35309 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
35310 option may not be used at all.
35311 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
35312 can be supplied if the calling process is running as root, the Exim run-time
35313 user or CONFIGURE_OWNER, if defined.
35314 .next
35315 .oindex "&%-be%&"
35316 .oindex "&%-bf%&"
35317 .oindex "&%-bF%&"
35318 If the expansion test option (&%-be%&) or one of the filter testing options
35319 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
35320 calling process.
35321 .next
35322 If the process is not a daemon process or a queue runner process or a delivery
35323 process or a process for testing address routing (started with &%-bt%&), the
35324 uid and gid are changed to the Exim user and group. This means that Exim always
35325 runs under its own uid and gid when receiving messages. This also applies when
35326 testing address verification
35327 .oindex "&%-bv%&"
35328 .oindex "&%-bh%&"
35329 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
35330 option).
35331 .next
35332 For a daemon, queue runner, delivery, or address testing process, the uid
35333 remains as root at this stage, but the gid is changed to the Exim group.
35334 .endlist
35335
35336 The processes that initially retain root privilege behave as follows:
35337
35338 .ilist
35339 A daemon process changes the gid to the Exim group and the uid to the Exim
35340 user after setting up one or more listening sockets. The &[initgroups()]&
35341 function is called, so that if the Exim user is in any additional groups, they
35342 will be used during message reception.
35343 .next
35344 A queue runner process retains root privilege throughout its execution. Its
35345 job is to fork a controlled sequence of delivery processes.
35346 .next
35347 A delivery process retains root privilege throughout most of its execution,
35348 but any actual deliveries (that is, the transports themselves) are run in
35349 subprocesses which always change to a non-root uid and gid. For local
35350 deliveries this is typically the uid and gid of the owner of the mailbox; for
35351 remote deliveries, the Exim uid and gid are used. Once all the delivery
35352 subprocesses have been run, a delivery process changes to the Exim uid and gid
35353 while doing post-delivery tidying up such as updating the retry database and
35354 generating bounce and warning messages.
35355
35356 While the recipient addresses in a message are being routed, the delivery
35357 process runs as root. However, if a user's filter file has to be processed,
35358 this is done in a subprocess that runs under the individual user's uid and
35359 gid. A system filter is run as root unless &%system_filter_user%& is set.
35360 .next
35361 A process that is testing addresses (the &%-bt%& option) runs as root so that
35362 the routing is done in the same environment as a message delivery.
35363 .endlist
35364
35365
35366
35367
35368 .section "Running Exim without privilege" "SECTrunexiwitpri"
35369 .cindex "privilege, running without"
35370 .cindex "unprivileged running"
35371 .cindex "root privilege" "running without"
35372 Some installations like to run Exim in an unprivileged state for more of its
35373 operation, for added security. Support for this mode of operation is provided
35374 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
35375 gid are changed to the Exim user and group at the start of a delivery process
35376 (and also queue runner and address testing processes). This means that address
35377 routing is no longer run as root, and the deliveries themselves cannot change
35378 to any other uid.
35379
35380 .cindex SIGHUP
35381 .cindex "daemon" "restarting"
35382 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
35383 that the daemon can still be started in the usual way, and it can respond
35384 correctly to SIGHUP because the re-invocation regains root privilege.
35385
35386 An alternative approach is to make Exim setuid to the Exim user and also setgid
35387 to the Exim group. If you do this, the daemon must be started from a root
35388 process. (Calling Exim from a root process makes it behave in the way it does
35389 when it is setuid root.) However, the daemon cannot restart itself after a
35390 SIGHUP signal because it cannot regain privilege.
35391
35392 It is still useful to set &%deliver_drop_privilege%& in this case, because it
35393 stops Exim from trying to re-invoke itself to do a delivery after a message has
35394 been received. Such a re-invocation is a waste of resources because it has no
35395 effect.
35396
35397 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
35398 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
35399 to the Exim user seems a clean approach, but there is one complication:
35400
35401 In this style of operation, Exim is running with the real uid and gid set to
35402 those of the calling process, and the effective uid/gid set to Exim's values.
35403 Ideally, any association with the calling process' uid/gid should be dropped,
35404 that is, the real uid/gid should be reset to the effective values so as to
35405 discard any privileges that the caller may have. While some operating systems
35406 have a function that permits this action for a non-root effective uid, quite a
35407 number of them do not. Because of this lack of standardization, Exim does not
35408 address this problem at this time.
35409
35410 For this reason, the recommended approach for &"mostly unprivileged"& running
35411 is to keep the Exim binary setuid to root, and to set
35412 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
35413 be used in the most straightforward way.
35414
35415 If you configure Exim not to run delivery processes as root, there are a
35416 number of restrictions on what you can do:
35417
35418 .ilist
35419 You can deliver only as the Exim user/group. You should  explicitly use the
35420 &%user%& and &%group%& options to override routers or local transports that
35421 normally deliver as the recipient. This makes sure that configurations that
35422 work in this mode function the same way in normal mode. Any implicit or
35423 explicit specification of another user causes an error.
35424 .next
35425 Use of &_.forward_& files is severely restricted, such that it is usually
35426 not worthwhile to include them in the configuration.
35427 .next
35428 Users who wish to use &_.forward_& would have to make their home directory and
35429 the file itself accessible to the Exim user. Pipe and append-to-file entries,
35430 and their equivalents in Exim filters, cannot be used. While they could be
35431 enabled in the Exim user's name, that would be insecure and not very useful.
35432 .next
35433 Unless the local user mailboxes are all owned by the Exim user (possible in
35434 some POP3 or IMAP-only environments):
35435
35436 .olist
35437 They must be owned by the Exim group and be writeable by that group. This
35438 implies you must set &%mode%& in the appendfile configuration, as well as the
35439 mode of the mailbox files themselves.
35440 .next
35441 You must set &%no_check_owner%&, since most or all of the files will not be
35442 owned by the Exim user.
35443 .next
35444 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
35445 on a newly created mailbox when unprivileged. This also implies that new
35446 mailboxes need to be created manually.
35447 .endlist olist
35448 .endlist ilist
35449
35450
35451 These restrictions severely restrict what can be done in local deliveries.
35452 However, there are no restrictions on remote deliveries. If you are running a
35453 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
35454 gives more security at essentially no cost.
35455
35456 If you are using the &%mua_wrapper%& facility (see chapter
35457 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
35458
35459
35460
35461
35462 .section "Delivering to local files" "SECID271"
35463 Full details of the checks applied by &(appendfile)& before it writes to a file
35464 are given in chapter &<<CHAPappendfile>>&.
35465
35466
35467
35468 .section "IPv4 source routing" "SECID272"
35469 .cindex "source routing" "in IP packets"
35470 .cindex "IP source routing"
35471 Many operating systems suppress IP source-routed packets in the kernel, but
35472 some cannot be made to do this, so Exim does its own check. It logs incoming
35473 IPv4 source-routed TCP calls, and then drops them. Things are all different in
35474 IPv6. No special checking is currently done.
35475
35476
35477
35478 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
35479 Support for these SMTP commands is disabled by default. If required, they can
35480 be enabled by defining suitable ACLs.
35481
35482
35483
35484
35485 .section "Privileged users" "SECID274"
35486 .cindex "trusted users"
35487 .cindex "admin user"
35488 .cindex "privileged user"
35489 .cindex "user" "trusted"
35490 .cindex "user" "admin"
35491 Exim recognizes two sets of users with special privileges. Trusted users are
35492 able to submit new messages to Exim locally, but supply their own sender
35493 addresses and information about a sending host. For other users submitting
35494 local messages, Exim sets up the sender address from the uid, and doesn't
35495 permit a remote host to be specified.
35496
35497 .oindex "&%-f%&"
35498 However, an untrusted user is permitted to use the &%-f%& command line option
35499 in the special form &%-f <>%& to indicate that a delivery failure for the
35500 message should not cause an error report. This affects the message's envelope,
35501 but it does not affect the &'Sender:'& header. Untrusted users may also be
35502 permitted to use specific forms of address with the &%-f%& option by setting
35503 the &%untrusted_set_sender%& option.
35504
35505 Trusted users are used to run processes that receive mail messages from some
35506 other mail domain and pass them on to Exim for delivery either locally, or over
35507 the Internet. Exim trusts a caller that is running as root, as the Exim user,
35508 as any user listed in the &%trusted_users%& configuration option, or under any
35509 group listed in the &%trusted_groups%& option.
35510
35511 Admin users are permitted to do things to the messages on Exim's queue. They
35512 can freeze or thaw messages, cause them to be returned to their senders, remove
35513 them entirely, or modify them in various ways. In addition, admin users can run
35514 the Exim monitor and see all the information it is capable of providing, which
35515 includes the contents of files on the spool.
35516
35517 .oindex "&%-M%&"
35518 .oindex "&%-q%&"
35519 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
35520 delivery of messages on its queue is restricted to admin users. This
35521 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
35522 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
35523 queue is also restricted to admin users. This restriction can be relaxed by
35524 setting &%no_queue_list_requires_admin%&.
35525
35526 Exim recognizes an admin user if the calling process is running as root or as
35527 the Exim user or if any of the groups associated with the calling process is
35528 the Exim group. It is not necessary actually to be running under the Exim
35529 group. However, if admin users who are not root or the Exim user are to access
35530 the contents of files on the spool via the Exim monitor (which runs
35531 unprivileged), Exim must be built to allow group read access to its spool
35532 files.
35533
35534
35535
35536 .section "Spool files" "SECID275"
35537 .cindex "spool directory" "files"
35538 Exim's spool directory and everything it contains is owned by the Exim user and
35539 set to the Exim group. The mode for spool files is defined in the
35540 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
35541 any user who is a member of the Exim group can access these files.
35542
35543
35544
35545 .section "Use of argv[0]" "SECID276"
35546 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
35547 of specific strings, Exim assumes certain options. For example, calling Exim
35548 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
35549 to calling it with the option &%-bS%&. There are no security implications in
35550 this.
35551
35552
35553
35554 .section "Use of %f formatting" "SECID277"
35555 The only use made of &"%f"& by Exim is in formatting load average values. These
35556 are actually stored in integer variables as 1000 times the load average.
35557 Consequently, their range is limited and so therefore is the length of the
35558 converted output.
35559
35560
35561
35562 .section "Embedded Exim path" "SECID278"
35563 Exim uses its own path name, which is embedded in the code, only when it needs
35564 to re-exec in order to regain root privilege. Therefore, it is not root when it
35565 does so. If some bug allowed the path to get overwritten, it would lead to an
35566 arbitrary program's being run as exim, not as root.
35567
35568
35569
35570 .section "Dynamic module directory" "SECTdynmoddir"
35571 Any dynamically loadable modules must be installed into the directory
35572 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
35573 loading it.
35574
35575
35576 .section "Use of sprintf()" "SECID279"
35577 .cindex "&[sprintf()]&"
35578 A large number of occurrences of &"sprintf"& in the code are actually calls to
35579 &'string_sprintf()'&, a function that returns the result in malloc'd store.
35580 The intermediate formatting is done into a large fixed buffer by a function
35581 that runs through the format string itself, and checks the length of each
35582 conversion before performing it, thus preventing buffer overruns.
35583
35584 The remaining uses of &[sprintf()]& happen in controlled circumstances where
35585 the output buffer is known to be sufficiently long to contain the converted
35586 string.
35587
35588
35589
35590 .section "Use of debug_printf() and log_write()" "SECID280"
35591 Arbitrary strings are passed to both these functions, but they do their
35592 formatting by calling the function &'string_vformat()'&, which runs through
35593 the format string itself, and checks the length of each conversion.
35594
35595
35596
35597 .section "Use of strcat() and strcpy()" "SECID281"
35598 These are used only in cases where the output buffer is known to be large
35599 enough to hold the result.
35600 .ecindex IIDsecurcon
35601
35602
35603
35604
35605 . ////////////////////////////////////////////////////////////////////////////
35606 . ////////////////////////////////////////////////////////////////////////////
35607
35608 .chapter "Format of spool files" "CHAPspool"
35609 .scindex IIDforspo1 "format" "spool files"
35610 .scindex IIDforspo2 "spool directory" "format of files"
35611 .scindex IIDforspo3 "spool files" "format of"
35612 .cindex "spool files" "editing"
35613 A message on Exim's queue consists of two files, whose names are the message id
35614 followed by -D and -H, respectively. The data portion of the message is kept in
35615 the -D file on its own. The message's envelope, status, and headers are all
35616 kept in the -H file, whose format is described in this chapter. Each of these
35617 two files contains the final component of its own name as its first line. This
35618 is insurance against disk crashes where the directory is lost but the files
35619 themselves are recoverable.
35620
35621 Some people are tempted into editing -D files in order to modify messages. You
35622 need to be extremely careful if you do this; it is not recommended and you are
35623 on your own if you do it. Here are some of the pitfalls:
35624
35625 .ilist
35626 You must ensure that Exim does not try to deliver the message while you are
35627 fiddling with it. The safest way is to take out a write lock on the -D file,
35628 which is what Exim itself does, using &[fcntl()]&. If you update the file in
35629 place, the lock will be retained. If you write a new file and rename it, the
35630 lock will be lost at the instant of rename.
35631 .next
35632 .vindex "&$body_linecount$&"
35633 If you change the number of lines in the file, the value of
35634 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
35635 present, this value is not used by Exim, but there is no guarantee that this
35636 will always be the case.
35637 .next
35638 If the message is in MIME format, you must take care not to break it.
35639 .next
35640 If the message is cryptographically signed, any change will invalidate the
35641 signature.
35642 .endlist
35643 All in all, modifying -D files is fraught with danger.
35644
35645 Files whose names end with -J may also be seen in the &_input_& directory (or
35646 its subdirectories when &%split_spool_directory%& is set). These are journal
35647 files, used to record addresses to which the message has been delivered during
35648 the course of a delivery attempt. If there are still undelivered recipients at
35649 the end, the -H file is updated, and the -J file is deleted. If, however, there
35650 is some kind of crash (for example, a power outage) before this happens, the -J
35651 file remains in existence. When Exim next processes the message, it notices the
35652 -J file and uses it to update the -H file before starting the next delivery
35653 attempt.
35654
35655 .section "Format of the -H file" "SECID282"
35656 .cindex "uid (user id)" "in spool file"
35657 .cindex "gid (group id)" "in spool file"
35658 The second line of the -H file contains the login name for the uid of the
35659 process that called Exim to read the message, followed by the numerical uid and
35660 gid. For a locally generated message, this is normally the user who sent the
35661 message. For a message received over TCP/IP via the daemon, it is
35662 normally the Exim user.
35663
35664 The third line of the file contains the address of the message's sender as
35665 transmitted in the envelope, contained in angle brackets. The sender address is
35666 empty for bounce messages. For incoming SMTP mail, the sender address is given
35667 in the MAIL command. For locally generated mail, the sender address is
35668 created by Exim from the login name of the current user and the configured
35669 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
35670 leading &"From&~"& line if the caller is trusted, or if the supplied address is
35671 &"<>"& or an address that matches &%untrusted_set_senders%&.
35672
35673 The fourth line contains two numbers. The first is the time that the message
35674 was received, in the conventional Unix form &-- the number of seconds since the
35675 start of the epoch. The second number is a count of the number of messages
35676 warning of delayed delivery that have been sent to the sender.
35677
35678 There follow a number of lines starting with a hyphen. These can appear in any
35679 order, and are omitted when not relevant:
35680
35681 .vlist
35682 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
35683 This item is obsolete, and is not generated from Exim release 4.61 onwards;
35684 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
35685 recognized, to provide backward compatibility. In the old format, a line of
35686 this form is present for every ACL variable that is not empty. The number
35687 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
35688 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
35689 the data string for the variable. The string itself starts at the beginning of
35690 the next line, and is followed by a newline character. It may contain internal
35691 newlines.
35692
35693 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
35694 A line of this form is present for every ACL connection variable that is
35695 defined. Note that there is a space between &%-aclc%& and the rest of the name.
35696 The length is the length of the data string for the variable. The string itself
35697 starts at the beginning of the next line, and is followed by a newline
35698 character. It may contain internal newlines.
35699
35700 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
35701 A line of this form is present for every ACL message variable that is defined.
35702 Note that there is a space between &%-aclm%& and the rest of the name. The
35703 length is the length of the data string for the variable. The string itself
35704 starts at the beginning of the next line, and is followed by a newline
35705 character. It may contain internal newlines.
35706
35707 .vitem "&%-active_hostname%&&~<&'hostname'&>"
35708 This is present if, when the message was received over SMTP, the value of
35709 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
35710
35711 .vitem &%-allow_unqualified_recipient%&
35712 This is present if unqualified recipient addresses are permitted in header
35713 lines (to stop such addresses from being qualified if rewriting occurs at
35714 transport time). Local messages that were input using &%-bnq%& and remote
35715 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
35716
35717 .vitem &%-allow_unqualified_sender%&
35718 This is present if unqualified sender addresses are permitted in header lines
35719 (to stop such addresses from being qualified if rewriting occurs at transport
35720 time). Local messages that were input using &%-bnq%& and remote messages from
35721 hosts that match &%sender_unqualified_hosts%& set this flag.
35722
35723 .vitem "&%-auth_id%&&~<&'text'&>"
35724 The id information for a message received on an authenticated SMTP connection
35725 &-- the value of the &$authenticated_id$& variable.
35726
35727 .vitem "&%-auth_sender%&&~<&'address'&>"
35728 The address of an authenticated sender &-- the value of the
35729 &$authenticated_sender$& variable.
35730
35731 .vitem "&%-body_linecount%&&~<&'number'&>"
35732 This records the number of lines in the body of the message, and is always
35733 present.
35734
35735 .vitem "&%-body_zerocount%&&~<&'number'&>"
35736 This records the number of binary zero bytes in the body of the message, and is
35737 present if the number is greater than zero.
35738
35739 .vitem &%-deliver_firsttime%&
35740 This is written when a new message is first added to the spool. When the spool
35741 file is updated after a deferral, it is omitted.
35742
35743 .vitem "&%-frozen%&&~<&'time'&>"
35744 .cindex "frozen messages" "spool data"
35745 The message is frozen, and the freezing happened at <&'time'&>.
35746
35747 .vitem "&%-helo_name%&&~<&'text'&>"
35748 This records the host name as specified by a remote host in a HELO or EHLO
35749 command.
35750
35751 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
35752 This records the IP address of the host from which the message was received and
35753 the remote port number that was used. It is omitted for locally generated
35754 messages.
35755
35756 .vitem "&%-host_auth%&&~<&'text'&>"
35757 If the message was received on an authenticated SMTP connection, this records
35758 the name of the authenticator &-- the value of the
35759 &$sender_host_authenticated$& variable.
35760
35761 .vitem &%-host_lookup_failed%&
35762 This is present if an attempt to look up the sending host's name from its IP
35763 address failed. It corresponds to the &$host_lookup_failed$& variable.
35764
35765 .vitem "&%-host_name%&&~<&'text'&>"
35766 .cindex "reverse DNS lookup"
35767 .cindex "DNS" "reverse lookup"
35768 This records the name of the remote host from which the message was received,
35769 if the host name was looked up from the IP address when the message was being
35770 received. It is not present if no reverse lookup was done.
35771
35772 .vitem "&%-ident%&&~<&'text'&>"
35773 For locally submitted messages, this records the login of the originating user,
35774 unless it was a trusted user and the &%-oMt%& option was used to specify an
35775 ident value. For messages received over TCP/IP, this records the ident string
35776 supplied by the remote host, if any.
35777
35778 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
35779 This records the IP address of the local interface and the port number through
35780 which a message was received from a remote host. It is omitted for locally
35781 generated messages.
35782
35783 .vitem &%-local%&
35784 The message is from a local sender.
35785
35786 .vitem &%-localerror%&
35787 The message is a locally-generated bounce message.
35788
35789 .vitem "&%-local_scan%&&~<&'string'&>"
35790 This records the data string that was returned by the &[local_scan()]& function
35791 when the message was received &-- the value of the &$local_scan_data$&
35792 variable. It is omitted if no data was returned.
35793
35794 .vitem &%-manual_thaw%&
35795 The message was frozen but has been thawed manually, that is, by an explicit
35796 Exim command rather than via the auto-thaw process.
35797
35798 .vitem &%-N%&
35799 A testing delivery process was started using the &%-N%& option to suppress any
35800 actual deliveries, but delivery was deferred. At any further delivery attempts,
35801 &%-N%& is assumed.
35802
35803 .vitem &%-received_protocol%&
35804 This records the value of the &$received_protocol$& variable, which contains
35805 the name of the protocol by which the message was received.
35806
35807 .vitem &%-sender_set_untrusted%&
35808 The envelope sender of this message was set by an untrusted local caller (used
35809 to ensure that the caller is displayed in queue listings).
35810
35811 .vitem "&%-spam_score_int%&&~<&'number'&>"
35812 If a message was scanned by SpamAssassin, this is present. It records the value
35813 of &$spam_score_int$&.
35814
35815 .vitem &%-tls_certificate_verified%&
35816 A TLS certificate was received from the client that sent this message, and the
35817 certificate was verified by the server.
35818
35819 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
35820 When the message was received over an encrypted connection, this records the
35821 name of the cipher suite that was used.
35822
35823 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
35824 When the message was received over an encrypted connection, and a certificate
35825 was received from the client, this records the Distinguished Name from that
35826 certificate.
35827 .endlist
35828
35829 Following the options there is a list of those addresses to which the message
35830 is not to be delivered. This set of addresses is initialized from the command
35831 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
35832 is set; otherwise it starts out empty. Whenever a successful delivery is made,
35833 the address is added to this set. The addresses are kept internally as a
35834 balanced binary tree, and it is a representation of that tree which is written
35835 to the spool file. If an address is expanded via an alias or forward file, the
35836 original address is added to the tree when deliveries to all its child
35837 addresses are complete.
35838
35839 If the tree is empty, there is a single line in the spool file containing just
35840 the text &"XX"&. Otherwise, each line consists of two letters, which are either
35841 Y or N, followed by an address. The address is the value for the node of the
35842 tree, and the letters indicate whether the node has a left branch and/or a
35843 right branch attached to it, respectively. If branches exist, they immediately
35844 follow. Here is an example of a three-node tree:
35845 .code
35846 YY darcy@austen.fict.example
35847 NN alice@wonderland.fict.example
35848 NN editor@thesaurus.ref.example
35849 .endd
35850 After the non-recipients tree, there is a list of the message's recipients.
35851 This is a simple list, preceded by a count. It includes all the original
35852 recipients of the message, including those to whom the message has already been
35853 delivered. In the simplest case, the list contains one address per line. For
35854 example:
35855 .code
35856 4
35857 editor@thesaurus.ref.example
35858 darcy@austen.fict.example
35859 rdo@foundation
35860 alice@wonderland.fict.example
35861 .endd
35862 However, when a child address has been added to the top-level addresses as a
35863 result of the use of the &%one_time%& option on a &(redirect)& router, each
35864 line is of the following form:
35865 .display
35866 <&'top-level address'&> <&'errors_to address'&> &&&
35867   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
35868 .endd
35869 The 01 flag bit indicates the presence of the three other fields that follow
35870 the top-level address. Other bits may be used in future to support additional
35871 fields. The <&'parent number'&> is the offset in the recipients list of the
35872 original parent of the &"one time"& address. The first two fields are the
35873 envelope sender that is associated with this address and its length. If the
35874 length is zero, there is no special envelope sender (there are then two space
35875 characters in the line). A non-empty field can arise from a &(redirect)& router
35876 that has an &%errors_to%& setting.
35877
35878
35879 A blank line separates the envelope and status information from the headers
35880 which follow. A header may occupy several lines of the file, and to save effort
35881 when reading it in, each header is preceded by a number and an identifying
35882 character. The number is the number of characters in the header, including any
35883 embedded newlines and the terminating newline. The character is one of the
35884 following:
35885
35886 .table2 50pt
35887 .row <&'blank'&>         "header in which Exim has no special interest"
35888 .row &`B`&               "&'Bcc:'& header"
35889 .row &`C`&               "&'Cc:'& header"
35890 .row &`F`&               "&'From:'& header"
35891 .row &`I`&               "&'Message-id:'& header"
35892 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
35893 .row &`R`&               "&'Reply-To:'& header"
35894 .row &`S`&               "&'Sender:'& header"
35895 .row &`T`&               "&'To:'& header"
35896 .row &`*`&               "replaced or deleted header"
35897 .endtable
35898
35899 Deleted or replaced (rewritten) headers remain in the spool file for debugging
35900 purposes. They are not transmitted when the message is delivered. Here is a
35901 typical set of headers:
35902 .code
35903 111P Received: by hobbit.fict.example with local (Exim 4.00)
35904 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
35905 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
35906 038* X-rewrote-sender: bb@hobbit.fict.example
35907 042* From: Bilbo Baggins <bb@hobbit.fict.example>
35908 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
35909 099* To: alice@wonderland.fict.example, rdo@foundation,
35910 darcy@austen.fict.example, editor@thesaurus.ref.example
35911 104T To: alice@wonderland.fict.example, rdo@foundation.example,
35912 darcy@austen.fict.example, editor@thesaurus.ref.example
35913 038  Date: Fri, 11 May 2001 10:28:59 +0100
35914 .endd
35915 The asterisked headers indicate that the envelope sender, &'From:'& header, and
35916 &'To:'& header have been rewritten, the last one because routing expanded the
35917 unqualified domain &'foundation'&.
35918 .ecindex IIDforspo1
35919 .ecindex IIDforspo2
35920 .ecindex IIDforspo3
35921
35922 . ////////////////////////////////////////////////////////////////////////////
35923 . ////////////////////////////////////////////////////////////////////////////
35924
35925 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHID12" &&&
35926          "DKIM Support"
35927 .cindex "DKIM"
35928
35929 DKIM is a mechanism by which messages sent by some entity can be provably
35930 linked to a domain which that entity controls.  It permits reputation to
35931 be tracked on a per-domain basis, rather than merely upon source IP address.
35932 DKIM is documented in RFC 4871.
35933
35934 Since version 4.70, DKIM support is compiled into Exim by default. It can be
35935 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
35936
35937 Exim's DKIM implementation allows to
35938 .olist
35939 Sign outgoing messages: This function is implemented in the SMTP transport.
35940 It can co-exist with all other Exim features, including transport filters.
35941 .next
35942 Verify signatures in incoming messages: This is implemented by an additional
35943 ACL (acl_smtp_dkim), which can be called several times per message, with
35944 different signature contexts.
35945 .endlist
35946
35947 In typical Exim style, the verification implementation does not include any
35948 default "policy". Instead it enables you to build your own policy using
35949 Exim's standard controls.
35950
35951 Please note that verification of DKIM signatures in incoming mail is turned
35952 on by default for logging purposes. For each signature in incoming email,
35953 exim will log a line displaying the most important signature details, and the
35954 signature status. Here is an example (with line-breaks added for clarity):
35955 .code
35956 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
35957     d=facebookmail.com s=q1-2009b
35958     c=relaxed/relaxed a=rsa-sha1
35959     i=@facebookmail.com t=1252484542 [verification succeeded]
35960 .endd
35961 You might want to turn off DKIM verification processing entirely for internal
35962 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
35963 control modifier. This should typically be done in the RCPT ACL, at points
35964 where you accept mail from relay sources (internal hosts or authenticated
35965 senders).
35966
35967
35968 .section "Signing outgoing messages" "SECID513"
35969 .cindex "DKIM" "signing"
35970
35971 Signing is implemented by setting private options on the SMTP transport.
35972 These options take (expandable) strings as arguments.
35973
35974 .option dkim_domain smtp string&!! unset
35975 MANDATORY:
35976 The domain you want to sign with. The result of this expanded
35977 option is put into the &%$dkim_domain%& expansion variable.
35978
35979 .option dkim_selector smtp string&!! unset
35980 MANDATORY:
35981 This sets the key selector string. You can use the &%$dkim_domain%& expansion
35982 variable to look up a matching selector. The result is put in the expansion
35983 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
35984 option along with &%$dkim_domain%&.
35985
35986 .option dkim_private_key smtp string&!! unset
35987 MANDATORY:
35988 This sets the private key to use. You can use the &%$dkim_domain%& and
35989 &%$dkim_selector%& expansion variables to determine the private key to use.
35990 The result can either
35991 .ilist
35992 be a valid RSA private key in ASCII armor, including line breaks.
35993 .next
35994 start with a slash, in which case it is treated as a file that contains
35995 the private key.
35996 .next
35997 be "0", "false" or the empty string, in which case the message will not
35998 be signed. This case will not result in an error, even if &%dkim_strict%&
35999 is set.
36000 .endlist
36001
36002 .option dkim_canon smtp string&!! unset
36003 OPTIONAL:
36004 This option sets the canonicalization method used when signing a message.
36005 The DKIM RFC currently supports two methods: "simple" and "relaxed".
36006 The option defaults to "relaxed" when unset. Note: the current implementation
36007 only supports using the same canonicalization method for both headers and body.
36008
36009 .option dkim_strict smtp string&!! unset
36010 OPTIONAL:
36011 This  option  defines  how  Exim  behaves  when  signing a message that
36012 should be signed fails for some reason.  When the expansion evaluates to
36013 either "1" or "true", Exim will defer. Otherwise Exim will send the message
36014 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
36015 variables here.
36016
36017 .option dkim_sign_headers smtp string&!! unset
36018 OPTIONAL:
36019 When set, this option must expand to (or be specified as) a colon-separated
36020 list of header names. Headers with these names will be included in the message
36021 signature. When unspecified, the header names recommended in RFC4871 will be
36022 used.
36023
36024
36025 .section "Verifying DKIM signatures in incoming mail" "SECID514"
36026 .cindex "DKIM" "verification"
36027
36028 Verification of DKIM signatures in incoming email is implemented via the
36029 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
36030 syntactically(!) correct signature in the incoming message.
36031
36032 To evaluate the signature in the ACL a large number of expansion variables
36033 containing the signature status and its details are set up during the
36034 runtime of the ACL.
36035
36036 Calling the ACL only for existing signatures is not sufficient to build
36037 more advanced policies. For that reason, the global option
36038 &%dkim_verify_signers%&, and a global expansion variable
36039 &%$dkim_signers%& exist.
36040
36041 The global option &%dkim_verify_signers%& can be set to a colon-separated
36042 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
36043 called. It is expanded when the message has been received. At this point,
36044 the expansion variable &%$dkim_signers%& already contains a colon-separated
36045 list of signer domains and identities for the message. When
36046 &%dkim_verify_signers%& is not specified in the main configuration,
36047 it defaults as:
36048 .code
36049 dkim_verify_signers = $dkim_signers
36050 .endd
36051 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
36052 DKIM signature in the message. Current DKIM verifiers may want to explicitly
36053 call the ACL for known domains or identities. This would be achieved as follows:
36054 .code
36055 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
36056 .endd
36057 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
36058 and "ebay.com", plus all domains and identities that have signatures in the message.
36059 You can also be more creative in constructing your policy. For example:
36060 .code
36061 dkim_verify_signers = $sender_address_domain:$dkim_signers
36062 .endd
36063
36064 If a domain or identity is listed several times in the (expanded) value of
36065 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
36066
36067
36068 Inside the &%acl_smtp_dkim%&, the following expansion variables are
36069 available (from most to least important):
36070
36071
36072 .vlist
36073 .vitem &%$dkim_cur_signer%&
36074 The signer that is being evaluated in this ACL run. This can be a domain or
36075 an identity. This is one of the list items from the expanded main option
36076 &%dkim_verify_signers%& (see above).
36077 .vitem &%$dkim_verify_status%&
36078 A string describing the general status of the signature. One of
36079 .ilist
36080 &%none%&: There is no signature in the message for the current domain or
36081 identity (as reflected by &%$dkim_cur_signer%&).
36082 .next
36083 &%invalid%&: The signature could not be verified due to a processing error.
36084 More detail is available in &%$dkim_verify_reason%&.
36085 .next
36086 &%fail%&: Verification of the signature failed.  More detail is
36087 available in &%$dkim_verify_reason%&.
36088 .next
36089 &%pass%&: The signature passed verification. It is valid.
36090 .endlist
36091 .vitem &%$dkim_verify_reason%&
36092 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
36093 "fail" or "invalid". One of
36094 .ilist
36095 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
36096 key for the domain could not be retrieved. This may be a temporary problem.
36097 .next
36098 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
36099 record for the domain is syntactically invalid.
36100 .next
36101 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
36102 body hash does not match the one specified in the signature header. This
36103 means that the message body was modified in transit.
36104 .next
36105 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
36106 could not be verified. This may mean that headers were modified,
36107 re-written or otherwise changed in a way which is incompatible with
36108 DKIM verification. It may of course also mean that the signature is forged.
36109 .endlist
36110 .vitem &%$dkim_domain%&
36111 The signing domain. IMPORTANT: This variable is only populated if there is
36112 an actual signature in the message for the current domain or identity (as
36113 reflected by &%$dkim_cur_signer%&).
36114 .vitem &%$dkim_identity%&
36115 The signing identity, if present. IMPORTANT: This variable is only populated
36116 if there is an actual signature in the message for the current domain or
36117 identity (as reflected by &%$dkim_cur_signer%&).
36118 .vitem &%$dkim_selector%&
36119 The key record selector string.
36120 .vitem &%$dkim_algo%&
36121 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
36122 .vitem &%$dkim_canon_body%&
36123 The body canonicalization method. One of 'relaxed' or 'simple'.
36124 .vitem &%dkim_canon_headers%&
36125 The header canonicalization method. One of 'relaxed' or 'simple'.
36126 .vitem &%$dkim_copiedheaders%&
36127 A transcript of headers and their values which are included in the signature
36128 (copied from the 'z=' tag of the signature).
36129 .vitem &%$dkim_bodylength%&
36130 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
36131 limit was set by the signer, "9999999999999" is returned. This makes sure
36132 that this variable always expands to an integer value.
36133 .vitem &%$dkim_created%&
36134 UNIX timestamp reflecting the date and time when the signature was created.
36135 When this was not specified by the signer, "0" is returned.
36136 .vitem &%$dkim_expires%&
36137 UNIX timestamp reflecting the date and time when the signer wants the
36138 signature to be treated as "expired". When this was not specified by the
36139 signer, "9999999999999" is returned. This makes it possible to do useful
36140 integer size comparisons against this value.
36141 .vitem &%$dkim_headernames%&
36142 A colon-separated list of names of headers included in the signature.
36143 .vitem &%$dkim_key_testing%&
36144 "1" if the key record has the "testing" flag set, "0" if not.
36145 .vitem &%$nosubdomains%&
36146 "1" if the key record forbids subdomaining, "0" otherwise.
36147 .vitem &%$dkim_key_srvtype%&
36148 Service type (tag s=) from the key record. Defaults to "*" if not specified
36149 in the key record.
36150 .vitem &%$dkim_key_granularity%&
36151 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
36152 in the key record.
36153 .vitem &%$dkim_key_notes%&
36154 Notes from the key record (tag n=).
36155 .endlist
36156
36157 In addition, two ACL conditions are provided:
36158
36159 .vlist
36160 .vitem &%dkim_signers%&
36161 ACL condition that checks a colon-separated list of domains or identities
36162 for a match against the domain or identity that the ACL is currently verifying
36163 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
36164 verb to a group of domains or identities. For example:
36165
36166 .code
36167 # Warn when Mail purportedly from GMail has no signature at all
36168 warn log_message = GMail sender without DKIM signature
36169      sender_domains = gmail.com
36170      dkim_signers = gmail.com
36171      dkim_status = none
36172 .endd
36173
36174 .vitem &%dkim_status%&
36175 ACL condition that checks a colon-separated list of possible DKIM verification
36176 results agains the actual result of verification. This is typically used
36177 to restrict an ACL verb to a list of verification outcomes, for example:
36178
36179 .code
36180 deny message = Mail from Paypal with invalid/missing signature
36181      sender_domains = paypal.com:paypal.de
36182      dkim_signers = paypal.com:paypal.de
36183      dkim_status = none:invalid:fail
36184 .endd
36185
36186 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
36187 see the documentation of the &%$dkim_verify_status%& expansion variable above
36188 for more information of what they mean.
36189 .endlist
36190
36191 . ////////////////////////////////////////////////////////////////////////////
36192 . ////////////////////////////////////////////////////////////////////////////
36193
36194 .chapter "Adding new drivers or lookup types" "CHID13" &&&
36195          "Adding drivers or lookups"
36196 .cindex "adding drivers"
36197 .cindex "new drivers, adding"
36198 .cindex "drivers" "adding new"
36199 The following actions have to be taken in order to add a new router, transport,
36200 authenticator, or lookup type to Exim:
36201
36202 .olist
36203 Choose a name for the driver or lookup type that does not conflict with any
36204 existing name; I will use &"newdriver"& in what follows.
36205 .next
36206 Add to &_src/EDITME_& the line:
36207 .display
36208 <&'type'&>&`_NEWDRIVER=yes`&
36209 .endd
36210 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
36211 code is not to be included in the binary by default, comment this line out. You
36212 should also add any relevant comments about the driver or lookup type.
36213 .next
36214 Add to &_src/config.h.defaults_& the line:
36215 .code
36216 #define <type>_NEWDRIVER
36217 .endd
36218 .next
36219 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
36220 and create a table entry as is done for all the other drivers and lookup types.
36221 .next
36222 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
36223 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
36224 driver or lookup type and add it to the definition of OBJ.
36225 .next
36226 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
36227 &_src_&.
36228 .next
36229 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
36230 as for other drivers and lookups.
36231 .endlist
36232
36233 Then all you need to do is write the code! A good way to start is to make a
36234 proforma by copying an existing module of the same type, globally changing all
36235 occurrences of the name, and cutting out most of the code. Note that any
36236 options you create must be listed in alphabetical order, because the tables are
36237 searched using a binary chop procedure.
36238
36239 There is a &_README_& file in each of the sub-directories of &_src_& describing
36240 the interface that is expected.
36241
36242
36243
36244
36245 . ////////////////////////////////////////////////////////////////////////////
36246 . ////////////////////////////////////////////////////////////////////////////
36247
36248 . /////////////////////////////////////////////////////////////////////////////
36249 . These lines are processing instructions for the Simple DocBook Processor that
36250 . Philip Hazel has developed as a less cumbersome way of making PostScript and
36251 . PDFs than using xmlto and fop. They will be ignored by all other XML
36252 . processors.
36253 . /////////////////////////////////////////////////////////////////////////////
36254
36255 .literal xml
36256 <?sdop
36257   format="newpage"
36258   foot_right_recto="&chaptertitle;"
36259   foot_right_verso="&chaptertitle;"
36260 ?>
36261 .literal off
36262
36263 .makeindex "Options index"   "option"
36264 .makeindex "Variables index" "variable"
36265 .makeindex "Concept index"   "concept"
36266
36267
36268 . /////////////////////////////////////////////////////////////////////////////
36269 . /////////////////////////////////////////////////////////////////////////////